README
¶
Logging
Structured logging interface and providers.
Interface
The interface was intensionally reduced to only 2 methods (log, error) to reduce possibility of unintentional different log messages.
All methods receive context.Context as first parameter, a string message (so we can have a value to group) and a map of strings for building the log.
Usage
ctx := context.TODO()
l := NewMockLogger()
l.Log(
ctx,
"Main log message",
map[string]string{
"some": "key",
"value": "params"
},
)
For this code, the expected generated log is:
{ "level": "info/error", "msg": "Main log message", "some": "key", "value": "params" }
Where
"level": "debug" is the log level
"msg": "Main log message" main string message
"some": "key", "value": "params" map parameters
Usage with Transaction Context
ctx := context.TODO()
id, _ := uuid.NewUUID()
ctx = tctx.CreateTransactionContext(ctx, id, time.Now())
l := NewMockLogger()
l.Log(
ctx,
"Main log message",
map[string]string{
"some": "key",
"value": "params"
},
)
For this code, the expected generated log is:
{ "level": "info/error", "msg": "Main log message", "tid": "65345fc5-8468-4709-a21f-fcd30d9eb08f", "tms": {unix nano}, "some": "key", "value": "params" }
Where
"level": "info/error" is the log level
"msg": "Main log message" main string message
"tid": "65345fc5-8468-4709-a21f-fcd30d9eb08f" ExecutionContext transaction id
"tms": "{unix nano}" transaction started at ms
"some": "key", "value": "params" map parameters
Supported providers
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContextLogger ¶
type ContextLogger struct {
// contains filtered or unexported fields
}
func NewContextLogger ¶
func NewContextLogger(l Logger) *ContextLogger
type ContextLoggerMiddleware ¶
type ContextLoggerMiddleware struct {
// contains filtered or unexported fields
}
func NewContextLoggerMiddleware ¶
func NewContextLoggerMiddleware(l *ContextLogger) *ContextLoggerMiddleware
type LoggerConfig ¶
type MockLogger ¶
type MockLogger struct {
// contains filtered or unexported fields
}
func NewMockLogger ¶
func NewMockLogger() *MockLogger
func (*MockLogger) Error ¶
func (l *MockLogger) Error(msg string, params map[string]interface{})
func (*MockLogger) Log ¶
func (l *MockLogger) Log(msg string, params map[string]interface{})
func (*MockLogger) String ¶
func (l *MockLogger) String() string
type ZapLogger ¶
type ZapLogger struct {
// contains filtered or unexported fields
}
func NewZapLogger ¶
func NewZapLogger(cfgs []LoggerConfig) *ZapLogger
Source Files