logger

Documentation

Overview

Package logger adapts the zerolog package to use GCP serverity levels.

Index

• Constants
• func Discard()
• func GinLogger(server, version string) gin.HandlerFunc
• func ResetLogger()
• func Testing(tb testing.TB)
• type LevelDecoder
  • func (ll *LevelDecoder) Decode(value string) error
  • func (ll *LevelDecoder) Encode() (string, error)
  • func (ll LevelDecoder) String() string
• type SeverityHook
  • func (h SeverityHook) Run(e *zerolog.Event, level zerolog.Level, msg string)

Constants

const (
	GCPAlertLevel    severityGCP = "ALERT"
	GCPCriticalLevel severityGCP = "CRITICAL"
	GCPErrorLevel    severityGCP = "ERROR"
	GCPWarningLevel  severityGCP = "WARNING"
	GCPInfoLevel     severityGCP = "INFO"
	GCPDebugLevel    severityGCP = "DEBUG"

	GCPFieldKeySeverity = "severity"
	GCPFieldKeyMsg      = "message"
	GCPFieldKeyTime     = "time"
)

Functions

func Discard

func Discard()

func GinLogger

func GinLogger(server, version string) gin.HandlerFunc

GinLogger returns a new Gin middleware that performs logging for our JSON APIs using zerolog rather than the default Gin logger which is a standard HTTP logger. Provide the server name (e.g. "whisper") and the version of the server for log parsing. NOTE: we previously used github.com/dn365/gin-zerolog but wanted more customization.

func ResetLogger

func ResetLogger()

func Testing

func Testing(tb testing.TB)

Types

type LevelDecoder

type LevelDecoder zerolog.Level

LogLevelDecoder deserializes the log level from a config string.

func (*LevelDecoder) Decode

func (ll *LevelDecoder) Decode(value string) error

Decode implements envconfig.Decoder

func (*LevelDecoder) Encode

func (ll *LevelDecoder) Encode() (string, error)

Encode converts the loglevel into a string for use in YAML and JSON

func (LevelDecoder) String

func (ll LevelDecoder) String() string

type SeverityHook

type SeverityHook struct{}

SeverityHook adds GCP severity levels to zerolog output log messages.

func (SeverityHook) Run

func (h SeverityHook) Run(e *zerolog.Event, level zerolog.Level, msg string)

Run implements the zerolog.Hook interface.