log

Documentation

Overview

Package log provides a logging interface to send logs from plugins to Grafana server.

Index

• Variables
• func ContextualAttributesFromContext(ctx context.Context) []any
• func ContextualAttributesFromIncomingContext(ctx context.Context) []any
• func WithContextualAttributes(ctx context.Context, logParams []any) context.Context
• func WithContextualAttributesForOutgoingContext(ctx context.Context, logParams []any) context.Context
• type Level
• type Logger
  • func New() Logger
  • func NewNullLogger() Logger
  • func NewWithLevel(level Level) Logger

Variables

var DefaultLogger = New()

DefaultLogger is the default logger.

Functions

func ContextualAttributesFromContext

func ContextualAttributesFromContext(ctx context.Context) []any

ContextualAttributesFromContext returns the contextual key/value log parameters from the given context. If no contextual log parameters are set, it returns nil.

func ContextualAttributesFromIncomingContext

func ContextualAttributesFromIncomingContext(ctx context.Context) []any

ContextualAttributesFromIncomingContext returns the contextual key/value log parameters from the given incoming context.

func WithContextualAttributes

func WithContextualAttributes(ctx context.Context, logParams []any) context.Context

WithContextualAttributes returns a new context with the given key/value log parameters appended to the existing ones. It's possible to get a logger with those contextual parameters by using [FromContext].

func WithContextualAttributesForOutgoingContext

func WithContextualAttributesForOutgoingContext(ctx context.Context, logParams []any) context.Context

WithContextualAttributesForOutgoingContext will append the given key/value log parameters to the outgoing context.

Types

type Level

type Level int32

const (
	NoLevel Level = iota
	Trace
	Debug
	Info
	Warn
	Error
)

type Logger

type Logger interface {
	Debug(msg string, args ...interface{})
	Info(msg string, args ...interface{})
	Warn(msg string, args ...interface{})
	Error(msg string, args ...interface{})
	With(args ...interface{}) Logger
	Level() Level
	FromContext(ctx context.Context) Logger
}

Logger is the main Logger interface.

func New

func New() Logger

New creates a new logger.

func NewNullLogger

func NewNullLogger() Logger

NewNullLogger returns a logger that does nothing, for testing purposes

func NewWithLevel

func NewWithLevel(level Level) Logger

NewWithLevel creates a new logger at the Level defined.