Skip to content

Commit

Permalink
📝 doc: update readme add more usage examples
Browse files Browse the repository at this point in the history
  • Loading branch information
inhere committed Jan 4, 2023
1 parent 38418c7 commit 400f636
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,10 +465,15 @@ func main() {

// DangerLevels contains: slog.PanicLevel, slog.ErrorLevel, slog.WarnLevel
h1 := handler.MustFileHandler("/tmp/error.log", handler.WithLogLevels(slog.DangerLevels))
// custom log format
// f := h1.Formatter().(*slog.TextFormatter)
f := slog.AsTextFormatter(h1.Formatter())
f.SetTemplate("your template format\n")

// NormalLevels contains: slog.InfoLevel, slog.NoticeLevel, slog.DebugLevel, slog.TraceLevel
h2 := handler.MustFileHandler("/tmp/info.log", handler.WithLogLevels(slog.NormalLevels))

// register handlers
slog.PushHandler(h1)
slog.PushHandler(h2)

Expand Down Expand Up @@ -524,6 +529,10 @@ This is config struct for create a Handler:
type Config struct {
// Logfile for write logs
Logfile string `json:"logfile" yaml:"logfile"`
// LevelMode for filter log record. default LevelModeList
LevelMode uint8 `json:"level_mode" yaml:"level_mode"`
// Level value. use on LevelMode = LevelModeValue
Level slog.Level `json:"level" yaml:"level"`
// Levels for log record
Levels []slog.Level `json:"levels" yaml:"levels"`
// UseJSON for format logs
Expand Down
7 changes: 6 additions & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ h.GetFormatter().(*slog.TextFormatter).SetTemplate(slog.NamedTemplate)

![](_example/images/console-color-log1.png)

> 注意: `slog.TextFormatter` 使用模板字符串来格式化输出日志,因此新增字段输出需要同时调整模板。
> 注意:`slog.TextFormatter` 使用模板字符串来格式化输出日志,因此新增字段输出需要同时调整模板。
### 使用JSON格式

Expand Down Expand Up @@ -464,10 +464,15 @@ func main() {

// DangerLevels 包含: slog.PanicLevel, slog.ErrorLevel, slog.WarnLevel
h1 := handler.MustFileHandler("/tmp/error.log", handler.WithLogLevels(slog.DangerLevels))
// 配置日志格式
// f := h1.Formatter().(*slog.TextFormatter)
f := slog.AsTextFormatter(h1.Formatter())
f.SetTemplate("your template format\n")

// NormalLevels 包含: slog.InfoLevel, slog.NoticeLevel, slog.DebugLevel, slog.TraceLevel
h2 := handler.MustFileHandler("/tmp/info.log", handler.WithLogLevels(slog.NormalLevels))

// 注册 handler 到 logger(调度器)
slog.PushHandler(h1)
slog.PushHandler(h2)

Expand Down

0 comments on commit 400f636

Please sign in to comment.