slog-loki
slog-loki copied to clipboard
🚨 slog: Loki handler
slog: Loki handler
A Loki Handler for slog Go library.
See also:
-
slog-multi:
slog.Handler
chaining, fanout, routing, failover, load balancing... -
slog-formatter:
slog
attribute formatting -
slog-sampling:
slog
sampling policy
HTTP middlewares:
-
slog-gin: Gin middleware for
slog
logger -
slog-echo: Echo middleware for
slog
logger -
slog-fiber: Fiber middleware for
slog
logger -
slog-chi: Chi middleware for
slog
logger -
slog-http:
net/http
middleware forslog
logger
Loggers:
-
slog-zap: A
slog
handler forZap
-
slog-zerolog: A
slog
handler forZerolog
-
slog-logrus: A
slog
handler forLogrus
Log sinks:
-
slog-datadog: A
slog
handler forDatadog
-
slog-betterstack: A
slog
handler forBetterstack
-
slog-rollbar: A
slog
handler forRollbar
-
slog-loki: A
slog
handler forLoki
-
slog-sentry: A
slog
handler forSentry
-
slog-syslog: A
slog
handler forSyslog
-
slog-logstash: A
slog
handler forLogstash
-
slog-fluentd: A
slog
handler forFluentd
-
slog-graylog: A
slog
handler forGraylog
-
slog-slack: A
slog
handler forSlack
-
slog-telegram: A
slog
handler forTelegram
-
slog-mattermost: A
slog
handler forMattermost
-
slog-microsoft-teams: A
slog
handler forMicrosoft Teams
-
slog-webhook: A
slog
handler forWebhook
-
slog-kafka: A
slog
handler forKafka
-
slog-nats: A
slog
handler forNATS
-
slog-parquet: A
slog
handler forParquet
+Object Storage
-
slog-channel: A
slog
handler for Go channels
🚀 Install
go get github.com/samber/slog-loki/v3
Compatibility: go >= 1.21
No breaking changes will be made to exported APIs before v4.0.0.
💡 Usage
GoDoc: https://pkg.go.dev/github.com/samber/slog-loki/v3
Handler options
type Option struct {
// log level (default: debug)
Level slog.Leveler
// loki
Client *loki.Client
// optional: customize webhook event 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 payload.
Other global parameters:
slogloki.SourceKey = "source"
slogloki.ErrorKeys = []string{"error", "err"}
slogloki.SubAttributeSeparator = "__"
slogloki.AttributeKeyInvalidCharReplacement = "_"
Example
import (
slogloki "github.com/samber/slog-loki/v3"
"log/slog"
)
func main() {
// setup loki client
config, _ := loki.NewDefaultConfig("http://localhost:3100/loki/api/v1/push")
config.TenantID = "xyz"
client, _ := loki.New(config)
logger := slog.New(slogloki.Option{Level: slog.LevelDebug, Client: client}.NewLokiHandler())
logger = logger.
With("environment", "dev").
With("release", "v1.0.0")
// log error
logger.Error("caramba!")
// log user signup
logger.Info("user registration")
// stop loki client and purge buffers
client.Stop()
}
Tracing
Import the samber/slog-otel library.
import (
slogloki "github.com/samber/slog-loki"
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(
slogloki.Option{
// ...
AttrFromContext: []func(ctx context.Context) []slog.Attr{
slogotel.ExtractOtelAttrFromContext([]string{"tracing"}, "trace_id", "span_id"),
},
}.NewLokiHandler(),
)
logger.ErrorContext(ctx, "a message")
}
🤝 Contributing
- Ping me on twitter @samuelberthe (DMs, mentions, whatever :))
- Fork the project
- Fix open issues or request new features
Don't hesitate ;)
# Install some dev dependencies
make tools
# Run tests
make test
# or
make watch-test
👤 Contributors
💫 Show your support
Give a ⭐️ if this project helped you!
📝 License
Copyright © 2023 Samuel Berthe.
This project is MIT licensed.