- Notifications
You must be signed in to change notification settings - Fork2
samber/slog-webhook
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Awebhook Handler forslog Go library.
Sponsored by:
Cloud-native search engine for observability - An OSS alternative to Splunk, Elasticsearch, Loki, and Tempo.
See also:
- slog-multi:
slog.Handlerchaining, fanout, routing, failover, load balancing... - slog-formatter:
slogattribute formatting - slog-sampling:
slogsampling policy - slog-mock:
slog.Handlerfor test purposes
HTTP middlewares:
- slog-gin: Gin middleware for
sloglogger - slog-echo: Echo middleware for
sloglogger - slog-fiber: Fiber middleware for
sloglogger - slog-chi: Chi middleware for
sloglogger - slog-http:
net/httpmiddleware forsloglogger
Loggers:
- slog-zap: A
sloghandler forZap - slog-zerolog: A
sloghandler forZerolog - slog-logrus: A
sloghandler forLogrus
Log sinks:
- slog-datadog: A
sloghandler forDatadog - slog-betterstack: A
sloghandler forBetterstack - slog-rollbar: A
sloghandler forRollbar - slog-loki: A
sloghandler forLoki - slog-sentry: A
sloghandler forSentry - slog-syslog: A
sloghandler forSyslog - slog-logstash: A
sloghandler forLogstash - slog-fluentd: A
sloghandler forFluentd - slog-graylog: A
sloghandler forGraylog - slog-quickwit: A
sloghandler forQuickwit - slog-slack: A
sloghandler forSlack - slog-telegram: A
sloghandler forTelegram - slog-mattermost: A
sloghandler forMattermost - slog-microsoft-teams: A
sloghandler forMicrosoft Teams - slog-webhook: A
sloghandler forWebhook - slog-kafka: A
sloghandler forKafka - slog-nats: A
sloghandler forNATS - slog-parquet: A
sloghandler forParquet+Object Storage - slog-channel: A
sloghandler for Go channels
go get github.com/samber/slog-webhook/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-webhook/v2
typeOptionstruct {// log level (default: debug)Level slog.Leveler// URLEndpointstringTimeout time.Duration// default: 10s// optional: customize webhook event builderConverterConverter// optional: custom marshalerMarshalerfunc(vany) ([]byte,error)// optional: fetch attributes from contextAttrFromContext []func(ctx context.Context) []slog.Attr// optional: see slog.HandlerOptionsAddSourceboolReplaceAttrfunc(groups []string,a slog.Attr) slog.Attr}
Other global parameters:
slogwebhook.SourceKey="source"slogwebhook.ContextKey="extra"slogwebhook.ErrorKeys= []string{"error","err"}slogwebhook.RequestIgnoreHeaders=false
The following attributes are interpreted byslogwebhook.DefaultConverter:
| Atribute name | slog.Kind | Underlying type |
|---|---|---|
| "user" | group (see below) | |
| "error" | any | error |
| "request" | any | *http.Request |
| other attributes | * |
Other attributes will be injected inextra field.
Users must be of typeslog.Group. Eg:
slog.Group("user",slog.String("id","user-123"),slog.String("username","samber"),slog.Time("created_at",time.Now()),)
import ("fmt""net/http""time"slogwebhook"github.com/samber/slog-webhook/v2""log/slog")funcmain() {url:="https://webhook.site/xxxxxx"logger:=slog.New(slogwebhook.Option{Level:slog.LevelDebug,Endpoint:url}.NewWebhookHandler())logger=logger.With("release","v1.0.0")req,_:=http.NewRequest(http.MethodGet,"https://api.screeb.app",nil)req.Header.Set("Content-Type","application/json")req.Header.Set("X-TOKEN","1234567890")logger.With(slog.Group("user",slog.String("id","user-123"),slog.Time("created_at",time.Now()), ), ).With("request",req).With("error",fmt.Errorf("an error")).Error("a message")}
Output:
{"error": {"error":"an error","kind":"*errors.errorString","stack":null },"extra": {"release":"v1.0.0" },"level":"ERROR","logger":"samber/slog-webhook","message":"a message","request": {"headers": {"Content-Type":"application/json","X-Token":"1234567890" },"host":"api.screeb.app","method":"GET","url": {"fragment":"","host":"api.screeb.app","path":"","query": {},"raw_query":"","scheme":"https","url":"https://api.screeb.app" } },"timestamp":"2023-04-10T14:00:0.000000","user": {"id":"user-123","created_at":"2023-04-10T14:00:0.000000" }}Import the samber/slog-otel library.
import (slogwebhook"github.com/samber/slog-webhook"slogotel"github.com/samber/slog-otel""go.opentelemetry.io/otel/sdk/trace")funcmain() {tp:=trace.NewTracerProvider(trace.WithSampler(trace.AlwaysSample()),)tracer:=tp.Tracer("hello/world")ctx,span:=tracer.Start(context.Background(),"foo")deferspan.End()span.AddEvent("bar")logger:=slog.New(slogwebhook.Option{// ...AttrFromContext: []func(ctx context.Context) []slog.Attr{slogotel.ExtractOtelAttrFromContext([]string{"tracing"},"trace_id","span_id"),},}.NewWebhookHandler(),)logger.ErrorContext(ctx,"a message")}
- Ping me on twitter@samuelberthe (DMs, mentions, whatever :))
- Fork theproject
- Fixopen issues or request new features
Don't hesitate ;)
# Install some dev dependenciesmake tools# Run testsmaketest# ormake watch-test
Give a ⭐️ if this project helped you!
Copyright © 2023Samuel Berthe.
This project isMIT licensed.
About
🚨 slog: Webhook handler