log

Documentation

Index

• Constants
• type Logger
  • func MustNewDefaultLogger(format, level string, trace bool) Logger
  • func NewDefaultLogger(format, level string, trace bool) (Logger, error)
  • func NewNopLogger() Logger
  • func TestingLogger() Logger
  • func TestingLoggerWithOutput(w io.Writer) Logger

Constants

const (
	// LogFormatPlain defines a logging format used for human-readable text-based
	// logging that is not structured. Typically, this format is used for development
	// and testing purposes.
	LogFormatPlain string = "plain"

	// LogFormatText defines a logging format used for human-readable text-based
	// logging that is not structured. Typically, this format is used for development
	// and testing purposes.
	LogFormatText string = "text"

	// LogFormatJSON defines a logging format for structured JSON-based logging
	// that is typically used in production environments, which can be sent to
	// logging facilities that support complex log parsing and querying.
	LogFormatJSON string = "json"

	// Supported loging levels
	LogLevelDebug = "debug"
	LogLevelInfo  = "info"
	LogLevelWarn  = "warn"
	LogLevelError = "error"
)

Types

type Logger

type Logger interface {
	Debug(msg string, keyVals ...interface{})
	Info(msg string, keyVals ...interface{})
	Error(msg string, keyVals ...interface{})

	With(keyVals ...interface{}) Logger
}

Logger defines a generic logging interface compatible with Tendermint.

func MustNewDefaultLogger

func MustNewDefaultLogger(format, level string, trace bool) Logger

MustNewDefaultLogger delegates a call NewDefaultLogger where it panics on error.

func NewDefaultLogger

func NewDefaultLogger(format, level string, trace bool) (Logger, error)

NewDefaultLogger returns a default logger that can be used within Tendermint and that fulfills the Logger interface. The underlying logging provider is a zerolog logger that supports typical log levels along with JSON and plain/text log formats.

Since zerolog supports typed structured logging and it is difficult to reflect that in a generic interface, all logging methods accept a series of key/value pair tuples, where the key must be a string.

func NewNopLogger

func NewNopLogger() Logger

func TestingLogger

func TestingLogger() Logger

TestingLogger returns a Logger which writes to STDOUT if test(s) are being run with the verbose (-v) flag, NopLogger otherwise.

NOTE: - A call to NewTestingLogger() must be made inside a test (not in the init func) because verbose flag only set at the time of testing.

func TestingLoggerWithOutput

func TestingLoggerWithOutput(w io.Writer) Logger