Documentation
¶
Index ¶
- Variables
- func UserString(key, val string) zap.Field
- func UserStrings(key string, val []string) zap.Field
- type Color
- type Config
- type Factory
- type Format
- type Level
- type Logger
- type NoLog
- func (NoLog) Debug(string, ...zap.Field)
- func (NoLog) Enabled(Level) bool
- func (NoLog) Error(string, ...zap.Field)
- func (NoLog) Fatal(string, ...zap.Field)
- func (NoLog) Info(string, ...zap.Field)
- func (NoLog) RecoverAndExit(f, exit func())
- func (NoLog) RecoverAndPanic(f func())
- func (NoLog) SetLevel(Level)
- func (NoLog) Stop()
- func (NoLog) StopOnPanic()
- func (NoLog) Trace(string, ...zap.Field)
- func (NoLog) Verbo(string, ...zap.Field)
- func (NoLog) Warn(string, ...zap.Field)
- func (NoLog) Write(b []byte) (int, error)
- type NoWarn
- type RotatingWriterConfig
- type WrappedCore
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Discard is a mock WriterCloser that drops all writes and close requests Discard io.WriteCloser = discard{} )
View Source
var ErrUnknownLevel = errors.New("unknown log level")
Functions ¶
func UserString ¶
UserString constructs a field with the given key and the value stripped of newlines. The value is sanitized lazily.
Types ¶
type Color ¶
type Color string
const ( Black Color = "\033[0;30m" DarkGray Color = "\033[1;30m" Red Color = "\033[0;31m" LightRed Color = "\033[1;31m" Green Color = "\033[0;32m" LightGreen Color = "\033[1;32m" Orange Color = "\033[0;33m" Yellow Color = "\033[1;33m" Blue Color = "\033[0;34m" LightBlue Color = "\033[1;34m" Purple Color = "\033[0;35m" LightPurple Color = "\033[1;35m" Cyan Color = "\033[0;36m" LightCyan Color = "\033[1;36m" LightGray Color = "\033[0;37m" White Color = "\033[1;37m" Reset Color = "\033[0;0m" Bold Color = "\033[;1m" Reverse Color = "\033[;7m" )
Colors
type Config ¶
type Config struct {
RotatingWriterConfig
DisableWriterDisplaying bool `json:"disableWriterDisplaying"`
LogLevel Level `json:"logLevel"`
DisplayLevel Level `json:"displayLevel"`
LogFormat Format `json:"logFormat"`
MsgPrefix string `json:"-"`
LoggerName string `json:"-"`
}
Config defines the configuration of a logger
type Factory ¶
type Factory interface {
// Make creates a new logger with name [name]
Make(name string) (Logger, error)
// MakeChain creates a new logger to log the events of chain [chainID]
MakeChain(chainID string) (Logger, error)
// SetLogLevels sets log levels for all loggers in factory with given logger name, level pairs.
SetLogLevel(name string, level Level) error
// SetDisplayLevels sets log display levels for all loggers in factory with given logger name, level pairs.
SetDisplayLevel(name string, level Level) error
// GetLogLevels returns all log levels in factory as name, level pairs
GetLogLevel(name string) (Level, error)
// GetDisplayLevels returns all log display levels in factory as name, level pairs
GetDisplayLevel(name string) (Level, error)
// GetLoggerNames returns the names of all logs created by this factory
GetLoggerNames() []string
// Close stops and clears all of a Factory's instantiated loggers
Close()
}
Factory creates new instances of different types of Logger
func NewFactory ¶
NewFactory returns a new instance of a Factory producing loggers configured with the values set in the [config] parameter
type Format ¶
type Format int
Highlight mode to apply to displayed logs
func (Format) ConsoleEncoder ¶
func (Format) FileEncoder ¶
func (Format) MarshalJSON ¶
func (Format) WrapPrefix ¶
type Logger ¶
type Logger interface {
io.Writer // For logging pre-formatted messages
// Log that a fatal error has occurred. The program should likely exit soon
// after this is called
Fatal(msg string, fields ...zap.Field)
// Log that an error has occurred. The program should be able to recover
// from this error
Error(msg string, fields ...zap.Field)
// Log that an event has occurred that may indicate a future error or
// vulnerability
Warn(msg string, fields ...zap.Field)
// Log an event that may be useful for a user to see to measure the progress
// of the protocol
Info(msg string, fields ...zap.Field)
// Log an event that may be useful for understanding the order of the
// execution of the protocol
Trace(msg string, fields ...zap.Field)
// Log an event that may be useful for a programmer to see when debuging the
// execution of the protocol
Debug(msg string, fields ...zap.Field)
// Log extremely detailed events that can be useful for inspecting every
// aspect of the program
Verbo(msg string, fields ...zap.Field)
// SetLevel that this logger should log to
SetLevel(level Level)
// Enabled returns true if the given level is at or above this level.
Enabled(lvl Level) bool
// Recovers a panic, logs the error, and rethrows the panic.
StopOnPanic()
// If a function panics, this will log that panic and then re-panic ensuring
// that the program logs the error before exiting.
RecoverAndPanic(f func())
// If a function panics, this will log that panic and then call the exit
// function, ensuring that the program logs the error, recovers, and
// executes the desired exit function
RecoverAndExit(f, exit func())
// Stop this logger and write back all meta-data.
Stop()
}
Logger defines the interface that is used to keep a record of all events that happen to the program
func NewLogger ¶
func NewLogger(prefix string, wrappedCores ...WrappedCore) Logger
New returns a new logger set up according to [config]
type NoLog ¶
type NoLog struct{}
func (NoLog) RecoverAndExit ¶
func (NoLog) RecoverAndExit(f, exit func())
func (NoLog) RecoverAndPanic ¶
func (NoLog) RecoverAndPanic(f func())
func (NoLog) StopOnPanic ¶
func (NoLog) StopOnPanic()
type RotatingWriterConfig ¶
type WrappedCore ¶
type WrappedCore struct {
Core zapcore.Core
Writer io.WriteCloser
WriterDisabled bool
AtomicLevel zap.AtomicLevel
}
func NewWrappedCore ¶
func NewWrappedCore(level Level, rw io.WriteCloser, encoder zapcore.Encoder) WrappedCore
Source Files
Click to show internal directories.
Click to hide internal directories.