otelzap

README

otelzap

OpenTelemetry integration with ZAP logger.

Released under the MIT License.

Quick start

This package can be used to add regular log messages as OpenTelemetry events.

func MyAction(ctx context.Context, foo int) {
    ctx, span := tracer.Start(ctx, "MyAction")
    defer span.End()

    LOG := otelzap.SpanLogger(span, logger)

    LOG.Debug("do my action", zap.Int("foo", foo))
    // will write to stdout as normal zap logger does
    // and also will add "do my action" event to the span
}

Documentation

Overview

Package otelzap writes zap logs as OTEL events.

Index

• func Any(key string, value interface{}) attribute.KeyValue
• func AppendZapFields(attributes []attribute.KeyValue, fields ...zapcore.Field) []attribute.KeyValue
• func HTTPHeader(key string, header http.Header, exclude map[string]bool) attribute.KeyValue
• func SpanLogger(span trace.Span, logger *zap.Logger) *zap.Logger
• func SpanLoggerFromContext(ctx context.Context, logger *zap.Logger) *zap.Logger

Functions

func Any

func Any(key string, value interface{}) attribute.KeyValue

Any converts unknown type to OpenTelemetry attribute, probably as JSON value.

func AppendZapFields

func AppendZapFields(attributes []attribute.KeyValue, fields ...zapcore.Field) []attribute.KeyValue

AppendZapFields converts and appends a few ZAP fields.

func HTTPHeader

func HTTPHeader(key string, header http.Header, exclude map[string]bool) attribute.KeyValue

HTTPHeader converts HTTP headers into OpenTelemetry attribute as multi-line string. The HTTP headers to exclude should be in canonical form (see textproto.CanonicalMIMEHeaderKey).

func SpanLogger

func SpanLogger(span trace.Span, logger *zap.Logger) *zap.Logger

SpanLogger creates ZAP logger which also writes to OpenTelemetry span. If span is `nil“ or `no-op` then the same logger returned.

func SpanLoggerFromContext

func SpanLoggerFromContext(ctx context.Context, logger *zap.Logger) *zap.Logger

SpanLoggerFromContext similar to SpanLogger but gets span from context.