Logstash-Logback-Encoder 开源项目指南

最新推荐文章于 2024-08-12 08:58:55 发布

裴剑苹

最新推荐文章于 2024-08-12 08:58:55 发布

阅读量507

点赞数 3

本文链接：https://blog.csdn.net/gitblog_00820/article/details/141083743

版权

Logstash-Logback-Encoder 开源项目指南

logstash-logback-encoderLogback JSON encoder and appenders项目地址:https://gitcode.com/gh_mirrors/lo/logstash-logback-encoder

项目介绍

Logstash-Logback-Encoder 是一个用于将 Java 应用的日志事件转换成 Logstash 可以解析的 JSON 格式的编码器。这个项目是专为配合 Logback 日志框架一起使用的。它支持将日志事件（如 LoggingEvents 和 AccessEvents）转化为 JSON 数据并发送给 Logstash 或其他接收端。

特点

支持 Logstash 的多种编码方式。
兼容多个版本的 Logback。
提供丰富的配置选项，可以自定义输出 JSON 的结构。
异步处理，性能优越。

项目快速启动

要开始使用 Logstash-Logback-Encoder，首先确保你的环境中已经安装了以下依赖：

Java 运行环境
Maven 或 Gradle 构建工具

接下来，可以通过在项目的 pom.xml 文件中添加如下依赖来集成 Logstash-Logback-Encoder 到你的项目中：

<!-- 使用 Maven -->
<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>7.2</version>
</dependency>

<!-- 或者使用 Gradle -->
dependencies {
    implementation 'net.logstash.logback:logstash-logback-encoder:7.2'
}

然后，在你的 Logback 配置文件（通常为 logback.xml）中添加 Logstash 的 Appender 和 Encoder 配置，例如为了通过 TCP 发送 LoggingEvents 给 Logstash：

<configuration>
    <appender name="LOGSTASH_TCP_APPENDER" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <!-- 将数据发往本地运行的 Logstash 实例 -->
        <destination>localhost:4560</destination>
        
        <!-- 设置编码器类 -->
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder"/>
            <!-- 保持原始时间戳 -->
            <timestampPattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}</timestampPattern>
            
            <!-- 添加额外字段到日志条目 -->
            <customFields>{"application":"my-application"}</customFields>
        </encoder>
    </appender>

    <!-- 在 root logger 中引入该 appender -->
    <root level="INFO">
        <appender-ref ref="LOGSTASH_TCP_APPENDER"/>
    </root>
</configuration>