logging

package
v1.7.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 18, 2022 License: BSD-3-Clause Imports: 15 Imported by: 11

Documentation

Overview

Package logging is a generated GoMock package.

Index

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{}
)

Functions

func Sanitize

func Sanitize(s string) string

func SanitizeArgs

func SanitizeArgs(a []interface{}) []interface{}

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

func (Color) Wrap

func (lc Color) Wrap(text string) string

type Config

type Config struct {
	RotatingWriterConfig
	DisableWriterDisplaying bool   `json:"disableWriterDisplaying"`
	Assertions              bool   `json:"assertions"`
	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

func NewFactory(config Config) Factory

NewFactory returns a new instance of a Factory producing loggers configured with the values set in the [config] parameter

type Format added in v1.7.11

type Format int

Highlight mode to apply to displayed logs

const (
	Plain Format = iota
	Colors
	JSON
)

Format modes available

func ToFormat added in v1.7.11

func ToFormat(h string, fd uintptr) (Format, error)

ToFormat chooses a highlighting mode

func (Format) ConsoleEncoder added in v1.7.11

func (f Format) ConsoleEncoder() zapcore.Encoder

func (Format) FileEncoder added in v1.7.11

func (f Format) FileEncoder() zapcore.Encoder

func (Format) MarshalJSON added in v1.7.11

func (f Format) MarshalJSON() ([]byte, error)

func (Format) WrapPrefix added in v1.7.11

func (f Format) WrapPrefix(prefix string) string

type Level

type Level zapcore.Level
const (
	Verbo Level = iota - 9
	Debug
	Trace
	Info
	Warn
	Error
	Fatal
	Off
)

func ToLevel

func ToLevel(l string) (Level, error)

Inverse of Level.String()

func (Level) LowerString added in v1.7.11

func (l Level) LowerString() string

func (Level) MarshalJSON

func (l Level) MarshalJSON() ([]byte, error)

func (Level) String

func (l Level) String() string

func (*Level) UnmarshalJSON

func (l *Level) UnmarshalJSON(b []byte) error

type Logger

type Logger interface {
	io.Writer // For logging pre-formated messages

	// Log that a fatal error has occurred. The program should likely exit soon
	// after this is called
	Fatal(format string, args ...interface{})
	// Log that an error has occurred. The program should be able to recover
	// from this error
	Error(format string, args ...interface{})
	// Log that an event has occurred that may indicate a future error or
	// vulnerability
	Warn(format string, args ...interface{})
	// Log an event that may be useful for a user to see to measure the progress
	// of the protocol
	Info(format string, args ...interface{})
	// Log an event that may be useful for understanding the order of the
	// execution of the protocol
	Trace(format string, args ...interface{})
	// Log an event that may be useful for a programmer to see when debuging the
	// execution of the protocol
	Debug(format string, args ...interface{})
	// Log extremely detailed events that can be useful for inspecting every
	// aspect of the program
	Verbo(format string, args ...interface{})

	// If assertions are enabled, will result in a panic if err is non-nil
	AssertNoError(err error)
	// If assertions are enabled, will result in a panic if b is false
	AssertTrue(b bool, format string, args ...interface{})
	// If assertions are enabled, the function will be called and will result in
	// a panic the returned value is non-nil
	AssertDeferredNoError(f func() error)
	// If assertions are enabled, the function will be called and will result in
	//  a panic the returned value is false
	AssertDeferredTrue(f func() bool, format string, args ...interface{})

	// 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 added in v1.7.11

func NewLogger(assertionsEnabled bool, prefix string, wrappedCores ...WrappedCore) Logger

New returns a new logger set up according to [config]

type MockLogger

type MockLogger struct {
	// contains filtered or unexported fields
}

MockLogger is a mock of Logger interface.

func NewMockLogger

func NewMockLogger(ctrl *gomock.Controller) *MockLogger

NewMockLogger creates a new mock instance.

func (*MockLogger) AssertDeferredNoError

func (m *MockLogger) AssertDeferredNoError(f func() error)

AssertDeferredNoError mocks base method.

func (*MockLogger) AssertDeferredTrue

func (m *MockLogger) AssertDeferredTrue(f func() bool, format string, args ...interface{})

AssertDeferredTrue mocks base method.

func (*MockLogger) AssertNoError

func (m *MockLogger) AssertNoError(err error)

AssertNoError mocks base method.

func (*MockLogger) AssertTrue

func (m *MockLogger) AssertTrue(b bool, format string, args ...interface{})

AssertTrue mocks base method.

func (*MockLogger) Debug

func (m *MockLogger) Debug(format string, args ...interface{})

Debug mocks base method.

func (*MockLogger) EXPECT

func (m *MockLogger) EXPECT() *MockLoggerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockLogger) Error

func (m *MockLogger) Error(format string, args ...interface{})

Error mocks base method.

func (*MockLogger) Fatal

func (m *MockLogger) Fatal(format string, args ...interface{})

Fatal mocks base method.

func (*MockLogger) GetDisplayLevel

func (m *MockLogger) GetDisplayLevel() Level

GetDisplayLevel mocks base method.

func (*MockLogger) GetLogLevel

func (m *MockLogger) GetLogLevel() Level

GetLogLevel mocks base method.

func (*MockLogger) Info

func (m *MockLogger) Info(format string, args ...interface{})

Info mocks base method.

func (*MockLogger) RecoverAndExit

func (m *MockLogger) RecoverAndExit(f, exit func())

RecoverAndExit mocks base method.

func (*MockLogger) RecoverAndPanic

func (m *MockLogger) RecoverAndPanic(f func())

RecoverAndPanic mocks base method.

func (*MockLogger) SetContextualDisplayingEnabled

func (m *MockLogger) SetContextualDisplayingEnabled(arg0 bool)

SetContextualDisplayingEnabled mocks base method.

func (*MockLogger) SetDisplayLevel

func (m *MockLogger) SetDisplayLevel(arg0 Level)

SetDisplayLevel mocks base method.

func (*MockLogger) SetLogLevel

func (m *MockLogger) SetLogLevel(arg0 Level)

SetLogLevel mocks base method.

func (*MockLogger) SetPrefix

func (m *MockLogger) SetPrefix(arg0 string)

SetPrefix mocks base method.

func (*MockLogger) Stop

func (m *MockLogger) Stop()

Stop mocks base method.

func (*MockLogger) StopOnPanic

func (m *MockLogger) StopOnPanic()

StopOnPanic mocks base method.

func (*MockLogger) Trace

func (m *MockLogger) Trace(format string, args ...interface{})

Trace mocks base method.

func (*MockLogger) Verbo

func (m *MockLogger) Verbo(format string, args ...interface{})

Verbo mocks base method.

func (*MockLogger) Warn

func (m *MockLogger) Warn(format string, args ...interface{})

Warn mocks base method.

func (*MockLogger) Write

func (m *MockLogger) Write(p []byte) (int, error)

Write mocks base method.

type MockLoggerMockRecorder

type MockLoggerMockRecorder struct {
	// contains filtered or unexported fields
}

MockLoggerMockRecorder is the mock recorder for MockLogger.

func (*MockLoggerMockRecorder) AssertDeferredNoError

func (mr *MockLoggerMockRecorder) AssertDeferredNoError(f interface{}) *gomock.Call

AssertDeferredNoError indicates an expected call of AssertDeferredNoError.

func (*MockLoggerMockRecorder) AssertDeferredTrue

func (mr *MockLoggerMockRecorder) AssertDeferredTrue(f, format interface{}, args ...interface{}) *gomock.Call

AssertDeferredTrue indicates an expected call of AssertDeferredTrue.

func (*MockLoggerMockRecorder) AssertNoError

func (mr *MockLoggerMockRecorder) AssertNoError(err interface{}) *gomock.Call

AssertNoError indicates an expected call of AssertNoError.

func (*MockLoggerMockRecorder) AssertTrue

func (mr *MockLoggerMockRecorder) AssertTrue(b, format interface{}, args ...interface{}) *gomock.Call

AssertTrue indicates an expected call of AssertTrue.

func (*MockLoggerMockRecorder) Debug

func (mr *MockLoggerMockRecorder) Debug(format interface{}, args ...interface{}) *gomock.Call

Debug indicates an expected call of Debug.

func (*MockLoggerMockRecorder) Error

func (mr *MockLoggerMockRecorder) Error(format interface{}, args ...interface{}) *gomock.Call

Error indicates an expected call of Error.

func (*MockLoggerMockRecorder) Fatal

func (mr *MockLoggerMockRecorder) Fatal(format interface{}, args ...interface{}) *gomock.Call

Fatal indicates an expected call of Fatal.

func (*MockLoggerMockRecorder) GetDisplayLevel

func (mr *MockLoggerMockRecorder) GetDisplayLevel() *gomock.Call

GetDisplayLevel indicates an expected call of GetDisplayLevel.

func (*MockLoggerMockRecorder) GetLogLevel

func (mr *MockLoggerMockRecorder) GetLogLevel() *gomock.Call

GetLogLevel indicates an expected call of GetLogLevel.

func (*MockLoggerMockRecorder) Info

func (mr *MockLoggerMockRecorder) Info(format interface{}, args ...interface{}) *gomock.Call

Info indicates an expected call of Info.

func (*MockLoggerMockRecorder) RecoverAndExit

func (mr *MockLoggerMockRecorder) RecoverAndExit(f, exit interface{}) *gomock.Call

RecoverAndExit indicates an expected call of RecoverAndExit.

func (*MockLoggerMockRecorder) RecoverAndPanic

func (mr *MockLoggerMockRecorder) RecoverAndPanic(f interface{}) *gomock.Call

RecoverAndPanic indicates an expected call of RecoverAndPanic.

func (*MockLoggerMockRecorder) SetContextualDisplayingEnabled

func (mr *MockLoggerMockRecorder) SetContextualDisplayingEnabled(arg0 interface{}) *gomock.Call

SetContextualDisplayingEnabled indicates an expected call of SetContextualDisplayingEnabled.

func (*MockLoggerMockRecorder) SetDisplayLevel

func (mr *MockLoggerMockRecorder) SetDisplayLevel(arg0 interface{}) *gomock.Call

SetDisplayLevel indicates an expected call of SetDisplayLevel.

func (*MockLoggerMockRecorder) SetLogLevel

func (mr *MockLoggerMockRecorder) SetLogLevel(arg0 interface{}) *gomock.Call

SetLogLevel indicates an expected call of SetLogLevel.

func (*MockLoggerMockRecorder) SetPrefix

func (mr *MockLoggerMockRecorder) SetPrefix(arg0 interface{}) *gomock.Call

SetPrefix indicates an expected call of SetPrefix.

func (*MockLoggerMockRecorder) Stop

func (mr *MockLoggerMockRecorder) Stop() *gomock.Call

Stop indicates an expected call of Stop.

func (*MockLoggerMockRecorder) StopOnPanic

func (mr *MockLoggerMockRecorder) StopOnPanic() *gomock.Call

StopOnPanic indicates an expected call of StopOnPanic.

func (*MockLoggerMockRecorder) Trace

func (mr *MockLoggerMockRecorder) Trace(format interface{}, args ...interface{}) *gomock.Call

Trace indicates an expected call of Trace.

func (*MockLoggerMockRecorder) Verbo

func (mr *MockLoggerMockRecorder) Verbo(format interface{}, args ...interface{}) *gomock.Call

Verbo indicates an expected call of Verbo.

func (*MockLoggerMockRecorder) Warn

func (mr *MockLoggerMockRecorder) Warn(format interface{}, args ...interface{}) *gomock.Call

Warn indicates an expected call of Warn.

func (*MockLoggerMockRecorder) Write

func (mr *MockLoggerMockRecorder) Write(p interface{}) *gomock.Call

Write indicates an expected call of Write.

type MockRotatingWriter

type MockRotatingWriter struct {
	// contains filtered or unexported fields
}

MockRotatingWriter is a mock of RotatingWriter interface.

func NewMockRotatingWriter

func NewMockRotatingWriter(ctrl *gomock.Controller) *MockRotatingWriter

NewMockRotatingWriter creates a new mock instance.

func (*MockRotatingWriter) Close

func (m *MockRotatingWriter) Close() error

Close mocks base method.

func (*MockRotatingWriter) EXPECT

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockRotatingWriter) Flush

func (m *MockRotatingWriter) Flush() error

Flush mocks base method.

func (*MockRotatingWriter) Initialize

func (m *MockRotatingWriter) Initialize(arg0 Config) (int, error)

Initialize mocks base method.

func (*MockRotatingWriter) Rotate

func (m *MockRotatingWriter) Rotate() error

Rotate mocks base method.

func (*MockRotatingWriter) Write

func (m *MockRotatingWriter) Write(b []byte) (int, error)

Write mocks base method.

func (*MockRotatingWriter) WriteString

func (m *MockRotatingWriter) WriteString(s string) (int, error)

WriteString mocks base method.

type MockRotatingWriterMockRecorder

type MockRotatingWriterMockRecorder struct {
	// contains filtered or unexported fields
}

MockRotatingWriterMockRecorder is the mock recorder for MockRotatingWriter.

func (*MockRotatingWriterMockRecorder) Close

Close indicates an expected call of Close.

func (*MockRotatingWriterMockRecorder) Flush

Flush indicates an expected call of Flush.

func (*MockRotatingWriterMockRecorder) Initialize

func (mr *MockRotatingWriterMockRecorder) Initialize(arg0 interface{}) *gomock.Call

Initialize indicates an expected call of Initialize.

func (*MockRotatingWriterMockRecorder) Rotate

Rotate indicates an expected call of Rotate.

func (*MockRotatingWriterMockRecorder) Write

func (mr *MockRotatingWriterMockRecorder) Write(b interface{}) *gomock.Call

Write indicates an expected call of Write.

func (*MockRotatingWriterMockRecorder) WriteString

func (mr *MockRotatingWriterMockRecorder) WriteString(s interface{}) *gomock.Call

WriteString indicates an expected call of WriteString.

type NoLog

type NoLog struct{}

func (NoLog) AssertDeferredNoError

func (NoLog) AssertDeferredNoError(f func() error)

func (NoLog) AssertDeferredTrue

func (NoLog) AssertDeferredTrue(f func() bool, format string, args ...interface{})

func (NoLog) AssertNoError

func (NoLog) AssertNoError(error)

func (NoLog) AssertTrue

func (NoLog) AssertTrue(b bool, format string, args ...interface{})

func (NoLog) Debug

func (NoLog) Debug(format string, args ...interface{})

func (NoLog) Error

func (NoLog) Error(format string, args ...interface{})

func (NoLog) Fatal

func (NoLog) Fatal(format string, args ...interface{})

func (NoLog) Info

func (NoLog) Info(format string, args ...interface{})

func (NoLog) RecoverAndExit

func (NoLog) RecoverAndExit(f, exit func())

func (NoLog) RecoverAndPanic

func (NoLog) RecoverAndPanic(f func())

func (NoLog) Stop

func (NoLog) Stop()

func (NoLog) StopOnPanic

func (NoLog) StopOnPanic()

func (NoLog) Trace

func (NoLog) Trace(format string, args ...interface{})

func (NoLog) Verbo

func (NoLog) Verbo(format string, args ...interface{})

func (NoLog) Warn

func (NoLog) Warn(format string, args ...interface{})

func (NoLog) Write

func (NoLog) Write([]byte) (int, error)

type RotatingWriterConfig added in v1.7.11

type RotatingWriterConfig struct {
	MaxSize   int    `json:"maxSize"` // in megabytes
	MaxFiles  int    `json:"maxFiles"`
	MaxAge    int    `json:"maxAge"` // in days
	Directory string `json:"directory"`
	Compress  bool   `json:"compress"`
}

type Stacktrace

type Stacktrace struct {
	Global bool
}

Stacktrace can print the current stacktrace

func (Stacktrace) String

func (st Stacktrace) String() string

type WrappedCore added in v1.7.11

type WrappedCore struct {
	Core           zapcore.Core
	Writer         io.WriteCloser
	WriterDisabled bool
	AtomicLevel    zap.AtomicLevel
}

func NewWrappedCore added in v1.7.11

func NewWrappedCore(level Level, rw io.WriteCloser, encoder zapcore.Encoder) WrappedCore

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL