log

Documentation

Index

• type Config
• type Logger
  • func NewBlankLogger(dst io.Writer) Logger
  • func NewJSONLogger(dst io.Writer, runner string) Logger
  • func NewLogger(dst io.Writer, runner string) Logger
  • func NewWithCfg(dst io.Writer, runner string, cfg Config) Logger

Types

type Config

type Config struct {
	Format string
	Level  string
}

type Logger

type Logger interface {
	// Info takes a message and a set of key/value pairs and logs with level INFO.
	// The key of the tuple must be a string.
	Info(msg string, keyVals ...any)

	// Warn takes a message and a set of key/value pairs and logs with level WARN.
	// The key of the tuple must be a string.
	Warn(msg string, keyVals ...any)

	// Error takes a message and a set of key/value pairs and logs with level ERR.
	// The key of the tuple must be a string.
	Error(msg string, keyVals ...any)

	// Debug takes a message and a set of key/value pairs and logs with level DEBUG.
	// The key of the tuple must be a string.
	Debug(msg string, keyVals ...any)

	// With returns a new wrapped logger with additional context provided by a set
	With(keyVals ...any) Logger

	// Impl returns the underlying logger implementation
	// It is used to access the full functionalities of the underlying logger
	// Advanced users can type cast the returned value to the actual logger
	Impl() any
}

Logger is the interface for the logger. It's based on cosmossdk.io/log.

func NewBlankLogger

func NewBlankLogger(dst io.Writer) Logger

NewBlankLogger creates a new logger with the given writer. The logger is a wrapper around cosmossdk logger.

func NewJSONLogger

func NewJSONLogger(dst io.Writer, runner string) Logger

NewJsonLogger creates a new logger with the given writer and runner name. It sets the output of the logger to JSON.

func NewLogger

func NewLogger(dst io.Writer, runner string) Logger

NewLogger creates a new logger with the given writer and runner name. The logger is a wrapper around cosmossdk logger.

func NewWithCfg

func NewWithCfg(dst io.Writer, runner string, cfg Config) Logger