README
¶
OpenTelemetry Go instrumentation for logrus logging
This instrumentation records logrus log messages as events on the existing span that is passed via a
context.Context. It does not record anything if a context does not contain a span.
Installation
go get github.com/rlakhtakia/opentelemetry-go-extra/otellogrus
Usage
You need to install an otellogrus.Hook and use logrus.WithContext to propagate the active span.
import (
"github.com/rlakhtakia/opentelemetry-go-extra/otellogrus"
"github.com/sirupsen/logrus"
)
// Instrument logrus.
logrus.AddHook(otellogrus.NewHook(otellogrus.WithLevels(
logrus.PanicLevel,
logrus.FatalLevel,
logrus.ErrorLevel,
logrus.WarnLevel,
)))
// Use ctx to pass the active span.
logrus.WithContext(ctx).
WithError(errors.New("hello world")).
WithField("foo", "bar").
Error("something failed")
See example for details.
Options
otellogrus.NewHook accepts the following options:
otellogrus.WithLevels(logrus.PanicLevel, logrus.FatalLevel, logrus.ErrorLevel, logrus.WarnLevel)sets the logrus logging levels on which the hook is fired.WithErrorStatusLevel(logrus.ErrorLevel)sets the minimal logrus logging level on which the span status is set to codes.Error.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Hook ¶
type Hook struct {
// contains filtered or unexported fields
}
Hook is a logrus hook that adds logs to the active span as events.
type Option ¶
type Option func(h *Hook)
Option applies a configuration to the given config.
func WithErrorStatusLevel ¶
WithErrorStatusLevel sets the minimal logrus logging level on which the span status is set to codes.Error.
The default is <= logrus.ErrorLevel.
func WithLevels ¶
WithLevels sets the logrus logging levels on which the hook is fired.
The default is all levels between logrus.PanicLevel and logrus.WarnLevel inclusive.
Source Files
Directories