log

Documentation

Overview

Package log is a context based logging package, designed to interact well with both the lsp protocol and the other telemetry packages.

Index

• Constants
• func AddLogger(logger Logger)
• func Error(ctx context.Context, message string, err error, tags ...tag.Tagger)
• func Print(ctx context.Context, message string, tags ...tag.Tagger)
• func Stderr(ctx context.Context, at time.Time, tags tag.List) bool
• func With(ctx context.Context, tags ...tag.Tag)
• type Entry
  • func ToEntry(ctx context.Context, at time.Time, tags tag.List) Entry
  • func (e Entry) Format(f fmt.State, r rune)
• type Logger

Constants

const (
	// The well known tag keys for the logging system.
	MessageTag = tag.Key("message")
	ErrorTag   = tag.Key("error")
)

Functions

func AddLogger

func AddLogger(logger Logger)

func Error

func Error(ctx context.Context, message string, err error, tags ...tag.Tagger)

Print takes a message and a tag list and combines them into a single tag list before delivering them to the loggers.

func Print

func Print(ctx context.Context, message string, tags ...tag.Tagger)

Print takes a message and a tag list and combines them into a single tag list before delivering them to the loggers.

func Stderr

func Stderr(ctx context.Context, at time.Time, tags tag.List) bool

Stderr is a logger that logs to stderr in the standard format.

func With

func With(ctx context.Context, tags ...tag.Tag)

With sends a tag list to the installed loggers.

Types

type Entry

type Entry struct {
	At      time.Time
	Message string
	Error   error
	Tags    tag.List
}

func ToEntry

func ToEntry(ctx context.Context, at time.Time, tags tag.List) Entry

func (Entry) Format

func (e Entry) Format(f fmt.State, r rune)

type Logger

type Logger func(ctx context.Context, at time.Time, tags tag.List) bool

Logger is a function that handles logging messages. Loggers are registered at start up, and may use information in the context to decide what to do with a given log message.