Sellsuki Logger

A Go wrapper for the sellsuki logging standard

Installation

# Go library
go get github.com/Sellsuki/sellsuki-go-logger

Or install specific version

# Go client latest or explicit version
# Note: please check tag for the available version
go get github.com/Sellsuki/sellsuki-go-logger/@v1.1.0

Configuration

This table show the default value of configuration when using NewProductionConfig()

Config	Description	Default
LogLevel	Log minimum level that will output	LevelInfo
AppName	Application name	"application"
Version	Version of the application	""
MaxBodySize	Max size of request body to output in bytes (0 = Unlimited)	1048576

LogOption

Log option can be specified in logging function either slog.L().Info, Event, Request

Config	Description	Default
Alert	Interger value indicate this log should be trigger the alert ( 0 = None, 1 = Alert)	0

Example

slog.L().Info(
    "Hello World",
    slog.Any("Yeet", 1),
    slog.WithOption(LogOption{Alert: 1}) // Log Option
)

Basic Usage

import "github.com/Sellsuki/sellsuki-go-logger"

// Initialize Logger
config := slog.NewProductionConfig()
config.LogLevel = slog.LevelInfo
config.AppName = "sellsuki-logger"
config.Version = "1.0.0"
config.MaxBodySize = 1048576

slog.L().Configure(config)

// Simple Info Log
slog.L().Info(
    "Hello World",       // Log Message
    slog.Any("Yeet", 1), // Some object or variable to include in log
    slog.WithTracing("a", "b", "c"), // Tracing information (Optional) [trace_id, span_id, request_id (Optional)]
	slog.WithOption(Log)
)

Request Log

import "github.com/Sellsuki/sellsuki-go-logger"

// Initialize Logger
config := slog.NewProductionConfig()
config.LogLevel = slog.LevelInfo
config.AppName = "sellsuki-logger"
config.Version = "1.0.0"
config.MaxBodySize = 1048576

slog.L().Configure(config)

// HTTP Request Log
slog.L().RequestHTTP(
    "such wow",
        slog.WithHTTPRequest(
        "POST",                     // Method
        "/dodge/wow",               // Path
        "127.0.0.1",                // Request IP Address 
        map[string]string{          // Request header
            "Content-Type": "application/json",
        },
        map[string]string{          // Params in URI
            "user_id": "777",
        },
        map[string]string{          // Query Params
            "keyword": "yikes",
        },
        "{\"such\": \"wow\"}",      // Raw Body string
    ),
    slog.WithHTTPResponse(
        200,                        // Status Code
        0.0167777,                  // Request Process Duration
        "{\"such\": \"wow\"}",      // Raw Response Body string
        slog.WithError(             // Error
			"item_not_found",       // Error name
            "/dodge/wow.go:35",     // Caller
			"some stack trace here" // Stacktrace
        ), 
    ),
    slog.WithTracing(
        "trace_id",                 // Tracing ID
        "span_id",                  // Span ID
		"request_id",               // Request ID (Optional)
    ),
)

// Kafka Request Log
slog.L().RequestKafka(
    "write something about kafka",
    slog.WithKafkaMessage(
        "topic.name.here",          // Kafka Topic Name
        0,                          // Partition
        500,                        // Offset
        map[string]string{          // Headers
            "header_key": "header_value",   
        },
        "kafka_key",                // Keys
        "kafka payload here",       // Message Payload
        time.Now(),                 // Timestamp
    ),
    slog.WithKafkaResult(
        0.016777,                   // Process Duration
        slog.WithError(
            "item_not_found",       // Error name
            "/dodge/wow.go:35",     // Caller
            "some stack trace here" // Stacktrace
        ),
    ),
    slog.WithTracing(
		"trace_id",                 // Tracing ID
		"span_id"                   // Span ID
        "request_id",               // Request ID (Optional)
    ),
)

Event Log

import "github.com/Sellsuki/sellsuki-go-logger"

// Initialize Logger
config := slog.NewProductionConfig()
config.LogLevel = slog.LevelInfo
config.AppName = "sellsuki-logger"
config.Version = "1.0.0"
config.MaxBodySize = 1048576

slog.L().Configure(config)

// Event Log
slog.L().Event(
    "event message",        // Log Message
    slog.WithEvent(         
        "order",            // Entity
        slog.ActionCreate,  // Event action (Create, Update, Delete)
        slog.ResultSuccess, // Event result (Success, Compensate)
        "",                 // Raw data
        "ref_id",           // Normalized reference id
    ),
    slog.WithTracing(
		"tracing_id", 
		"span_id"
        "request_id",
    ),
)

Application Log

import "github.com/Sellsuki/sellsuki-go-logger"

// Initialize Logger
config := slog.NewProductionConfig()
config.LogLevel = slog.LevelInfo
config.AppName = "sellsuki-logger"
config.Version = "1.0.0"
config.MaxBodySize = 1048576

slog.L().Configure(config)


// Debug Log
slog.L().Debug(
    "Hello World",       // Log Message
    slog.Any("Yeet", 1), // Some object or variable to include in log
    slog.WithTracing("a", "b"), // Tracing information (Optional)
)

// Info Log
slog.L().Info(
    "Hello World",       // Log Message
    slog.Any("Yeet", 1), // Some object or variable to include in log
    slog.WithTracing("a", "b", "c"), // Tracing information (Optional)
)

// Warning Log
slog.L().Warn(
    "Hello World",       // Log Message
    slog.Any("Yeet", 1), // Some object or variable to include in log
    slog.WithTracing("a", "b", "c"), // Tracing information (Optional)
)

// Error Log
slog.L().Error(
    "Hello World",       // Log Message
    slog.Any("Yeet", 1), // Some object or variable to include in log
    slog.WithTracing("a", "b", "c"), // Tracing information (Optional)
)

// Fatal Log, This log type will exit the process after the log has written
slog.L().Fatal(
    "Hello World",       // Log Message
    slog.Any("Yeet", 1), // Some object or variable to include in log
    slog.WithTracing("a", "b", "c"), // Tracing information (Optional)
)

// Fatal Log, This log type will call panic after the log has written
slog.L().Panic(
    "Hello World",       // Log Message
    slog.Any("Yeet", 1), // Some object or variable to include in log
    slog.WithTracing("a", "b", "c"), // Tracing information (Optional)
)