forked from pingcap/tidb
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
configuration for logger (pingcap#6)
* config section for logger & rename config file * adjust to new configuration * correct using config item * adjust comment
- Loading branch information
Showing
9 changed files
with
239 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| package log | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "path" | ||
| "runtime" | ||
| "strings" | ||
|
|
||
| "github.com/juju/errors" | ||
| log "github.com/sirupsen/logrus" | ||
| "gopkg.in/natefinch/lumberjack.v2" | ||
|
|
||
| "github.com/pingcap/tidb-lightning/ingest/common" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultLogTimeFormat = "2006/01/02 15:04:05.000" | ||
| defaultLogLevel = log.InfoLevel | ||
| defaultLogMaxDays = 7 | ||
| defaultLogMaxSize = 512 // MB | ||
| ) | ||
|
|
||
| // LogConfig serializes log related config in toml/json. | ||
| type LogConfig struct { | ||
| // Log level. | ||
| Level string `toml:"level" json:"level"` | ||
| // Log filename, leave empty to disable file log. | ||
| File string `toml:"file" json:"file"` | ||
| // Max size for a single file, in MB. | ||
| FileMaxSize int `toml:"max-size" json:"max-size"` | ||
| // Max log keep days, default is never deleting. | ||
| FileMaxDays int `toml:"max-days" json:"max-days"` | ||
| // Maximum number of old log files to retain. | ||
| FileMaxBackups int `toml:"max-backups" json:"max-backups"` | ||
| } | ||
|
|
||
| func (cfg *LogConfig) Adjust() { | ||
| if len(cfg.File) > 0 { | ||
| if cfg.FileMaxSize == 0 { | ||
| cfg.FileMaxSize = defaultLogMaxSize | ||
| } | ||
| if cfg.FileMaxDays == 0 { | ||
| cfg.FileMaxDays = defaultLogMaxDays | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func stringToLogLevel(level string) log.Level { | ||
| switch strings.ToLower(level) { | ||
| case "fatal": | ||
| return log.FatalLevel | ||
| case "error": | ||
| return log.ErrorLevel | ||
| case "warn", "warning": | ||
| return log.WarnLevel | ||
| case "debug": | ||
| return log.DebugLevel | ||
| case "info": | ||
| return log.InfoLevel | ||
| } | ||
| return defaultLogLevel | ||
| } | ||
|
|
||
| type SimpleTextFormater struct{} | ||
|
|
||
| func (f *SimpleTextFormater) Format(entry *log.Entry) ([]byte, error) { | ||
| var b *bytes.Buffer | ||
| if entry.Buffer != nil { | ||
| b = entry.Buffer | ||
| } else { | ||
| b = &bytes.Buffer{} | ||
| } | ||
|
|
||
| // timestamp | ||
| fmt.Fprintf(b, "%s ", entry.Time.Format(defaultLogTimeFormat)) | ||
| // code stack trace | ||
| if file, ok := entry.Data["file"]; ok { | ||
| fmt.Fprintf(b, "%s:%v:", file, entry.Data["line"]) | ||
| } | ||
| // level + message | ||
| fmt.Fprintf(b, " [%s] %s", entry.Level.String(), entry.Message) | ||
|
|
||
| // others | ||
| for k, v := range entry.Data { | ||
| if k != "file" && k != "line" { | ||
| fmt.Fprintf(b, " %v=%v", k, v) | ||
| } | ||
| } | ||
|
|
||
| b.WriteByte('\n') | ||
|
|
||
| return b.Bytes(), nil | ||
| } | ||
|
|
||
| // modifyHook injects file name and line pos into log entry. | ||
| type contextHook struct{} | ||
|
|
||
| // Levels implements logrus.Hook interface. | ||
| func (hook *contextHook) Levels() []log.Level { | ||
| return log.AllLevels | ||
| } | ||
|
|
||
| // Fire implements logrus.Hook interface | ||
| // https://github.com/sirupsen/logrus/issues/63 | ||
| func (hook *contextHook) Fire(entry *log.Entry) error { | ||
| pc := make([]uintptr, 3) | ||
| cnt := runtime.Callers(6, pc) | ||
|
|
||
| for i := 0; i < cnt; i++ { | ||
| fu := runtime.FuncForPC(pc[i] - 1) | ||
| name := fu.Name() | ||
| if !isSkippedPackageName(name) { | ||
| file, line := fu.FileLine(pc[i] - 1) | ||
| entry.Data["file"] = path.Base(file) | ||
| entry.Data["line"] = line | ||
| break | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func isSkippedPackageName(name string) bool { | ||
| return strings.Contains(name, "github.com/sirupsen/logrus") || | ||
| strings.Contains(name, "github.com/coreos/pkg/capnslog") | ||
| } | ||
|
|
||
| func InitLogger(cfg *LogConfig) error { | ||
| log.SetLevel(stringToLogLevel(cfg.Level)) | ||
| log.AddHook(&contextHook{}) | ||
| log.SetFormatter(&SimpleTextFormater{}) | ||
|
|
||
| if len(cfg.File) > 0 { | ||
| if common.IsDirExists(cfg.File) { | ||
| return errors.Errorf("can't use directory as log file name : %s", cfg.File) | ||
| } | ||
|
|
||
| // use lumberjack to logrotate | ||
| output := &lumberjack.Logger{ | ||
| Filename: cfg.File, | ||
| MaxAge: cfg.FileMaxDays, | ||
| MaxSize: cfg.FileMaxSize, | ||
| MaxBackups: cfg.FileMaxBackups, | ||
| LocalTime: true, | ||
| } | ||
|
|
||
| log.SetOutput(output) | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.