Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remychantenay/slog-otel
Go slog's Handler implementation to ensure correlation with Open-Telemetry spans.
https://github.com/remychantenay/slog-otel
golang logging open-telemetry otel slog tracing
Last synced: 7 days ago
JSON representation
Go slog's Handler implementation to ensure correlation with Open-Telemetry spans.
- Host: GitHub
- URL: https://github.com/remychantenay/slog-otel
- Owner: remychantenay
- License: apache-2.0
- Created: 2023-09-11T16:48:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-11T05:14:41.000Z (3 months ago)
- Last Synced: 2024-09-21T11:31:00.341Z (12 days ago)
- Topics: golang, logging, open-telemetry, otel, slog, tracing
- Language: Go
- Homepage:
- Size: 37.1 KB
- Stars: 113
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-slog - slog-otel - Telemetry traces. (Enrichment)
README
# slog-otel
[](https://goreportcard.com/report/github.com/remychantenay/slog-otel)
[](https://codebeat.co/projects/github-com-remychantenay-slog-otel-main)
[](https://godoc.org/github.com/remychantenay/slog-otel)
[](https://opensource.org/licenses/Apache-2.0)
Go package that provides an implementation of `log/slog`'s [Handler interface](https://pkg.go.dev/log/slog#Handler) that ensures a strong correlation between log records and [Open-Telemetry spans](https://opentelemetry.io/docs/concepts/signals/traces/#spans) by...
1. Adding [span and trace IDs](https://opentelemetry.io/docs/concepts/signals/traces/#span-context) to the log record.
2. Adding context [baggage](https://opentelemetry.io/docs/concepts/signals/baggage/) members to the log record (can be disabled).
3. Adding log record as [span event](https://opentelemetry.io/docs/concepts/signals/traces/#span-events) (can be disabled).
4. Adding log record attributes to the span event (can be disabled).
5. Setting [span status](https://opentelemetry.io/docs/concepts/signals/traces/#span-status) based on slog record level (only if >= slog.LevelError).
## Usage
```go
import (
"context"
"log/slog"
"go.opentelemetry.io/otel/baggage"
"go.opentelemetry.io/otel/trace"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
slogotel "github.com/remychantenay/slog-otel"
)
// 1. Configure slog.
slog.SetDefault(slog.New(slogotel.OtelHandler{
Next: slog.NewJSONHandler(os.Stdout, nil),
}))
// 2. Set up your logger.
logger := slog.Default()
logger = logger.With("component", "server")
// 3. (Optional) Add baggage to your context.
m1, _ := baggage.NewMember("key_1", "value_1")
m2, _ := baggage.NewMember("key_2", "value_2")
bag, _ := baggage.New(m1, m2)
ctx := baggage.ContextWithBaggage(context.Background(), bag)
// 4. Start your span.
ctx, span := tracer.Start(ctx, "operation-name")
defer span.End()
// 5. Log.
logger.InfoContext(ctx, "Hello world!", "locale", "en_US")
```
#### Example
The following initial log:
```json
{
"time": "2023-09-11T08:28:02.77215605Z",
"level": "INFO",
"component": "server",
"msg": "Hello world!",
"locale": "en_US"
}
```
... will be written as:
```json
{
"time": "2023-09-11T08:28:02.77215605Z",
"level": "INFO",
"component": "server",
"msg": "Hello world!",
"locale": "en_US",
"trace_id": "a9938fd7a6313e0f27f3fc87f574bff6",
"span_id": "ed58f84d8971bf60",
"key_1": "value_1",
"key_2": "value_2"
}
```
and the related span will look like:
```json
{
"Name": "GET /resources",
"SpanContext": {
"TraceID": "a9938fd7a6313e0f27f3fc87f574bff6",
"SpanID": "ed58f84d8971bf60",
...
},
"Parent": {
...
},
"SpanKind": 2,
"StartTime": "2023-09-11T08:28:02.761992425Z",
"EndTime": "2023-09-11T08:28:02.773230425Z",
"Attributes": [{
"Key": "http.method",
"Value": {
"Type": "STRING",
"Value": "GET"
}
},
...
],
"Events": [{
"Name": "log_record",
"Attributes": [{
"Key": "msg",
"Value": {
"Type": "STRING",
"Value": "Hello world!"
}
},
{
"Key": "level",
"Value": {
"Type": "STRING",
"Value": "INFO"
}
},
{
"Key": "time",
"Value": {
"Type": "STRING",
"Value": "2023-09-11T08:28:02.77215605Z"
}
},
{
"Key": "locale",
"Value": {
"Type": "STRING",
"Value": "en_US"
}
},
{
"Key": "component",
"Value": {
"Type": "STRING",
"Value": "server"
}
}
],
}],
...
}
```
## License
Apache License Version 2.0