logger

type AllowAllPolicy struct{}

type Config struct {
	// LoggingLevel set log defaultLevel
	LoggingLevel Level
	// FileLoggingEnabled makes the framework log to a file
	// the fields below can be skipped if this value is false!
	FileLoggingEnabled bool
	// ConsoleLoggingEnabled makes the framework log to console
	ConsoleLoggingEnabled bool
	// CallerEnabled makes the caller log to a file
	CallerEnabled bool
	// CallerSkip increases the number of callers skipped by caller
	CallerSkip int
	// Directory to log to to when filelogging is enabled
	Directory string
	// Filename is the name of the logfile which will be placed inside the directory
	Filename string
	// MaxSize the max size in MB of the logfile before it's rolled
	MaxSize int
	// MaxBackups the max number of rolled files to keep
	MaxBackups int
	// MaxAge the max age in days to keep a logfile
	MaxAge int
	// ConsoleInfoStream
	ConsoleInfoStream *os.File
	// ConsoleErrorStream
	ConsoleErrorStream *os.File
	// ConsoleDebugStream
	ConsoleDebugStream *os.File
}

type Entry interface {
	// Debug logs a message at DebugLevel.
	Debug(msg string)
	// Debugf logs a message at DebugLevel.
	Debugf(format string, args ...any)
	// DebugWith logs a message with fields at DebugLevel.
	DebugWith(msg string, fields Fields)
	// Info logs a message at InfoLevel.
	Info(msg string)
	// Infof logs a message at InfoLevel.
	Infof(format string, args ...any)
	// InfoWith logs a message with fields at InfoLevel.
	InfoWith(msg string, fields Fields)
	// Warn logs a message at WarnLevel.
	Warn(msg string)
	// Warnf logs a message at WarnLevel.
	Warnf(format string, args ...any)
	// WarnWith logs a message with fields at WarnLevel.
	WarnWith(msg string, fields Fields)
	// Error logs a message at ErrorLevel.
	Error(msg string)
	// Errorf logs a message at ErrorLevel.
	Errorf(format string, args ...any)
	// ErrorWith logs a message with fields at ErrorLevel.
	ErrorWith(msg string, fields Fields)

	// WithFields returns a new entry with after adding fields
	WithFields(fields Fields) Entry
	// WithField returns a new entry with after adding field
	WithField(k string, v any) Entry
	// With returns a new entry with after adding data with default field name
	With(data any) Entry
	// WithError returns a new entry with after adding error
	WithError(err error) Entry
	// WithTracing returns a new entry with after adding requestId
	WithTracing(requestId string) Entry

	// Enabled is entry enabled at level
	Enabled(level Level) bool
}

type Fields map[string]any

type Level zapcore.Level

type LogEntry struct {
	// contains filtered or unexported fields
}

type LogTrafficEntry struct {
	// contains filtered or unexported fields
}

type ObjectTrimmer struct {
	ArrLimit   int
	StrLimit   int
	DeepLimit  int
	WholeLimit int
	Ignores    []string
}

type Policy interface {
	Allow() bool
}

type RateLimitPolicy struct {
	// contains filtered or unexported fields
}

type RejectAllPolicy struct{}

type SamplingPolicy struct {
	// contains filtered or unexported fields
}

type Traffic struct {
	Typ  TrafficTyp    // Typ: type of traffic, access or request
	Cmd  string        // Cmd: command
	Code int           // Code: error code
	Msg  string        // Msg: error message if you have
	Cost time.Duration // Cost: elapse of processing
	Req  any
	Resp any
}

type TrafficEntry interface {
	// Data logs traffic
	Data(traffic *Traffic)
	// DataWith logs traffic with fields
	DataWith(traffic *Traffic, fields Fields)
	// WithFields adds fields to traffic dataLogger
	WithFields(fields Fields) TrafficEntry
	// WithTracing adds requestId to traffic dataLogger
	WithTracing(requestId string) TrafficEntry
	// WithIgnores adds ignores to traffic dataLogger
	WithIgnores(ignores ...string) TrafficEntry
	// WithPolicy adds policy to traffic dataLogger
	// disable: true: disable policy, false: enable policy
	WithPolicy(policy Policy) TrafficEntry

	Start(req *TrafficReq, fields Fields) *TrafficRec
}

type TrafficLogConfig struct {

	// FileLoggingEnabled makes the framework log to a file
	// the fields below can be skipped if this value is false!
	FileLoggingEnabled bool
	// ConsoleLoggingEnabled makes the framework log to console
	ConsoleLoggingEnabled bool
	// LoggingDirectory to log to to when filelogging is enabled
	LoggingDirectory string
	// Filename is the name of the logfile which will be placed inside the directory
	Filename string
	// MaxSize the max size in MB of the logfile before it's rolled
	MaxSize int
	// MaxBackups the max number of rolled files to keep
	MaxBackups int
	// MaxAge the max age in days to keep a logfile
	MaxAge int
	// ConsoleStream
	ConsoleStream *os.File
}

type TrafficRec struct {
	// contains filtered or unexported fields
}

type TrafficReq struct {
	Cmd string // Cmd: command
	Req any
}

type TrafficResp struct {
	Code int    // Code: error code
	Msg  string // Msg: error message if you have
	Resp any
}

type TrafficTyp string

type TrimOption func(*ObjectTrimmer)