Loki4j Logback 应用程序附加工具安装与使用教程

本教程将指导您如何安装并使用 Loki4j Logback Appender，这是一个用于将Java应用的日志推送到Grafana Loki的快速轻量级Logback插件。以下是主要内容：

1. 项目目录结构及介绍

在克隆或下载 Loki4j Logback Appender 项目后，典型的目录结构如下：

├── build.gradle          // Gradle构建脚本
├── docs                  // 文档相关文件
├── loki-client           // 与Loki通信的相关代码
├── loki-logback-appender // 主要的Logback实现
├── loki-protobuf         // Protobuf相关的定义
├── testkit               // 测试工具
├── .gitignore            // Git忽略文件列表
├── CONTRIBUTING.md       // 贡献指南
├── LICENSE               // 许可证文件
├── NOTICE.txt            // 注意事项
└── README.md             // 项目README

其中，build.gradle 是项目依赖管理文件，docs 存放文档，而其他子目录如 loki-client 等则是项目的源码和库。

2. 项目的启动文件介绍

由于 Loki4j Logback Appender 是一个Logback插件，没有特定的启动文件。它的使用是通过集成到您的应用程序中，通过修改Logback配置文件（通常是 logback.xml）来添加Loki日志推送功能。您不需要独立启动这个项目，而是将其作为你的应用的一部分进行编译和部署。

3. 项目的配置文件介绍

3.1 添加依赖

首先，你需要在你的Maven或者Gradle项目中添加loki-logback-appender依赖。例如，在Maven的pom.xml中：

<dependency>
    <groupId>com.github.loki4j</groupId>
    <artifactId>loki-logback-appender</artifactId>
    <version>1.5.2</version>
</dependency>

在Gradle的build.gradle文件中：

implementation 'com.github.loki4j:loki-logback-appender:1.5.2'

3.2 配置Logback XML

接下来，更新您的 logback.xml 文件以添加Loki Appender配置。以下是一个基本示例：

<configuration>

  <!-- 其他配置... -->

  <appender name="LOKI" class="com.github.loki4j.logback.Loki4jAppender">
    <http>
      <url>http://localhost:3100/loki/api/v1/push</url>
    </http>
    <format>
      <label>
        <pattern>app=my-app host=$[HOSTNAME]</pattern>
      </label>
      <message>
        <!-- 可选模式: 默认文本布局 -->
        <pattern>%-5level [% 5($[HOSTNAME])] % 10thread %logger[20] | %msg %ex</pattern>
      </message>
      <!-- 或者选择JSON布局 -->
      <message class="com.github.loki4j.logback.JsonLayout" />
    </format>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="LOKI" />
  </root>

  <!-- 其他配置... -->

</configuration>

在上述配置中：

• <url> 标签指定了Loki服务器的位置。
• <label> 定义了日志标签，便于在Loki中组织和查询。
• <message> 中的模式定义了日志消息的格式，可以是文本或JSON。
• <root> 设置日志级别，并将Loki Appender附加到所有日志记录上。

完成这些步骤后，重新启动你的应用程序，它将开始将日志发送至配置的Loki服务器。

更多高级配置选项和详细的日志格式说明，请参考项目仓库中的 README 和 官方文档。如有疑问，请查阅这些资源或在项目问题反馈区提交问题。