https://github.com/mgjules/logem

A simple slog handler wrapper which adds level handling and tracing ability.
https://github.com/mgjules/logem

go golang logging-library slog

Last synced: 11 days ago
JSON representation

A simple slog handler wrapper which adds level handling and tracing ability.

• Host: GitHub
• URL: https://github.com/mgjules/logem
• Owner: mgjules
• License: apache-2.0
• Created: 2023-02-24T14:46:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-02-27T10:44:58.000Z (over 1 year ago)
• Last Synced: 2024-06-20T15:49:37.823Z (5 months ago)
• Topics: go, golang, logging-library, slog
• Language: Go
• Homepage:
• Size: 18.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Logem

[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge)](https://godoc.org/github.com/mgjules/logem)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](LICENSE)

Logem, short for "Let's Log em!", is an opinionated handler wrapper for [slog](https://pkg.go.dev/golang.org/x/exp/slog).

It combines a LevelHandler and a TraceHandler in a single, simple to use handler.

## Disclaimer

This package is not suited for production use right now. It is heavily being worked on.

However feel free to inspire yourself from it or fork it.

## Installation

```shell

go get -u github.com/mgjules/logem

```

## Usage

```go

package main

import (

  "context"

  "os"

  "github.com/mgjules/logem"

  "golang.org/x/exp/slog"

)

func main() {

  // Init OTEL trace provider.

  // initTraceProvider()

  // Create logger using logem.Handler.

  logger := slog.New(

    logem.NewHandler(

      slog.NewTextHandler(os.Stdout),

      logem.WithMinLevel(slog.LevelInfo),

      logem.WithStackTrace(true),

      logem.WithTraceID(true),

      logem.WithSpanID(true),

    ),

  )

  slog.SetDefault(logger)

  // Use logger to log messages, etc.

  // Please ensure that the context being passed has proper trace information.

  ctx := context.TODO()

  logger.WithContext(ctx).Info("hello", "count", 3)

}

```

## Stability

This project follows [SemVer](http://semver.org/) strictly and is not yet `v1`.

Breaking changes might be introduced until `v1` is released.

This project follows the [Go Release Policy](https://golang.org/doc/devel/release.html#policy). Each major version of Go is supported until there are two newer major releases.