larry

README

larry

Larry is a minimal frontend for OpenTelemetry's Log SDK. This is inherently an unstable library because logs are only in Beta at the time of writing. This is intentionally a very thin wrapper for the Log SDK that just provides typical logging semantics. It has almost no features because the expectation is that any significant features would make more sense to implement via the OpenTelemetry Logs SDK instead of in this library. The only reason you should use this library (once logs go stable and this library is updated for those changes) instead of something like slog+slog bridge is if it bothers you on a personal level to log with slog only for it to be translated into OTel logs instead of using Otel types directly.

Future Improvements

• Remove the attribute.KeyValue -> log.KeyValue translation. This can be done once https://github.com/open-telemetry/opentelemetry-go/issues/7034 is completed and Record gets native support for KeyValue
• Add some mechanism similar to the With() method in slog. It is often useful to derive a logger from another logger and configure it to have some attributes on all log messages it emits. The utility here is obvious, but how to best derive the logger from the new parent is not (should it reuse the backing OTel Logger? create a new one?)

Documentation

Index

• type Logger
  • func New(name string, opts ...Option) *Logger
  • func (o *Logger) Debug(ctx context.Context, msg string, attrs ...attribute.KeyValue)
  • func (o *Logger) Error(ctx context.Context, msg string, attrs ...attribute.KeyValue)
  • func (o *Logger) Fatal(ctx context.Context, msg string, attrs ...attribute.KeyValue)
  • func (o *Logger) Info(ctx context.Context, msg string, attrs ...attribute.KeyValue)
  • func (o *Logger) Trace(ctx context.Context, msg string, attrs ...attribute.KeyValue)
  • func (o *Logger) Warn(ctx context.Context, msg string, attrs ...attribute.KeyValue)
• type Option
  • func WithAttributes(attrs ...attribute.KeyValue) Option
  • func WithLoggerOpts(opts ...log.LoggerOption) Option
  • func WithLoggerProvider(p log.LoggerProvider) Option

Types

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func New

func New(name string, opts ...Option) *Logger

func (*Logger) Debug

func (o *Logger) Debug(ctx context.Context, msg string, attrs ...attribute.KeyValue)

func (*Logger) Error

func (o *Logger) Error(ctx context.Context, msg string, attrs ...attribute.KeyValue)

func (*Logger) Fatal

func (o *Logger) Fatal(ctx context.Context, msg string, attrs ...attribute.KeyValue)

func (*Logger) Info

func (o *Logger) Info(ctx context.Context, msg string, attrs ...attribute.KeyValue)

func (*Logger) Trace

func (o *Logger) Trace(ctx context.Context, msg string, attrs ...attribute.KeyValue)

func (*Logger) Warn

func (o *Logger) Warn(ctx context.Context, msg string, attrs ...attribute.KeyValue)

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithAttributes

func WithAttributes(attrs ...attribute.KeyValue) Option

func WithLoggerOpts

func WithLoggerOpts(opts ...log.LoggerOption) Option

func WithLoggerProvider

func WithLoggerProvider(p log.LoggerProvider) Option