spanlogger

Documentation

Index

• Constants
• type SpanLogger
  • func FromContext(ctx context.Context) *SpanLogger
  • func FromContextWithFallback(ctx context.Context, fallback log.Logger) *SpanLogger
  • func New(ctx context.Context, method string, kvps ...interface{}) (*SpanLogger, context.Context)
  • func NewWithLogger(ctx context.Context, l log.Logger, method string, kvps ...interface{}) (*SpanLogger, context.Context)
  • func (s *SpanLogger) Error(err error) error
  • func (s *SpanLogger) Log(kvps ...interface{}) error

Constants

const (
	TenantIDTagName = "tenant_ids"
)

Types

type SpanLogger

type SpanLogger struct {
	log.Logger
	opentracing.Span
}

SpanLogger unifies tracing and logging, to reduce repetition.

func FromContext

func FromContext(ctx context.Context) *SpanLogger

FromContext returns a span logger using the current parent span. If there is no parent span, the SpanLogger will only log to the logger in the context. If the context doesn't have a logger, the global logger is used.

func FromContextWithFallback

func FromContextWithFallback(ctx context.Context, fallback log.Logger) *SpanLogger

FromContextWithFallback returns a span logger using the current parent span. IF there is no parent span, the SpanLogger will only log to the logger within the context. If the context doesn't have a logger, the fallback logger is used.

func New

func New(ctx context.Context, method string, kvps ...interface{}) (*SpanLogger, context.Context)

New makes a new SpanLogger, where logs will be sent to the global logger.

func NewWithLogger

func NewWithLogger(ctx context.Context, l log.Logger, method string, kvps ...interface{}) (*SpanLogger, context.Context)

NewWithLogger makes a new SpanLogger with a custom log.Logger to send logs to. The provided context will have the logger attached to it and can be retrieved with FromContext or FromContextWithFallback.

func (*SpanLogger) Error

func (s *SpanLogger) Error(err error) error

Error sets error flag and logs the error on the span, if non-nil. Returns the err passed in.

func (*SpanLogger) Log

func (s *SpanLogger) Log(kvps ...interface{}) error

Log implements gokit's Logger interface; sends logs to underlying logger and also puts the on the spans.