Documentation
¶
Overview ¶
Package log is a generated GoMock package.
Index ¶
Constants ¶
const DebugLevel = apexLog.DebugLevel
DebugLevel is appropriate for messages intended for the developers of exodus-rsync to diagnose issues.
const InfoLevel = apexLog.InfoLevel
InfoLevel is appropriate for messages which should be visible by default to users of exodus-rsync.
const WarnLevel = apexLog.WarnLevel
WarnLevel is appropriate for messages which might indicate a problem.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ConfigProvider ¶ added in v0.2.0
type ConfigProvider interface {
// Minimum log level.
LogLevel() string
// "journald" or "syslog" to force specific logging backend.
Logger() string
}
ConfigProvider is an interface for any kind of object able to provide logger configuration.
type Interface ¶
type Interface interface {
// NewLogger will construct and return a logger appropriately configured to
// serve as the primary logger throughout exodus-rsync.
NewLogger(args.Config) *Logger
}
Interface defines the public interface of this package.
var Package Interface = impl{}
Package provides the default implementation of this package's interface.
type Logger ¶
Logger wraps an apex logger with additional utilities.
func FromContext ¶
FromContext returns the logger within a context previously created via NewContext, or nil if unset.
Throughout exodus-gw, this should be the primary method of obtaining a logger.
func (*Logger) F ¶
F is shorthand for creating a log entry with multiple fields.
This code:
logger.F("a", a, "b", b, "c", c).Info(...)
...is equivalent to the following more cumbersome:
logger.WithField("a", a).WithField("b", b).WithField("c", c).Info(...)
...or:
logger.WithFields(log.Fields{"a", a, "b", b, "c", c}).Info(...)
func (*Logger) Log ¶ added in v1.2.0
func (l *Logger) Log(v ...interface{})
Log is intended for use by the AWS SDK logger and is necessary for compatiblity with said package. Will log messages at debug level.
func (*Logger) StartPlatformLogger ¶ added in v0.2.0
func (l *Logger) StartPlatformLogger(cfg ConfigProvider)
StartPlatformLogger will enable (or not) the platform native logging, such as journald or syslog, according to the config.
type MockConfigProvider ¶ added in v0.2.0
type MockConfigProvider struct {
// contains filtered or unexported fields
}
MockConfigProvider is a mock of ConfigProvider interface.
func NewMockConfigProvider ¶ added in v0.2.0
func NewMockConfigProvider(ctrl *gomock.Controller) *MockConfigProvider
NewMockConfigProvider creates a new mock instance.
func (*MockConfigProvider) EXPECT ¶ added in v0.2.0
func (m *MockConfigProvider) EXPECT() *MockConfigProviderMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
func (*MockConfigProvider) LogLevel ¶ added in v0.2.0
func (m *MockConfigProvider) LogLevel() string
LogLevel mocks base method.
func (*MockConfigProvider) Logger ¶ added in v0.2.0
func (m *MockConfigProvider) Logger() string
Logger mocks base method.
type MockConfigProviderMockRecorder ¶ added in v0.2.0
type MockConfigProviderMockRecorder struct {
// contains filtered or unexported fields
}
MockConfigProviderMockRecorder is the mock recorder for MockConfigProvider.
func (*MockConfigProviderMockRecorder) LogLevel ¶ added in v0.2.0
func (mr *MockConfigProviderMockRecorder) LogLevel() *gomock.Call
LogLevel indicates an expected call of LogLevel.
func (*MockConfigProviderMockRecorder) Logger ¶ added in v0.2.0
func (mr *MockConfigProviderMockRecorder) Logger() *gomock.Call
Logger indicates an expected call of Logger.
type MockInterface ¶
type MockInterface struct {
// contains filtered or unexported fields
}
MockInterface is a mock of Interface interface.
func NewMockInterface ¶
func NewMockInterface(ctrl *gomock.Controller) *MockInterface
NewMockInterface creates a new mock instance.
func (*MockInterface) EXPECT ¶
func (m *MockInterface) EXPECT() *MockInterfaceMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
type MockInterfaceMockRecorder ¶
type MockInterfaceMockRecorder struct {
// contains filtered or unexported fields
}
MockInterfaceMockRecorder is the mock recorder for MockInterface.
func (*MockInterfaceMockRecorder) NewLogger ¶
func (mr *MockInterfaceMockRecorder) NewLogger(arg0 interface{}) *gomock.Call
NewLogger indicates an expected call of NewLogger.
Source Files