simplelogr

type ColourMode int

type DevelopmentLogSink struct {
	// contains filtered or unexported fields
}

type DevelopmentLogSinkOptions struct {
	// Output configures where to write logs to
	Output io.Writer
	// ColouredOutput determines whether coloured output will be used, if unspecified it will attempt to auto-detect
	// from the environment. This is usually confused by integrated terminals in IDEs, so for coloured output in IDEs
	// you may wish to use ColourModeForceOn
	ColouredOutput ColourMode
	// SeverityColours maps severity names (produced by SeverityEncoder) to colours, used when displaying severity names
	// and when Entry objects contain an Entry.Error
	SeverityColours map[string]*color.Color
	// PrimaryColour is the colour of log messages, logger names, and the values of key-value pairs
	PrimaryColour *color.Color
	// SecondaryColour is the colour of timestamps, and the keys of key-value pairs
	SecondaryColour *color.Color
	// SeverityEncoder identifies the severity name based on the verbosity level and the presence of any errors
	SeverityEncoder func(level int, err error) string
	// NameEncoder collapses the series of Logger names down into one string for logging
	NameEncoder func(names []string) string
	// TimestampEncoder formats timestamps into string representations
	TimestampEncoder func(t time.Time) string
	// ErrorKey determines the key prefix on any error messages, displayed as though "just another key-value pair",
	// but (if colours are enabled) printed using the relevant colour (see SeverityColours)
	ErrorKey string
	// ErrorEncoder  extracts loggable EncodedError information from an error
	ErrorEncoder func(err error) EncodedError
	// EntrySuffix is appended to the end of log entries, typically to add a newline between them
	EntrySuffix string
	// SpaceSeparator is placed between all log elements: timestamp, severity, logger name, message, and key-value pairs
	// It can be useful, for example, to change this to "\t" to increase spacing - which may improve readability
	SpaceSeparator string
}

type EncodedError struct {
	// Message is the primary message contained in the error, typically the result of error.Error()
	Message string
	// StackTrace is optional stack trace information extracted from the error
	StackTrace string
}

type Entry struct {
	// Level is the verbosity level of this log event, 0 being "least verbose", and larger numbers being more verbose
	Level int
	// Names is the list of names accumulated by chained calls to Logger.WithName
	Names []string
	// Timestamp is the time the log message was captured
	Timestamp time.Time
	// Message is typically a static string associated with the cause of the log event, often a short explanation of
	// what has occurred
	Message string
	// KVs is a sequence of keys and values, stored [key1, value1, key2, value2, ...], populated by both calls to
	// Logger.WithValues and the keysAndValues arguments to Logger.Info and Logger.Error
	KVs []interface{}
	// Error is the error passed to Logger.Error, and may be nil.
	Error error
}

type JSONLogSink struct {
	// contains filtered or unexported fields
}

type JSONLogSinkOptions struct {
	// Output configures where to write structured JSON logs to
	Output io.Writer
	// SeverityKey determines the top level JSON object key to store the log severity name in
	SeverityKey string
	// SeverityEncoder identifies the severity name based on the verbosity level and the presence of any errors
	SeverityEncoder func(level int, err error) string
	// NameKey determines the top level JSON object key to store the logger name in
	NameKey string
	// NameEncoder collapses the series of Logger names down into one string for logging
	NameEncoder func(names []string) string
	// MessageKey determines the top level JSON object key to store the log message in
	MessageKey string
	// TimestampKey determines the top level JSON object key to store the timestamp in
	TimestampKey string
	// TimestampEncoder formats timestamps into string representations
	TimestampEncoder func(t time.Time) string
	// ErrorKey determines the top level JSON object key to store any error messages in
	ErrorKey string
	// StackTraceKey determines the top level JSON object key to store any stack trace information in
	StackTraceKey string
	// ErrorEncoder  extracts loggable EncodedError information from an error
	ErrorEncoder func(err error) EncodedError
}

type LogSink interface {
	Log(e Entry) error
}

type Logger struct {
	// contains filtered or unexported fields
}

type Options struct {
	Sink         LogSink
	Verbosity    int
	ErrorHandler func(err error)
}

type SeverityThreshold struct {
	// Level at which the verbosity level must be greater than or equal to in order to satisfy this threshold
	Level int
	// Severity is the the severity level name
	Severity string
}

type SynchronizedWriter struct {
	Underlying io.Writer
	// contains filtered or unexported fields
}