log

Documentation

Index

• Constants
• func GetWriter(f Format) io.Writer
• type CtxHook
• type CtxHookFunc
  • func (h CtxHookFunc) Run(ctx context.Context, e *zerolog.Event, l zerolog.Level)
• type CtxLogger
  • func InitLogger(level zerolog.Level, f Format) CtxLogger
  • func New(logger zerolog.Logger) CtxLogger
  • func Nop() CtxLogger
  • func (l CtxLogger) Component() string
  • func (l CtxLogger) CtxHook(h ...CtxHook) CtxLogger
  • func (l CtxLogger) Debug(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) Err(ctx context.Context, err error) *zerolog.Event
  • func (l CtxLogger) Error(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) Fatal(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) Info(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) Log(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) Panic(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) Trace(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) Warn(ctx context.Context) *zerolog.Event
  • func (l CtxLogger) WithComponent(component string) CtxLogger
  • func (l CtxLogger) WithLevel(ctx context.Context, level zerolog.Level) *zerolog.Event
  • func (l CtxLogger) ZerologWithComponent() zerolog.Logger
• type Format
  • func ParseFormat(format string) (Format, error)

Constants

const (
	ComponentField      = "component"
	ConnectorIDField    = "connector_id"
	DurationField       = "duration"
	MessageIDField      = "message_id"
	NodeIDField         = "node_id"
	PipelineIDField     = "pipeline_id"
	RecordPositionField = "record_position"
	RequestIDField      = "request_id"
	ServerAddressField  = "address"

	GRPCMethodField     = "grpc_method"
	GRPCStatusCodeField = "grpc_status_code"
	HTTPEndpointField   = "http_endpoint"

	PluginTypeField = "plugin_type"
	PluginNameField = "plugin_name"
)

Functions

func GetWriter

func GetWriter(f Format) io.Writer

GetWriter returns a writer according to the log Format

Types

type CtxHook

type CtxHook interface {
	// Run runs the hook with the logger context.
	Run(ctx context.Context, e *zerolog.Event, l zerolog.Level)
}

CtxHook defines an interface for a log context hook.

type CtxHookFunc

type CtxHookFunc func(ctx context.Context, e *zerolog.Event, l zerolog.Level)

CtxHookFunc is an adaptor to allow the use of an ordinary function as a Hook.

func (CtxHookFunc) Run

func (h CtxHookFunc) Run(ctx context.Context, e *zerolog.Event, l zerolog.Level)

Run implements the CtxHook interface.

type CtxLogger

type CtxLogger struct {
	zerolog.Logger
	// contains filtered or unexported fields
}

CtxLogger is a wrapper around a zerolog.Logger which adds support for adding context hooks to it. All methods that return *zerolog.Event are switched for versions that take a context and trigger context hooks before returning the entry.

func InitLogger

func InitLogger(level zerolog.Level, f Format) CtxLogger

InitLogger returns a logger initialized with the wanted level and format

func New

func New(logger zerolog.Logger) CtxLogger

New creates a new CtxLogger with the supplied zerolog.Logger.

func Nop

func Nop() CtxLogger

Nop returns a disabled logger for which all operation are no-op.

func (CtxLogger) Component

func (l CtxLogger) Component() string

func (CtxLogger) CtxHook

func (l CtxLogger) CtxHook(h ...CtxHook) CtxLogger

CtxHook returns a logger with the h CtxHook.

func (CtxLogger) Debug

func (l CtxLogger) Debug(ctx context.Context) *zerolog.Event

Debug starts a new message with debug level and context ctx.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Err

func (l CtxLogger) Err(ctx context.Context, err error) *zerolog.Event

Err starts a new message with context ctx and error level with err as a field if not nil or with info level if err is nil.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Error

func (l CtxLogger) Error(ctx context.Context) *zerolog.Event

Error starts a new message with error level and context ctx.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Fatal

func (l CtxLogger) Fatal(ctx context.Context) *zerolog.Event

Fatal starts a new message with fatal level and context ctx. The os.Exit(1) function is called by the Msg method, which terminates the program immediately.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Info

func (l CtxLogger) Info(ctx context.Context) *zerolog.Event

Info starts a new message with info level and context ctx.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Log

func (l CtxLogger) Log(ctx context.Context) *zerolog.Event

Log starts a new message with no level and context ctx. Setting GlobalLevel to Disabled will still disable events produced by this method.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Panic

func (l CtxLogger) Panic(ctx context.Context) *zerolog.Event

Panic starts a new message with panic level and context ctx. The panic() function is called by the Msg method, which stops the ordinary flow of a goroutine.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Trace

func (l CtxLogger) Trace(ctx context.Context) *zerolog.Event

Trace starts a new message with trace level and context ctx.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) Warn

func (l CtxLogger) Warn(ctx context.Context) *zerolog.Event

Warn starts a new message with warn level and context ctx.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) WithComponent

func (l CtxLogger) WithComponent(component string) CtxLogger

WithComponent adds the component to the output. This function can be called multiple times with the same value and it will produce the same result. If component is an empty string then nothing will be added to the output.

func (CtxLogger) WithLevel

func (l CtxLogger) WithLevel(ctx context.Context, level zerolog.Level) *zerolog.Event

WithLevel starts a new message with level and context ctx. Unlike Fatal and Panic methods, WithLevel does not terminate the program or stop the ordinary flow of a gourotine when used with their respective levels.

You must call Msg on the returned event in order to send the event.

func (CtxLogger) ZerologWithComponent

func (l CtxLogger) ZerologWithComponent() zerolog.Logger

ZerologWithComponent returns a zerolog.Logger that adds the component field to all log entries.

type Format

type Format int

const (
	FormatCLI Format = iota
	FormatJSON
)

func ParseFormat

func ParseFormat(format string) (Format, error)

ParseFormat converts a format string into a log Format value. returns an error if the input string does not match known values.