Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mralias/otlpr
A logr implementation backed by OTLP
https://github.com/mralias/otlpr
go golang logger logging logr opentelemetry opentelemetry-go otel otlp
Last synced: 3 months ago
JSON representation
A logr implementation backed by OTLP
- Host: GitHub
- URL: https://github.com/mralias/otlpr
- Owner: MrAlias
- License: apache-2.0
- Created: 2022-11-11T22:04:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T14:39:54.000Z (9 months ago)
- Last Synced: 2024-04-08T18:10:41.752Z (9 months ago)
- Topics: go, golang, logger, logging, logr, opentelemetry, opentelemetry-go, otel, otlp
- Language: Go
- Homepage:
- Size: 175 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# otlpr
[](https://pkg.go.dev/github.com/MrAlias/otlpr)
This repository provides a [`logr.Logger`] that exports recorded messages as [OpenTelemetry logs] to an [OTLP] receiving endpoint.
:construction: This repository is a work in progress and not production ready.
## Getting Started
A working gRPC connection to an OTLP receiving endpoint is needed to setup the logger.
```go
conn, _ := grpc.NewClient(otlpTarget)
```
Create a [`logr.Logger`] with this connection.
```go
logger := otlpr.New(conn)
```
See the [example] for a working example application.
## Batching
By default the logger will batch the log messages as they are received.
It will wait to batch `2048` messages before exporting.
A `Batcher` can be used to change this behavior.
```go
opts := otlpr.Options{
Batcher: otlpr.Batcher{
// Only queue at most 100 messages.
Messages: 100,
// Only wait 3 seconds for the queue to fill.
Timeout: 3 * time.Second,
},
}
logger := otlpr.NewWithOptions(conn, opts)
```
### Max messages in export
The `Batcher` can be configured to limit the number of messages it sends for
each export with the `ExportN` setting.
```go
opts := otlpr.Options{
Batcher: otlpr.Batcher{
// Only send at most 100 messages per export.
ExportN: 100,
},
}
logger := otlpr.NewWithOptions(conn, opts)
```
## Annotating Span Context
OTLP is able to associate span context with log messages.
Use the `WithContext` function to associate a `context.Context` that contains an active span with all logs the logger creates.
```go
logger = otlpr.WithContext(logger, ctx)
```
The function can also be used to clear any span context from the logger.
```go
logger = otlpr.WithContext(logger, context.Background())
```
[`logr.Logger`]: https://pkg.go.dev/github.com/go-logr/logr#Logger
[example]: ./example/
## Adding a Resource
The system a log message is produced in can be described with a [`Resource`].
Use the `WithResource` function to include this information with the exported OTLP data.
```go
logger = otlpr.WithResource(logger, resource)
```
The function can also be used to clear any resource from the logger.
```go
logger = otlpr.WithResource(logger, nil)
```
## Adding Scope
The portion of a system a log message is produced in can be described with [`Scope`].
Use the `WithScope` function to include this information with the exported OTLP data.
```go
logger = otlpr.WithScope(logger, resource)
```
The function can also be used to clear any scope from the logger.
```go
logger = otlpr.WithScope(logger, instrumentation.Scope{})
```
[`logr.Logger`]: https://pkg.go.dev/github.com/go-logr/logr#Logger
[OpenTelemetry logs]: https://opentelemetry.io/docs/reference/specification/logs/data-model/
[OTLP]: https://opentelemetry.io/docs/reference/specification/protocol/
[example]: ./example/
[`Resource`]: https://pkg.go.dev/go.opentelemetry.io/otel/sdk/resource#Resource
[`Scope`]: https://pkg.go.dev/go.opentelemetry.io/otel/sdk/instrumentation#Scope