Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samber/slog-quickwit
🚨 slog: Quickwit handler
https://github.com/samber/slog-quickwit
analytics attribute error errors go golang handler log log-level logger middleware quickwit search slog structured-logging tracing
Last synced: about 2 months ago
JSON representation
🚨 slog: Quickwit handler
- Host: GitHub
- URL: https://github.com/samber/slog-quickwit
- Owner: samber
- License: mit
- Created: 2024-05-01T18:27:12.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T19:05:27.000Z (about 2 months ago)
- Last Synced: 2024-11-09T19:17:59.556Z (about 2 months ago)
- Topics: analytics, attribute, error, errors, go, golang, handler, log, log-level, logger, middleware, quickwit, search, slog, structured-logging, tracing
- Language: Go
- Homepage: https://pkg.go.dev/github.com/samber/slog-quickwit
- Size: 31.3 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# slog: Quickwit handler
[](https://github.com/samber/slog-quickwit/releases)
[](https://pkg.go.dev/github.com/samber/slog-quickwit)
[](https://goreportcard.com/report/github.com/samber/slog-quickwit)
[](https://codecov.io/gh/samber/slog-quickwit)
[](https://github.com/samber/slog-quickwit/graphs/contributors)
[](./LICENSE)
A [Quickwit](https://quickwit.io) Handler for [slog](https://pkg.go.dev/log/slog) Go library.
Sponsored by:
Cloud-native search engine for observability - An OSS alternative to Splunk, Elasticsearch, Loki, and Tempo.
**See also:**
- [slog-multi](https://github.com/samber/slog-multi): `slog.Handler` chaining, fanout, routing, failover, load balancing...
- [slog-formatter](https://github.com/samber/slog-formatter): `slog` attribute formatting
- [slog-sampling](https://github.com/samber/slog-sampling): `slog` sampling policy
- [slog-mock](https://github.com/samber/slog-mock): `slog.Handler` for test purposes
**HTTP middlewares:**
- [slog-gin](https://github.com/samber/slog-gin): Gin middleware for `slog` logger
- [slog-echo](https://github.com/samber/slog-echo): Echo middleware for `slog` logger
- [slog-fiber](https://github.com/samber/slog-fiber): Fiber middleware for `slog` logger
- [slog-chi](https://github.com/samber/slog-chi): Chi middleware for `slog` logger
- [slog-http](https://github.com/samber/slog-http): `net/http` middleware for `slog` logger
**Loggers:**
- [slog-zap](https://github.com/samber/slog-zap): A `slog` handler for `Zap`
- [slog-zerolog](https://github.com/samber/slog-zerolog): A `slog` handler for `Zerolog`
- [slog-logrus](https://github.com/samber/slog-logrus): A `slog` handler for `Logrus`
**Log sinks:**
- [slog-datadog](https://github.com/samber/slog-datadog): A `slog` handler for `Datadog`
- [slog-betterstack](https://github.com/samber/slog-betterstack): A `slog` handler for `Betterstack`
- [slog-rollbar](https://github.com/samber/slog-rollbar): A `slog` handler for `Rollbar`
- [slog-loki](https://github.com/samber/slog-loki): A `slog` handler for `Loki`
- [slog-sentry](https://github.com/samber/slog-sentry): A `slog` handler for `Sentry`
- [slog-syslog](https://github.com/samber/slog-syslog): A `slog` handler for `Syslog`
- [slog-logstash](https://github.com/samber/slog-logstash): A `slog` handler for `Logstash`
- [slog-fluentd](https://github.com/samber/slog-fluentd): A `slog` handler for `Fluentd`
- [slog-graylog](https://github.com/samber/slog-graylog): A `slog` handler for `Graylog`
- [slog-quickwit](https://github.com/samber/slog-quickwit): A `slog` handler for `Quickwit`
- [slog-slack](https://github.com/samber/slog-slack): A `slog` handler for `Slack`
- [slog-telegram](https://github.com/samber/slog-telegram): A `slog` handler for `Telegram`
- [slog-mattermost](https://github.com/samber/slog-mattermost): A `slog` handler for `Mattermost`
- [slog-microsoft-teams](https://github.com/samber/slog-microsoft-teams): A `slog` handler for `Microsoft Teams`
- [slog-webhook](https://github.com/samber/slog-webhook): A `slog` handler for `Webhook`
- [slog-kafka](https://github.com/samber/slog-kafka): A `slog` handler for `Kafka`
- [slog-nats](https://github.com/samber/slog-nats): A `slog` handler for `NATS`
- [slog-parquet](https://github.com/samber/slog-parquet): A `slog` handler for `Parquet` + `Object Storage`
- [slog-channel](https://github.com/samber/slog-channel): A `slog` handler for Go channels
## 🚀 Install
```sh
go get github.com/samber/slog-quickwit
```
**Compatibility**: go >= 1.21
This library is v0 and follows SemVer strictly. Some breaking changes might be made to exported APIs before v1.0.0.
## 💡 Usage
GoDoc: [https://pkg.go.dev/github.com/samber/slog-quickwit](https://pkg.go.dev/github.com/samber/slog-quickwit)
### Handler options
```go
type Option struct {
// log level (default: debug)
Level slog.Leveler
// Quickwit client
Client *quickwit.Client
// 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 payload.
Other global parameters:
```go
slogquickwit.SourceKey = "source"
slogquickwit.ContextKey = "context"
slogquickwit.ErrorKeys = []string{"error", "err"}
```
### Example
```go
import (
"github.com/samber/go-quickwit"
slogquickwit "github.com/samber/slog-slogquickwit"
"log/slog"
)
func main() {
// docker-compose up -d
// curl -X POST \
// 'http://localhost:7280/api/v1/indexes' \
// -H 'Content-Type: application/yaml' \
// --data-binary @test-config.yaml
client := quickwit.NewWithDefault("http://localhost:7280", "my-index")
defer client.Stop() // flush and stop
logger := slog.New(slogquickwit.Option{Level: slog.LevelDebug, Client: client}.NewQuickwitHandler())
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")
}
```
### Tracing
Import the samber/slog-otel library.
```go
import (
slogquickwit "github.com/samber/slog-quickwit"
slogotel "github.com/samber/slog-otel"
"go.opentelemetry.io/otel/sdk/trace"
)
func main() {
client := quickwit.NewWithDefault("http://localhost:7280", "my-index")
defer client.Stop() // flush and stop
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(
slogquickwit.Option{
// ...
AttrFromContext: []func(ctx context.Context) []slog.Attr{
slogotel.ExtractOtelAttrFromContext([]string{"tracing"}, "trace_id", "span_id"),
},
}.NewQuickwitHandler(),
)
logger.ErrorContext(ctx, "a message")
}
```
## 🤝 Contributing
- Ping me on Twitter [@samuelberthe](https://twitter.com/samuelberthe) (DMs, mentions, whatever :))
- Fork the [project](https://github.com/samber/slog-quickwit)
- Fix [open issues](https://github.com/samber/slog-quickwit/issues) or request new features
Don't hesitate ;)
```bash
# Start quickwit
docker-compose up -d
curl -X POST \
'http://localhost:7280/api/v1/indexes' \
-H 'Content-Type: application/yaml' \
--data-binary @test-config.yaml
# 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!
[](https://github.com/sponsors/samber)
## 📝 License
Copyright © 2024 [Samuel Berthe](https://github.com/samber).
This project is [MIT](./LICENSE) licensed.