slog: Graylog handler
A Graylog Handler for slog Go library.
See also:
🚀 Install
go get github.com/samber/slog-graylog
Compatibility: go >= 1.20.3
This library is v0 and follows SemVer strictly. On slog
final release (go 1.21), this library will go v1.
No breaking changes will be made to exported APIs before v1.0.0.
💡 Usage
GoDoc: https://pkg.go.dev/github.com/samber/slog-graylog
Handler options
type Option struct {
// log level (default: debug)
Level slog.Leveler
// connection to graylog
Writer *gelf.Writer
// optional: customize json payload builder
Converter Converter
}
Attributes will be injected in log payload.
Example
import (
"github.com/Graylog2/go-gelf/gelf"
sloggraylog "github.com/samber/slog-graylog"
"golang.org/x/exp/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)
}
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":"ERROR",
"message":"caramba!",
"error":{
"error":"could not count users",
"kind":"*errors.errorString",
"stack":null
},
"extra":{
"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":"INFO",
"message":"user registration",
"error":null,
"extra":{
"environment":"dev",
"release":"v1.0.0",
"user":{
"id":"user-123",
"created_at":"2023-04-10T14:00:0.000000+00:00"
}
}
}
🤝 Contributing
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.