logger

Documentation

Index

• Constants
• type Entry
  • func (e Entry) String() string
• type LogLevel
• type Logger
  • func NewConsoleLogger(levels ...LogLevel) Logger
  • func NewGCloudLogger() Logger
  • func NewGCloudLoggerWithSink(sink Sink, level LogLevel) Logger
• type Sink
• type TestLogEntry
• type TestLogger
  • func NewTestLogger() *TestLogger
  • func (c *TestLogger) Debug(msg string, args ...interface{})
  • func (c *TestLogger) Error(msg string, args ...interface{})
  • func (c *TestLogger) Fatal(msg string, args ...interface{})
  • func (c *TestLogger) Info(msg string, args ...interface{})
  • func (c *TestLogger) Log(level string, msg string, args ...interface{})
  • func (c *TestLogger) Trace(msg string, args ...interface{})
  • func (c *TestLogger) Warn(msg string, args ...interface{})
  • func (c *TestLogger) With(metadata map[string]interface{}) Logger
  • func (c *TestLogger) WithPrefix(prefix string) Logger
  • func (c *TestLogger) WithSink(sink Sink, level LogLevel) Logger

Constants

const (
	Reset       = "\033[0m"
	Gray        = "\033[1;30m"
	Red         = "\033[31m"
	Green       = "\033[32m"
	Yellow      = "\033[33m"
	Blue        = "\033[34m"
	Magenta     = "\033[35m"
	Cyan        = "\033[36m"
	White       = "\033[37m"
	BlueBold    = "\033[34;1m"
	MagentaBold = "\033[35;1m"
	RedBold     = "\033[31;1m"
	YellowBold  = "\033[33;1m"
	WhiteBold   = "\033[37;1m"
	CyanBold    = "\033[36;1m"
	Purple      = "\u001b[38;5;200m"
)

Types

type Entry

type Entry struct {
	Timestamp time.Time              `json:"timestamp,omitempty"`
	Message   string                 `json:"message"`
	Severity  string                 `json:"severity,omitempty"`
	Trace     string                 `json:"logging.googleapis.com/trace,omitempty"`
	Metadata  map[string]interface{} `json:"metadata,omitempty"`
	// Logs Explorer allows filtering and display of this as `jsonPayload.component`.
	Component string `json:"component,omitempty"`
}

Entry defines a log entry https://github.com/GoogleCloudPlatform/golang-samples/blob/08bc985b4973901c09344eabbe9d7d5add7dc656/run/logging-manual/main.go

func (Entry) String

func (e Entry) String() string

String renders an entry structure to the JSON format expected by Cloud Logging.

type LogLevel

type LogLevel int

LogLevel defines the level of logging

const (
	LevelTrace LogLevel = iota
	LevelDebug
	LevelInfo
	LevelWarn
	LevelError
	LevelNone
)

type Logger

type Logger interface {
	// With will return a new logger using metadata as the base context
	With(metadata map[string]interface{}) Logger
	// WithPrefix will return a new logger with a prefix prepended to the message
	WithPrefix(prefix string) Logger
	// WithSink returns a Logger which will also delegate logs to the provided sink
	WithSink(sink Sink, level LogLevel) Logger
	// Trace level logging
	Trace(msg string, args ...interface{})
	// Debug level logging
	Debug(msg string, args ...interface{})
	// Info level logging
	Info(msg string, args ...interface{})
	// Warning level logging
	Warn(msg string, args ...interface{})
	// Error level logging
	Error(msg string, args ...interface{})
	// Fatal level logging and exit with code 1
	Fatal(msg string, args ...interface{})
}

Logger is an interface for logging

func NewConsoleLogger

func NewConsoleLogger(levels ...LogLevel) Logger

NewConsoleLogger returns a new Logger instance which will log to the console

func NewGCloudLogger

func NewGCloudLogger() Logger

NewGCloudLogger returns a new Logger instance which can be used for structured google cloud logging

func NewGCloudLoggerWithSink

func NewGCloudLoggerWithSink(sink Sink, level LogLevel) Logger

NewGCloudLoggerWithSink returns a new Logger instance using a sink and suppressing the console logging

type Sink

type Sink interface {
	// Write will receive the log output as a slice of bytes
	Write([]byte) error
}

type TestLogEntry

type TestLogEntry struct {
	Severity  string
	Message   string
	Arguments []interface{}
}

type TestLogger

type TestLogger struct {
	Logs []TestLogEntry
	// contains filtered or unexported fields
}

func NewTestLogger

func NewTestLogger() *TestLogger

NewTestLogger returns a new Logger instance useful for testing

func (*TestLogger) Debug

func (c *TestLogger) Debug(msg string, args ...interface{})

func (*TestLogger) Error

func (c *TestLogger) Error(msg string, args ...interface{})

func (*TestLogger) Fatal

func (c *TestLogger) Fatal(msg string, args ...interface{})

func (*TestLogger) Info

func (c *TestLogger) Info(msg string, args ...interface{})

func (*TestLogger) Log

func (c *TestLogger) Log(level string, msg string, args ...interface{})

func (*TestLogger) Trace

func (c *TestLogger) Trace(msg string, args ...interface{})

func (*TestLogger) Warn

func (c *TestLogger) Warn(msg string, args ...interface{})

func (*TestLogger) With

func (c *TestLogger) With(metadata map[string]interface{}) Logger

func (*TestLogger) WithPrefix

func (c *TestLogger) WithPrefix(prefix string) Logger

WithPrefix will return a new logger with a prefix prepended to the message

func (*TestLogger) WithSink

func (c *TestLogger) WithSink(sink Sink, level LogLevel) Logger