Status: Deprecated

This package was initially created as a personal learning project to explore Go's logging capabilities. It has served its purpose in providing hands-on experience with logging in Go. However, it is now deprecated and should not be used in production environments.

For production-grade logging solutions, it is highly recommended to use the official Go slog package along with the third-party package github.com/lmittmann/tint. Package tint implements a zero-dependency slog.Handler that writes tinted (colorized) logs. Its output format is inspired by the zerolog.ConsoleWriter and slog.TextHandler.

AsyncLog is a versatile and efficient asynchronous logging library for Go, designed for multi-level logging with support for custom formatting, colored output, and file logging capabilities.

• Asynchronous Logging: Processes log messages in a separate goroutine for minimal impact on main application flow.
• Multiple Log Levels: Supports levels like Trace, Debug, Info, Warning, Error, and Fatal for detailed logging.
• Customizable Output: Route log messages to different files or the console.
• Colored console output: Enhances readability with color-coded logs in the console.
• Source Code Information: Option to include source file and line number in logs.
• Flexible Configuration: Tailor logger behavior with functional options.
• Parameter Formatting: Choose between JSON or Key-Value formatting for log parameters.
• File Logging: Direct logs to files with configurable file names and output settings.

Install AsyncLog using go get:

go get github.com/simp-lee/asynclog

Here's a basic example to get started with asynclog:

package main

import (
    "github.com/simp-lee/asynclog"
    "time"
)

func main() {
    // Create a new logger
    logger, err := asynclog.NewLogger()
    if err != nil {
        panic(err)
    }
    defer logger.Close() // Ensure logger is closed at the end
	
    // Logging at different levels
    logger.Trace("This is a trace message")
    logger.Debug("Debugging information here")
    logger.Info("Informational message")
    logger.Warning("This is a warning")
    logger.Error("Encountered an error")
    // Use Fatal sparingly - high severity
    logger.Fatal("Fatal error occurred")
	
    // Wait for a moment to ensure all messages are processed
    time.Sleep(1 * time.Second)
}

Customize the logger at instantiation with various options:

logger, err := asynclog.NewLogger(
    asynclog.SetBufferSize(200),                             // Custom buffer size
    asynclog.SetFileLevel(asynclog.LogLevelInfo),            // Set file logging level
    asynclog.SetConsoleLevel(asynclog.LogLevelDebug),        // Set console logging level
    asynclog.EnableSourceInfo(true),                         // Enable source file information recording
    asynclog.SetDefaultFileName("app.log"),                  // Set default log file name
    asynclog.EnableFileOutput(false),                        // Disable file output
    asynclog.EnableConsoleOutput(true),                      // Enable console output
    asynclog.SetParamFormatter(asynclog.FormatParamsAsJSON), // Log parameter formatting
    asynclog.SetMaxFileHandles(20),                          // Set maximum number of file handles
)

Include additional parameters in your log messages and customize their formatting style:

params := map[string]interface{}{
    "user_id": 123,
    "action": "login",
}
logger.Info("User action", asynclog.SetLogParams(params)) // Log with additional parameters

Your contributions to AsyncLog are welcome! Feel free to open issues or submit pull requests for improvements or new features.