otlpr

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #deep-learning #linux #cli #kubernetes #vue #awesome-list #open-source

(★ 9)

A logr implementation backed by OTLP

otlpr Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# otlpr

[![Go Reference](https://pkg.go.dev/badge/github.com/MrAlias/otlpr.svg)](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

otlpr

otlpr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

otlpr

otlpr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README