Skip to content

Latest commit

History

History
162 lines (119 loc) 路 5.94 KB

README.md

File metadata and controls

162 lines (119 loc) 路 5.94 KB

slog: Betterstack handler

tag Go Version GoDoc Build Status Go report Coverage Contributors License

A Betterstack Handler for slog Go library.

See also:

HTTP middlewares:

Loggers:

Log sinks:

馃殌 Install

go get github.com/samber/slog-betterstack

Compatibility: go >= 1.21

No breaking changes will be made to exported APIs before v2.0.0.

馃挕 Usage

GoDoc: https://pkg.go.dev/github.com/samber/slog-betterstack

Handler options

type Option struct {
  // log level (default: debug)
  Level     slog.Leveler

  // token
  Token   string
  Timeout time.Duration // default: 10s

  // optional: customize record builder
  Converter Converter
  // optional: custom marshaler
  Marshaler func(v any) ([]byte, error)

  // optional: see slog.HandlerOptions
  AddSource   bool
  ReplaceAttr func(groups []string, a slog.Attr) slog.Attr
}

Other global parameters:

slogbetterstack.SourceKey = "runtime"
slogbetterstack.ContextKey = "context"
slogbetterstack.ErrorKeys = []string{"error", "err"}

Example

import (
	"fmt"
	"net/http"
	"time"

	slogbetterstack "github.com/samber/slog-betterstack"

	"log/slog"
)

func main() {
	logger := slog.New(slogbetterstack.Option{Level: slog.LevelDebug, Token: "xxxxx"}.NewBetterstackHandler())
	logger = logger.With("release", "v1.0.0")

	logger.
		With(
			slog.Group("user",
				slog.String("id", "user-123"),
				slog.Time("created_at", time.Now()),
			),
		).
		With("error", fmt.Errorf("an error")).
		Error("a message", slog.Int("count", 1))
}

馃 Contributing

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

馃懁 Contributors

Contributors

馃挮 Show your support

Give a 猸愶笍 if this project helped you!

GitHub Sponsors

馃摑 License

Copyright 漏 2023 Samuel Berthe.

This project is MIT licensed.