Skip to main content

Log Configuration

Log Overview

LogConf for our log configuration,logx.MustSetupprovides the basic configuration capability for our log, using the following simple methods:

var c logc.LogConf

logc.Info(context.Background(), "log")
// do your job

Our log is referenced by serviceConf and will be automatically initialized when the service is started.

Definition of parameters

LogConf configuration definition below:

package logx

// A LogConf is a logging config.
type LogConf struct {
ServiceName string `json:",optional"`
Mode string `json:",default=console,options=[console,file,volume]"`
Encoding string `json:",default=json,options=[json,plain]"`
TimeFormat string `json:",optional"`
Path string `json:",default=logs"`
Level string `json:",default=info,options=[debug,info,error,severe]"`
MaxContentLength uint32 `json:",optional"`
Compress bool `json:",optional"`
Stat bool `json:",default=true"` // go-zero 版本 >= 1.5.0 才支持
KeepDays int `json:",optional"`
StackCooldownMillis int `json:",default=100"`
// MaxBackups represents how many backup log files will be kept. 0 means all files will be kept forever.
// Only take effect when RotationRuleType is `size`.
// Even thougth `MaxBackups` sets 0, log files will still be removed
// if the `KeepDays` limitation is reached.
MaxBackups int `json:",default=0"`
// MaxSize represents how much space the writing log file takes up. 0 means no limit. The unit is `MB`.
// Only take effect when RotationRuleType is `size`
MaxSize int `json:",default=0"`
// RotationRuleType represents the type of log rotation rule. Default is `daily`.
// daily: daily rotation.
// size: size limited rotation.
Rotation string `json:",default=daily,options=[daily,size]"`

ParamsDataTypeDefault valueNoteEnum Values
ServiceNamestringService Name
ModestringconsoleLog Printing Mode, console Consolefile, console
EncodingstringjsonLog format, json format or plain plain textjson, plain
TimeFormatstringDate Format
PathstringlogsLog output path in file output mode
LevelstringinfoLog output leveldebug,info,error,severe
MaxContentLengthuint320Log length limiting. Logs will be cropped when printing delayed logs, only crop content
CompressboolfalseWhether to compress logs
StatbooltrueWhether to disable stat log, go-zero version is greater than 1.5.0
KeepDaysint0Log number of days left, only in file mode
StackCooldownMillisint100Stack print cooldown time
MaxBackupsint0File output mode with maximum number of files remaining when split by size
MaxSizeint0File output mode, single file size when split by size
RotationstringdailyFile split mode, daily by datedaily,size