2020-11-02 13:25:29 +03:00
|
|
|
// Package logger provides a log interface
|
2024-07-06 00:09:27 +03:00
|
|
|
package logger
|
2020-02-07 05:35:46 +08:00
|
|
|
|
2021-08-27 18:55:08 +03:00
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
)
|
2021-01-10 18:56:39 +03:00
|
|
|
|
2024-03-04 23:58:31 +03:00
|
|
|
type ContextAttrFunc func(ctx context.Context) []interface{}
|
|
|
|
|
|
|
|
var DefaultContextAttrFuncs []ContextAttrFunc
|
|
|
|
|
2020-02-20 23:57:59 -08:00
|
|
|
var (
|
2020-11-02 13:25:29 +03:00
|
|
|
// DefaultLogger variable
|
2024-03-06 18:45:32 +03:00
|
|
|
DefaultLogger Logger = NewLogger()
|
2021-02-14 11:28:50 +03:00
|
|
|
// DefaultLevel used by logger
|
2022-05-03 14:38:44 +03:00
|
|
|
DefaultLevel = InfoLevel
|
2020-02-07 05:35:46 +08:00
|
|
|
)
|
|
|
|
|
|
|
|
// Logger is a generic logging interface
|
|
|
|
type Logger interface {
|
2020-02-06 21:36:33 +00:00
|
|
|
// Init initialises options
|
2020-10-16 09:38:57 +03:00
|
|
|
Init(opts ...Option) error
|
2021-08-30 16:19:35 +03:00
|
|
|
// Clone create logger copy with new options
|
|
|
|
Clone(opts ...Option) Logger
|
2020-08-29 17:43:06 +03:00
|
|
|
// V compare provided verbosity level with current log level
|
|
|
|
V(level Level) bool
|
2021-08-30 16:19:35 +03:00
|
|
|
// Level sets the log level for logger
|
|
|
|
Level(level Level)
|
2020-02-20 08:26:12 +00:00
|
|
|
// The Logger options
|
|
|
|
Options() Options
|
2021-08-06 02:15:57 +03:00
|
|
|
// Fields set fields to always be logged with keyval pairs
|
|
|
|
Fields(fields ...interface{}) Logger
|
2020-11-04 00:38:12 +03:00
|
|
|
// Info level message
|
2024-10-12 12:37:43 +03:00
|
|
|
Info(ctx context.Context, msg string, args ...interface{})
|
2020-11-04 00:38:12 +03:00
|
|
|
// Trace level message
|
2024-10-12 12:37:43 +03:00
|
|
|
Trace(ctx context.Context, msg string, args ...interface{})
|
2020-11-04 00:38:12 +03:00
|
|
|
// Debug level message
|
2024-10-12 12:37:43 +03:00
|
|
|
Debug(ctx context.Context, msg string, args ...interface{})
|
2020-11-04 00:38:12 +03:00
|
|
|
// Warn level message
|
2024-10-12 12:37:43 +03:00
|
|
|
Warn(ctx context.Context, msg string, args ...interface{})
|
2020-11-04 00:38:12 +03:00
|
|
|
// Error level message
|
2024-10-12 12:37:43 +03:00
|
|
|
Error(ctx context.Context, msg string, args ...interface{})
|
2020-11-04 00:38:12 +03:00
|
|
|
// Fatal level message
|
2024-10-12 12:37:43 +03:00
|
|
|
Fatal(ctx context.Context, msg string, args ...interface{})
|
2021-01-10 18:56:39 +03:00
|
|
|
// Log logs message with needed level
|
2024-10-12 12:37:43 +03:00
|
|
|
Log(ctx context.Context, level Level, msg string, args ...interface{})
|
2024-03-04 01:09:08 +03:00
|
|
|
// Name returns broker instance name
|
|
|
|
Name() string
|
|
|
|
// String returns the type of logger
|
2020-02-06 21:36:33 +00:00
|
|
|
String() string
|
2020-02-07 05:35:46 +08:00
|
|
|
}
|
|
|
|
|
2021-08-06 02:15:57 +03:00
|
|
|
// Field contains keyval pair
|
|
|
|
type Field interface{}
|