log/README.md

Log

A high-performance, buffered, rotating file logger for Go applications with built-in disk management, operational monitoring, and framework compatibility adapters.

Key Features

• Lock-free async logging with minimal application impact
• Automatic file rotation and disk space management
• Operational heartbeats for production monitoring
• Hot reconfiguration without data loss
• Framework adapters for gnet v2 and fasthttp
• Production-grade reliability with graceful shutdown

Quick Start

package main

import (
	"fmt"
	
    "github.com/lixenwraith/log"
)

func main() {
    // Create and initialize logger
    logger := log.NewLogger()
    err := logger.ApplyConfigString("directory=/var/log/myapp")
    if err != nil {
        panic(fmt.Errorf("failed to apply logger config: %w", err))
    }
    defer logger.Shutdown()

    // Start logging
	if err = logger.Start(); err != nil {
        panic(fmt.Errorf("failed to start logger: %w", err))
    }
    logger.Info("Application started", "version", "1.0.0")
    logger.Debug("Debug information", "user_id", 12345)
    logger.Warn("Warning message", "threshold", 0.95)
    logger.Error("Error occurred", "code", 500)
}

Installation

go get github.com/lixenwraith/log

Documentation

• Getting Started - Installation and basic usage
• Configuration Guide - Configuration options
• Configuration Builder - Builder pattern guide
• API Reference - Complete API documentation
• Logging Guide - Logging methods and best practices
• Disk Management - File rotation and cleanup
• Heartbeat Monitoring - Operational statistics
• Compatibility Adapters - Framework integrations
• Quick Guide - Quick reference guide

Architecture Overview

The logger uses a lock-free, channel-based architecture for high performance:

Application → Log Methods → Buffered Channel → Background Processor → File/Console
                ↓                                      ↓
            (non-blocking)                    (rotation, cleanup, monitoring)

Contributing

Contributions and suggestions are welcome! There is no contribution policy, but if interested, please submit pull requests to the repository. Submit suggestions or issues at issue tracker.

License

BSD-3-Clause