The highest tagged major version is
Documentation
¶
Overview ¶
Package logging ... Handles logging within the SDK
Index ¶
- Constants
- func Level(level string) int
- func ObfuscateAPIKey(apikey string) string
- func ObfuscateHTTPHeader(headers http.Header) string
- type FileRotate
- type FileRotateOptions
- type LevelFilteredLoggerWrapper
- func (l *LevelFilteredLoggerWrapper) Debug(is ...interface{})
- func (l *LevelFilteredLoggerWrapper) Error(is ...interface{})
- func (l *LevelFilteredLoggerWrapper) Info(is ...interface{})
- func (l *LevelFilteredLoggerWrapper) Verbose(is ...interface{})
- func (l *LevelFilteredLoggerWrapper) Warning(is ...interface{})
- type Logger
- type LoggerInterface
- type LoggerOptions
Constants ¶
const ( // LevelError log level LevelError // LevelWarning log level LevelWarning // LevelInfo log level LevelInfo // LevelDebug log level LevelDebug // LevelVerbose log level LevelVerbose )
Standard values
const ( // LevelNone implies that NOTHING will be logged, not even errors LevelNone = math.MinInt32 // LevelAll implies that All logging levels will be recorded LevelAll = math.MaxInt32 )
Special values
Variables ¶
This section is empty.
Functions ¶
func ObfuscateAPIKey ¶
ObfuscateAPIKey obfucate part of api key
func ObfuscateHTTPHeader ¶
ObfuscateHTTPHeader obfuscates sensitive data into headers
Types ¶
type FileRotate ¶
type FileRotate struct {
// contains filtered or unexported fields
}
FileRotate rotates a log file at MaxBytes
func NewFileRotate ¶
func NewFileRotate(opt *FileRotateOptions) (*FileRotate, error)
NewFileRotate returns a pointer to a FileRotate instance
type FileRotateOptions ¶
FileRotateOptions struct to configure FileRotate
type LevelFilteredLoggerWrapper ¶
type LevelFilteredLoggerWrapper struct {
// contains filtered or unexported fields
}
LevelFilteredLoggerWrapper forwards log message to delegate if level is set higher than incoming message
func (*LevelFilteredLoggerWrapper) Debug ¶
func (l *LevelFilteredLoggerWrapper) Debug(is ...interface{})
Debug forwards debug logging messages
func (*LevelFilteredLoggerWrapper) Error ¶
func (l *LevelFilteredLoggerWrapper) Error(is ...interface{})
Error forwards error logging messages
func (*LevelFilteredLoggerWrapper) Info ¶
func (l *LevelFilteredLoggerWrapper) Info(is ...interface{})
Info forwards info logging messages
func (*LevelFilteredLoggerWrapper) Verbose ¶
func (l *LevelFilteredLoggerWrapper) Verbose(is ...interface{})
Verbose forwards verbose logging messages
func (*LevelFilteredLoggerWrapper) Warning ¶
func (l *LevelFilteredLoggerWrapper) Warning(is ...interface{})
Warning forwards warning logging messages
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger struct. Encapsulates four different loggers, each for a different "level", and provides Error, Debug, Warning and Info functions, that will forward a message to the appropriate logger.
func (*Logger) Debug ¶
func (l *Logger) Debug(msg ...interface{})
Debug logs a message with Debug level
func (*Logger) Error ¶
func (l *Logger) Error(msg ...interface{})
Error logs a message with Error level
type LoggerInterface ¶
type LoggerInterface interface {
Error(msg ...interface{})
Warning(msg ...interface{})
Info(msg ...interface{})
Debug(msg ...interface{})
Verbose(msg ...interface{})
}
LoggerInterface ... If a custom logger object is to be used, it should comply with the following interface. (Standard go-lang library log.Logger.Println method signature)
func NewLogger ¶
func NewLogger(options *LoggerOptions) LoggerInterface
NewLogger instantiates a new Logger instance. Requires a pointer to a LoggerOptions struct to be passed.
type LoggerOptions ¶
type LoggerOptions struct {
LogLevel int
ErrorWriter io.Writer
WarningWriter io.Writer
InfoWriter io.Writer
DebugWriter io.Writer
VerboseWriter io.Writer
StandardLoggerFlags int
Prefix string
ExtraFramesToSkip int
}
LoggerOptions ... Struct that must be passed to the NewLogger constructor to setup a logger CommonWriter and ErrorWriter can be <nil>. In that case they'll default to os.Stdout
Source Files