inslogger

Documentation

Overview

Package inslogger contains context helpers for log

Examples:

// initialize base context with default logger with provided trace id
ctx, inslog := inslogger.WithTraceField(context.Background(), "TraceID")
inslog.Warn("warn")

// get logger from context
inslog := inslogger.FromContext(ctx)

// initalize logger (SomeNewLogger() should return insolar.Logger)
inslogger.SetLogger(ctx, SomeNewLogger())

Hints:

Use environment variables for log level setup:

INSOLAR_LOG_LEVEL=debug INSOLAR_LOG_FORMATTER=text go test ./yourpackage/...

Index

• func ContextWithTrace(ctx context.Context, traceid string) context.Context
• func FromContext(ctx context.Context) insolar.Logger
• func GetLoggerLevel(ctx context.Context) insolar.LogLevel
• func InitNodeLogger(ctx context.Context, cfg configuration.Log, traceID, nodeRef, nodeRole string) (context.Context, insolar.Logger)
• func SetLogger(ctx context.Context, l insolar.Logger) context.Context
• func TestContext(t *testing.T) context.Context
• func TraceID(ctx context.Context) string
• func UpdateLogger(ctx context.Context, fn func(insolar.Logger) (insolar.Logger, error)) context.Context
• func WithField(ctx context.Context, key string, value string) (context.Context, insolar.Logger)
• func WithFields(ctx context.Context, fields map[string]interface{}) (context.Context, insolar.Logger)
• func WithLoggerLevel(ctx context.Context, logLevel insolar.LogLevel) context.Context
• func WithTraceField(ctx context.Context, traceid string) (context.Context, insolar.Logger)

Functions

func ContextWithTrace

func ContextWithTrace(ctx context.Context, traceid string) context.Context

ContextWithTrace returns only context with logger initialized with provided traceid.

func FromContext

func FromContext(ctx context.Context) insolar.Logger

FromContext returns logger from context.

func GetLoggerLevel

func GetLoggerLevel(ctx context.Context) insolar.LogLevel

func InitNodeLogger

func InitNodeLogger(
	ctx context.Context,
	cfg configuration.Log,
	traceID, nodeRef, nodeRole string,
) (
	context.Context, insolar.Logger,
)

func SetLogger

func SetLogger(ctx context.Context, l insolar.Logger) context.Context

SetLogger returns context with provided insolar.Logger,

func TestContext

func TestContext(t *testing.T) context.Context

TestContext returns context with initalized log field "testname" equal t.Name() value.

func TraceID

func TraceID(ctx context.Context) string

func UpdateLogger

func UpdateLogger(ctx context.Context, fn func(insolar.Logger) (insolar.Logger, error)) context.Context

func WithField

func WithField(ctx context.Context, key string, value string) (context.Context, insolar.Logger)

WithField returns context with logger initialized with provided field's key value and logger itself.

func WithFields

func WithFields(ctx context.Context, fields map[string]interface{}) (context.Context, insolar.Logger)

WithFields returns context with logger initialized with provided fields map.

func WithLoggerLevel

func WithLoggerLevel(ctx context.Context, logLevel insolar.LogLevel) context.Context

SetLoggerLevel returns context with provided insolar.LogLevel and set logLevel on logger,

func WithTraceField

func WithTraceField(ctx context.Context, traceid string) (context.Context, insolar.Logger)

WithTraceField returns context with logger initialized with provided traceid value and logger itself.