Logrus Mate 项目教程

Logrus Mate 项目教程

logrus_mate tool for logrus, let it easy to use 项目地址: https://gitcode.com/gh_mirrors/lo/logrus_mate

1. 项目目录结构及介绍

Logrus Mate 项目的目录结构如下：

logrus_mate/
├── example/
│   ├── example.go
│   └── ...
├── hooks/
│   ├── hooks.go
│   └── ...
├── writers/
│   ├── writers.go
│   └── ...
├── LICENSE
├── README.md
├── config.go
├── formatter_json.go
├── formatter_null.go
├── formatter_text.go
├── formatters.go
├── hooks.go
├── logrus_mate.go
├── writer_null.go
├── writer_std.go
└── writers.go

目录结构介绍

• example/: 包含项目的示例代码，展示了如何使用 Logrus Mate 进行日志配置和初始化。
• hooks/: 包含自定义钩子（Hooks）的实现，用于扩展日志功能。
• writers/: 包含自定义写入器（Writers）的实现，用于定义日志的输出目标。
• LICENSE: 项目的开源许可证文件，本项目使用 Apache-2.0 许可证。
• README.md: 项目的说明文档，介绍了项目的基本信息和使用方法。
• config.go: 配置文件的解析和加载逻辑。
• formatter_json.go: JSON 格式化器的实现。
• formatter_null.go: Null 格式化器的实现，用于禁用日志输出。
• formatter_text.go: 文本格式化器的实现。
• formatters.go: 格式化器的注册和管理逻辑。
• hooks.go: 钩子的注册和管理逻辑。
• logrus_mate.go: 项目的主文件，包含了 Logrus Mate 的核心功能。
• writer_null.go: Null 写入器的实现，用于禁用日志输出。
• writer_std.go: 标准输出写入器的实现。
• writers.go: 写入器的注册和管理逻辑。

2. 项目启动文件介绍

项目的启动文件是 logrus_mate.go，该文件包含了 Logrus Mate 的核心功能和初始化逻辑。以下是启动文件的主要内容：

package main

import (
    "github.com/sirupsen/logrus"
    "github.com/gogap/logrus_mate"
)

func main() {
    // 初始化 Logrus Mate
    mate, _ := logrus_mate.NewLogrusMate(
        logrus_mate.ConfigString(`
            [formatter]
            name = "json"
        `),
    )

    // 劫持 Logrus 的标准日志器
    mate.Hijack(logrus.StandardLogger(), "formatter")

    // 使用 Logrus 进行日志记录
    logrus.WithField("Field", "A").Debugln("Hello JSON")
}

启动文件介绍

• 初始化 Logrus Mate: 使用 logrus_mate.NewLogrusMate 函数初始化 Logrus Mate，并传入配置字符串。
• 劫持 Logrus 的标准日志器: 使用 mate.Hijack 函数劫持 Logrus 的标准日志器，并应用配置。
• 日志记录: 使用 Logrus 进行日志记录，配置的格式化器将日志输出为 JSON 格式。

3. 项目的配置文件介绍

Logrus Mate 的配置文件通常是一个 HOCON（Human-Optimized Config Object Notation）格式的文件，用于定义日志的格式化器、钩子和输出目标。以下是一个示例配置文件的内容：

[formatter]
name = "json"

[hook]
name = "syslog"
network = "udp"
address = "localhost:514"
priority = "info"
tag = "myapp"

[writer]
name = "file"
filename = "app.log"
max-lines = 1000
max-size = 10MB
daily = true
max-days = 7
rotate = true
level = "info"

配置文件介绍

• formatter: 定义日志的格式化器，name 指定格式化器的名称，如 json、text 等。
• hook: 定义日志的钩子，name 指定钩子的名称，如 syslog、mail 等。其他字段根据钩子的类型进行配置。
• writer: 定义日志的写入器，name 指定写入器的名称，如 file、stdout 等。其他字段根据写入器的类型进行配置。

通过配置文件，可以灵活地定义日志的输出格式、输出目标和附加功能，满足不同场景下的日志需求。

logrus_mate tool for logrus, let it easy to use 项目地址: https://gitcode.com/gh_mirrors/lo/logrus_mate