logger

JSON based logger for golang

A simple and efficient JSON-based logging library for Go applications, designed for easy integration and observability. It provides structured logging with various levels, automatic trace context propagation, and customizable output to streamline log management and analysis.

[!IMPORTANT] This repository was migrated from github.

Please refer to github.com/iolave/go-logger for versions <= v1.0.1

Install

go get codeberg.org/mice1337/go-logger

Features

• JSON formatted logs for easy parsing and querying.
• Log levels to control log verbosity.
• Automatic inclusion of trace information from context via go-trace.
• Handles circular references in log data.
• Customizable log output with additional data.

Usage

Create a logger

// ...
import "codeberg.org/mice1337/go-logger"

// Creates a logger with a name and version
logger, err := logger.New(logger.LEVEL_INFO, "my-awesome-logger", "1.0.0")
if err != nil {
    // Handle error
}

Write logs

ctx := context.Background() // Or your request context

logger.Debug(ctx, "debug message")
// {"timestamp":1722216216,"level":"debug","name":"my-awesome-logger","version":"1.0.0","trace":{},"info":{},"msg":"debug message"}

logger.Info(ctx, "info message")
// {"timestamp":1722216216,"level":"info","name":"my-awesome-logger","version":"1.0.0","trace":{},"info":{},"msg":"info message"}

logger.Warn(ctx, "warn message", errors.New("something happened"))
// {"timestamp":1722216216,"level":"warn","name":"my-awesome-logger","version":"1.0.0","trace":{},"error":{},"info":{},"msg":"warn message"}

logger.Error(ctx, "error message", errors.New("something bad happened"))
// {"timestamp":1722216216,"level":"error","name":"my-awesome-logger","version":"1.0.0","trace":{},"error":{},"info":{},"msg":"error message"}

logger.Fatal(ctx, "fatal message", errors.New("something terrible happened"))
// Exits the application after logging
// {"timestamp":1722216216,"level":"fatal","name":"my-awesome-logger","version":"1.0.0","trace":{},"error":{},"info":{},"msg":"fatal message"}

With trace information

The logger will automatically include trace information from the context if it's provided via go-trace.

import (
	"context"
	"errors"

	"codeberg.org/mice1337/go-logger"
	"codeberg.org/mice1337/go-trace"
)

// ...

// Create a new trace
t := trace.Trace{}
t.Set("trace_id", "my-trace-id")
t.Set("span_id", "my-span-id")

// Add the trace to the context
ctx := t.SetInContext(context.Background())

// Log a message with the context
logger.Info(ctx, "This log includes trace information")
// {"timestamp":1722216216,"level":"info","name":"my-awesome-logger","version":"1.0.0","trace":{"trace_id":"my-trace-id","span_id":"my-span-id"},"info":{},"msg":"This log includes trace information"}

Schema version: v1.0.0

Log entry schema

Log level definition

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue.

Development

To get started with development, you'll need Go installed.

1. Fork the repository.
2. Clone your fork: git clone https://codeberg.org/YOUR_USERNAME/go-logger.git
3. Create a new branch: git checkout -b my-feature-branch
4. Make your changes.
5. Run tests: make test
6. Push to your branch: git push origin my-feature-branch
7. Open a pull request.