A Graylog Handler for slog Go library.
See also:
slog.Handler
chaining, fanout, routing, failover, load balancing...slog
attribute formattingslog
sampling policyHTTP middlewares:
slog
loggerslog
loggerslog
loggerslog
loggernet/http
middleware for slog
loggerLoggers:
slog
handler for Zap
slog
handler for Zerolog
slog
handler for Logrus
Log sinks:
slog
handler for Datadog
slog
handler for Betterstack
slog
handler for Rollbar
slog
handler for Loki
slog
handler for Sentry
slog
handler for Syslog
slog
handler for Logstash
slog
handler for Fluentd
slog
handler for Graylog
slog
handler for Quickwit
slog
handler for Slack
slog
handler for Telegram
slog
handler for Mattermost
slog
handler for Microsoft Teams
slog
handler for Webhook
slog
handler for Kafka
slog
handler for NATS
slog
handler for Parquet
+ Object Storage
slog
handler for Go channelsgo get github.com/samber/slog-graylog/v2
Compatibility: go >= 1.21
No breaking changes will be made to exported APIs before v3.0.0.
GoDoc: https://pkg.go.dev/github.com/samber/slog-graylog/v2
type Option struct {
// log level (default: debug)
Level slog.Leveler
// connection to graylog
Writer *gelf.Writer
// optional: customize json payload builder
Converter Converter
// optional: fetch attributes from context
AttrFromContext []func(ctx context.Context) []slog.Attr
// optional: see slog.HandlerOptions
AddSource bool
ReplaceAttr func(groups []string, a slog.Attr) slog.Attr
}
Attributes will be injected in log "extra".
Other global parameters:
sloggraylog.SourceKey = "source"
sloggraylog.ErrorKeys = []string{"error", "err"}
sloggraylog.LogLevels = map[slog.Level]int32{...}
import (
"github.com/Graylog2/go-gelf/gelf"
sloggraylog "github.com/samber/slog-graylog/v2"
"log/slog"
)
func main() {
// docker-compose up -d
// or
// ncat -l 12201 -u
gelfWriter, err := gelf.NewWriter("localhost:12201")
if err != nil {
log.Fatalf("gelf.NewWriter: %s", err)
}
gelfWriter.CompressionType = gelf.CompressNone // for debugging only
logger := slog.New(sloggraylog.Option{Level: slog.LevelDebug, Writer: gelfWriter}.NewGraylogHandler())
logger = logger.
With("environment", "dev").
With("release", "v1.0.0")
// log error
logger.
With("category", "sql").
With("query.statement", "SELECT COUNT(*) FROM users;").
With("query.duration", 1*time.Second).
With("error", fmt.Errorf("could not count users")).
Error("caramba!")
// log user signup
logger.
With(
slog.Group("user",
slog.String("id", "user-123"),
slog.Time("created_at", time.Now()),
),
).
Info("user registration")
}
Output:
{
"timestamp":"2023-04-10T14:00:0.000000+00:00",
"level":3,
"message":"caramba!",
"extra":{
"error":{
"error":"could not count users",
"kind":"*errors.errorString",
"stack":null
},
"environment":"dev",
"release":"v1.0.0",
"category":"sql",
"query.statement":"SELECT COUNT(*) FROM users;",
"query.duration": "1s"
}
}
{
"timestamp":"2023-04-10T14:00:0.000000+00:00",
"level":6,
"message":"user registration",
"extra":{
"environment":"dev",
"release":"v1.0.0",
"user":{
"id":"user-123",
"created_at":"2023-04-10T14:00:0.000000+00:00"
}
}
}
Import the samber/slog-otel library.
import (
sloggraylog "github.com/samber/slog-graylog"
slogotel "github.com/samber/slog-otel"
"go.opentelemetry.io/otel/sdk/trace"
)
func main() {
tp := trace.NewTracerProvider(
trace.WithSampler(trace.AlwaysSample()),
)
tracer := tp.Tracer("hello/world")
ctx, span := tracer.Start(context.Background(), "foo")
defer span.End()
span.AddEvent("bar")
logger := slog.New(
sloggraylog.Option{
// ...
AttrFromContext: []func(ctx context.Context) []slog.Attr{
slogotel.ExtractOtelAttrFromContext([]string{"tracing"}, "trace_id", "span_id"),
},
}.NewGraylogHandler(),
)
logger.ErrorContext(ctx, "a message")
}
Don't hesitate ;)
# Install some dev dependencies
make tools
# Run tests
make test
# or
make watch-test
Give a ⭐️ if this project helped you!
Copyright © 2023 Samuel Berthe.
This project is MIT licensed.