log

Documentation

Overview

Package ssmlog is used to initialize ssm functional logger

Package log is used to initialize the logger. This package should be imported once, usually from main, then call GetLogger.

Package log is used to initialize the logger. This package should be imported once.

Index

• Constants
• Variables
• func DefaultConfig() []byte
• func GetLogConfigBytes() []byte
• func GetLogger(log T, seelogConfig string) (logger seelog.LoggerInterface)
• func LoadLog(defaultLogDir string, logFile string) []byte
• func PrintCWConfig(jsonConfig string, log T) string
• type BasicT
• type ContextFormatFilter
  • func (f ContextFormatFilter) Filter(params ...interface{}) (newParams []interface{})
  • func (f ContextFormatFilter) Filterf(format string, params ...interface{}) (newFormat string, newParams []interface{})
• type DelegateLogger
• type FormatFilter
• type Mock
  • func NewMockLog() *Mock
  • func NewMockLogWithContext(ctx string) *Mock
  • func (_m *Mock) Close()
  • func (_m *Mock) Critical(v ...interface{}) error
  • func (_m *Mock) Criticalf(format string, params ...interface{}) error
  • func (_m *Mock) Debug(v ...interface{})
  • func (_m *Mock) Debugf(format string, params ...interface{})
  • func (_m *Mock) Error(v ...interface{}) error
  • func (_m *Mock) Errorf(format string, params ...interface{}) error
  • func (_m *Mock) Flush()
  • func (_m *Mock) Info(v ...interface{})
  • func (_m *Mock) Infof(format string, params ...interface{})
  • func (_m *Mock) Trace(v ...interface{})
  • func (_m *Mock) Tracef(format string, params ...interface{})
  • func (_m *Mock) Warn(v ...interface{}) error
  • func (_m *Mock) Warnf(format string, params ...interface{}) error
  • func (_m *Mock) WithContext(context ...string) (contextLogger T)
• type T
  • func DefaultLogger() T
• type Wrapper
  • func (w *Wrapper) Close()
  • func (w *Wrapper) Critical(v ...interface{}) error
  • func (w *Wrapper) Criticalf(format string, params ...interface{}) error
  • func (w *Wrapper) Debug(v ...interface{})
  • func (w *Wrapper) Debugf(format string, params ...interface{})
  • func (w *Wrapper) Error(v ...interface{}) error
  • func (w *Wrapper) Errorf(format string, params ...interface{}) error
  • func (w *Wrapper) Flush()
  • func (w *Wrapper) Info(v ...interface{})
  • func (w *Wrapper) Infof(format string, params ...interface{})
  • func (w *Wrapper) ReplaceDelegate(newLogger BasicT)
  • func (w *Wrapper) Trace(v ...interface{})
  • func (w *Wrapper) Tracef(format string, params ...interface{})
  • func (w *Wrapper) Warn(v ...interface{}) error
  • func (w *Wrapper) Warnf(format string, params ...interface{}) error
  • func (w *Wrapper) WithContext(context ...string) (contextLogger T)

Constants

const (
	LogFile   = "amazon-ssm-agent.log"
	ErrorFile = "errors.log"
)

const (
	// DefaultSeelogConfigFilePath specifies the default seelog location
	// The underlying logger is based of https://github.com/cihub/seelog
	// See Seelog documentation to customize the logger
	DefaultSeelogConfigFilePath = "/etc/amazon/ssm/seelog.xml"

	DefaultLogDir = "/var/log/amazon/ssm"
)

Variables

var PkgMutex = new(sync.Mutex)

Functions

func DefaultConfig

func DefaultConfig() []byte

func GetLogConfigBytes

func GetLogConfigBytes() []byte

func GetLogger

func GetLogger(log T, seelogConfig string) (logger seelog.LoggerInterface)

GetLogger creates a new logger with the provided config and returns it

func LoadLog

func LoadLog(defaultLogDir string, logFile string) []byte

func PrintCWConfig

func PrintCWConfig(jsonConfig string, log T) string

PrintCWConfig checks if the config file has credentials and returns a string with the credentials removed, for printing

Types

type BasicT

type BasicT interface {
	// Tracef formats message according to format specifier
	// and writes to log with level Trace.
	Tracef(format string, params ...interface{})

	// Debugf formats message according to format specifier
	// and writes to log with level Debug.
	Debugf(format string, params ...interface{})

	// Infof formats message according to format specifier
	// and writes to log with level Info.
	Infof(format string, params ...interface{})

	// Warnf formats message according to format specifier
	// and writes to log with level Warn.
	Warnf(format string, params ...interface{}) error

	// Errorf formats message according to format specifier
	// and writes to log with level Error.
	Errorf(format string, params ...interface{}) error

	// Criticalf formats message according to format specifier
	// and writes to log with level Critical.
	Criticalf(format string, params ...interface{}) error

	// Trace formats message using the default formats for its operands
	// and writes to log with level Trace.
	Trace(v ...interface{})

	// Debug formats message using the default formats for its operands
	// and writes to log with level Debug.
	Debug(v ...interface{})

	// Info formats message using the default formats for its operands
	// and writes to log with level Info.
	Info(v ...interface{})

	// Warn formats message using the default formats for its operands
	// and writes to log with level Warn.
	Warn(v ...interface{}) error

	// Error formats message using the default formats for its operands
	// and writes to log with level Error.
	Error(v ...interface{}) error

	// Critical formats message using the default formats for its operands
	// and writes to log with level Critical.
	Critical(v ...interface{}) error

	// Flush flushes all the messages in the logger.
	Flush()

	// Close flushes all the messages in the logger and closes it. The logger cannot be used after this operation.
	Close()
}

BasicT represents structs capable of logging messages. This interface matches seelog.LoggerInterface.

type ContextFormatFilter

type ContextFormatFilter struct {
	Context []string
}

ContextFormatFilter is a filter that can add a context to the parameters of a log message.

func (ContextFormatFilter) Filter

func (f ContextFormatFilter) Filter(params ...interface{}) (newParams []interface{})

Filter adds the context at the beginning of the parameter slice.

func (ContextFormatFilter) Filterf

func (f ContextFormatFilter) Filterf(format string, params ...interface{}) (newFormat string, newParams []interface{})

Filterf adds the context in from of the format string.

type DelegateLogger

type DelegateLogger struct {
	BaseLoggerInstance BasicT
}

DelegateLogger holds the base logger for logging

type FormatFilter

type FormatFilter interface {

	// Filter modifies parameters that will be passed to log.Debug, log.Info, etc.
	Filter(params ...interface{}) (newParams []interface{})

	// Filter modifies format and/or parameter strings that will be passed to log.Debugf, log.Infof, etc.
	Filterf(format string, params ...interface{}) (newFormat string, newParams []interface{})
}

FormatFilter can modify the format and or parameters to be passed to a logger.

type Mock

type Mock struct {
	mock.Mock
	// contains filtered or unexported fields
}

Mock stands for a mocked log.

func NewMockLog

func NewMockLog() *Mock

NewMockLogger returns an instance of Mock with default expectations set.

func NewMockLogWithContext

func NewMockLogWithContext(ctx string) *Mock

func (*Mock) Close

func (_m *Mock) Close()

Close mocks the Close function.

func (*Mock) Critical

func (_m *Mock) Critical(v ...interface{}) error

Critical mocks the Critical function.

func (*Mock) Criticalf

func (_m *Mock) Criticalf(format string, params ...interface{}) error

Criticalf mocks the Criticalf function.

func (*Mock) Debug

func (_m *Mock) Debug(v ...interface{})

Debug mocks the Debug function.

func (*Mock) Debugf

func (_m *Mock) Debugf(format string, params ...interface{})

Debugf mocks the Debugf function.

func (*Mock) Error

func (_m *Mock) Error(v ...interface{}) error

Error mocks the Error function.

func (*Mock) Errorf

func (_m *Mock) Errorf(format string, params ...interface{}) error

Errorf mocks the Errorf function.

func (*Mock) Flush

func (_m *Mock) Flush()

Flush mocks the Flush function.

func (*Mock) Info

func (_m *Mock) Info(v ...interface{})

Info mocks the Info function.

func (*Mock) Infof

func (_m *Mock) Infof(format string, params ...interface{})

Infof mocks the Infof function.

func (*Mock) Trace

func (_m *Mock) Trace(v ...interface{})

Trace mocks the Trace function.

func (*Mock) Tracef

func (_m *Mock) Tracef(format string, params ...interface{})

Tracef mocks the Tracef function.

func (*Mock) Warn

func (_m *Mock) Warn(v ...interface{}) error

Warn mocks the Warn function.

func (*Mock) Warnf

func (_m *Mock) Warnf(format string, params ...interface{}) error

Warnf mocks the Warnf function.

func (*Mock) WithContext

func (_m *Mock) WithContext(context ...string) (contextLogger T)

type T

type T interface {
	BasicT
	WithContext(context ...string) (contextLogger T)
}

T represents structs capable of logging messages, and context management.

func DefaultLogger

func DefaultLogger() T

type Wrapper

type Wrapper struct {
	Format   FormatFilter
	M        *sync.Mutex
	Delegate *DelegateLogger
}

Wrapper is a logger that can modify the format of a log message before delegating to another logger.

func (*Wrapper) Close

func (w *Wrapper) Close()

Close flushes all the messages in the logger and closes it. It cannot be used after this operation.

func (*Wrapper) Critical

func (w *Wrapper) Critical(v ...interface{}) error

Critical formats message using the default formats for its operands and writes to log with level = Critical

func (*Wrapper) Criticalf

func (w *Wrapper) Criticalf(format string, params ...interface{}) error

Criticalf formats message according to format specifier and writes to log with level = Critical.

func (*Wrapper) Debug

func (w *Wrapper) Debug(v ...interface{})

Debug formats message using the default formats for its operands and writes to log with level = Debug

func (*Wrapper) Debugf

func (w *Wrapper) Debugf(format string, params ...interface{})

Debugf formats message according to format specifier and writes to log with level = Debug.

func (*Wrapper) Error

func (w *Wrapper) Error(v ...interface{}) error

Error formats message using the default formats for its operands and writes to log with level = Error

func (*Wrapper) Errorf

func (w *Wrapper) Errorf(format string, params ...interface{}) error

Errorf formats message according to format specifier and writes to log with level = Error.

func (*Wrapper) Flush

func (w *Wrapper) Flush()

Flush flushes all the messages in the logger.

func (*Wrapper) Info

func (w *Wrapper) Info(v ...interface{})

Info formats message using the default formats for its operands and writes to log with level = Info

func (*Wrapper) Infof

func (w *Wrapper) Infof(format string, params ...interface{})

Infof formats message according to format specifier and writes to log with level = Info.

func (*Wrapper) ReplaceDelegate

func (w *Wrapper) ReplaceDelegate(newLogger BasicT)

ReplaceDelegate replaces the delegate logger with a new logger

func (*Wrapper) Trace

func (w *Wrapper) Trace(v ...interface{})

Trace formats message using the default formats for its operands and writes to log with level = Trace

func (*Wrapper) Tracef

func (w *Wrapper) Tracef(format string, params ...interface{})

Tracef formats message according to format specifier and writes to log with level = Trace.

func (*Wrapper) Warn

func (w *Wrapper) Warn(v ...interface{}) error

Warn formats message using the default formats for its operands and writes to log with level = Warn

func (*Wrapper) Warnf

func (w *Wrapper) Warnf(format string, params ...interface{}) error

Warnf formats message according to format specifier and writes to log with level = Warn.

func (*Wrapper) WithContext

func (w *Wrapper) WithContext(context ...string) (contextLogger T)

WithContext creates a wrapper logger with context