README
¶
hlog - High-performance logger for Go
Logger 的需求
- 统一要求
- 基于 go.uber.org/zap 框架
- 文件记录基于 gopkg.in/natefinch/lumberjack.v2 包
- 支持 debug 开关，即对于 DPanic 有效
- 支持 console 和文件作为输出目标
- 可甜可咸
- 关于 level
- 支持 level 的统一控制，即低于 level 均不输出到任何目标
- logger 的 level 在初始化后，可以动态调整
- logger 可以派生，派生的 logger 和 root 对输出目标并发写无冲突，level 可以自由、独立定义
- Console 日志
- 日志一定会输出到 console
- 三种格式可选：彩色 tab 分隔、单色 tab 分隔、JSON
- 满足 level 的前提下，Error 或以上级别输出到 stderr，以下输出到 stdout
- 文件日志
- 日志可选配输出到指定路径
- 两种格式可选：单色 tab 分隔、JSON
- 文件 rotation 策略可指定：超过多少切割，是否压缩，是否删除最旧的
e.g.
console 格式
2022-04-14T23:03:25.858+0800 WARN onelog/main.go:53 Hello Go W World from 2 ~~~~~ {"num": 2}
2022-04-14T23:03:25.961+0800 DEBUG onelog/main.go:58 Hello Go D World from 2 Now1 {"num": 2}
json 格式
{"level":"warn","time":"2022-04-14T23:04:18.485+0800","caller":"onelog/main.go:53","msg":"Hello Go W World from 2 ~~~~~","num":2}
{"level":"debug","time":"2022-04-14T23:04:18.585+0800","caller":"onelog/main.go:58","msg":"Hello Go D World from 2 Now1","num":2}
Documentation
¶
Index ¶
- Constants
- type LogFormat
- type Logger
- func (l *Logger) Fork() *Logger
- func (l *Logger) GetLevel() zapcore.Level
- func (l *Logger) Named(name string) *Logger
- func (l *Logger) SetLevel(lvl zapcore.Level)
- func (l *Logger) SetLevelString(text string) error
- func (l *Logger) With(fields ...interface{}) *Logger
- func (l *Logger) WithOptions(_ ...Option) *Logger
- type Option
- func WithConsoleLogFormat(format LogFormat) Option
- func WithDevelopmentMode() Option
- func WithErrorLogOutput(w io.Writer) Option
- func WithLevel(level zapcore.Level) Option
- func WithMonochrome(b bool) Option
- func WithNormalLogOutput(w io.Writer) Option
- func WithOutputFile(p string) Option
- func WithOutputFileCompress(b bool) Option
- func WithOutputFileLogFormat(format LogFormat) Option
- func WithOutputFileMaxSizeInMB(s uint) Option
- func WithOutputFileRetainNum(n uint) Option
- func WithStacktraceLevel(lvl zapcore.Level) Option
- func WithStacktraceLevelString(text string) Option
- func WithZapOptions(opts ...zap.Option) Option
Constants ¶
const ( // LogFormatConsole indicates the console format, i.e. [time] [level] [caller] [message] [fields*] LogFormatConsole = "console" // LogFormatJSON indicates the JSON format. LogFormatJSON = "json" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Logger ¶
type Logger struct {
*zap.SugaredLogger
// contains filtered or unexported fields
}
Logger is a wrapper of zap.SugaredLogger with some extra features.
func NewJSONLogger ¶
NewJSONLogger returns a logger which outputs in JSON format only and keeps 10 recent log archives.
func NewNoopLogger ¶
func NewNoopLogger() *Logger
NewNoopLogger returns a no-op logger which does nothing except panicking when calling Fatal or Panic.
func NewPersistentLogger ¶
NewPersistentLogger returns a logger which keeps all the log file in JSON format and never cleans up.
func NewSimpleLogger ¶
func NewSimpleLogger() *Logger
NewSimpleLogger returns a simple logger which writes to stdout/stderr only with process id in development mode.
func (*Logger) SetLevelString ¶
SetLevelString sets the log level by string.
func (*Logger) WithOptions ¶ added in v0.1.2
type Option ¶
type Option func(*config)
Option is a function that configures the logger.
func WithConsoleLogFormat ¶
WithConsoleLogFormat configures the format of the console log output.
func WithDevelopmentMode ¶
func WithDevelopmentMode() Option
WithDevelopmentMode configures the development mode.
func WithErrorLogOutput ¶
WithErrorLogOutput configures the io.Writer for logs at or above error level.
func WithMonochrome ¶
WithMonochrome configures the monochrome mode of console output.
func WithNormalLogOutput ¶
WithNormalLogOutput configures the io.Writer for logs under error level.
func WithOutputFile ¶
WithOutputFile configures the output file path.
func WithOutputFileCompress ¶
WithOutputFileCompress configures whether to compress the output file.
func WithOutputFileLogFormat ¶
WithOutputFileLogFormat configures the format of the output file log output.
func WithOutputFileMaxSizeInMB ¶
WithOutputFileMaxSizeInMB configures the max size of the output file in MB.
func WithOutputFileRetainNum ¶
WithOutputFileRetainNum configures the number of output files to retain, 0 means unlimited.
func WithStacktraceLevel ¶
WithStacktraceLevel configures a logger to record a stack trace for all messages at or above a given level.
func WithStacktraceLevelString ¶
WithStacktraceLevelString configures a logger to record a stack trace for all messages at or above a given level, if the level string is invalid, it will be ignored.
func WithZapOptions ¶
WithZapOptions wraps the zap.Options to configure the logger.
Source Files