Logback Kafka Appender 使用教程

1. 项目的目录结构及介绍

Logback Kafka Appender 项目的目录结构如下：

logback-kafka-appender/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── github/
│   │   │           └── danielwegener/
│   │   │               └── logback/
│   │   │                   └── kafka/
│   │   │                       ├── KafkaAppender.java
│   │   │                       ├── KafkaAppenderConfig.java
│   │   │                       ├── KafkaMessageEncoder.java
│   │   │                       └── KafkaTopicName.java
│   │   └── resources/
│   │       └── logback.xml
│   └── test/
│       └── java/
│           └── com/
│               └── github/
│                   └── danielwegener/
│                       └── logback/
│                           └── kafka/
│                               └── KafkaAppenderTest.java
├── pom.xml
└── README.md

目录结构介绍

• src/main/java/com/github/danielwegener/logback/kafka/：包含主要的 Java 源代码文件，如 KafkaAppender.java 等。
• src/main/resources/：包含项目的配置文件，如 logback.xml。
• src/test/java/com/github/danielwegener/logback/kafka/：包含测试代码文件，如 KafkaAppenderTest.java。
• pom.xml：Maven 项目的配置文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是 KafkaAppender.java，位于 src/main/java/com/github/danielwegener/logback/kafka/ 目录下。

KafkaAppender.java

KafkaAppender.java 是 Logback Kafka Appender 的核心类，负责将日志消息发送到 Kafka 主题。以下是该文件的主要功能：

• 配置 Kafka 生产者。
• 将日志事件转换为 Kafka 消息。
• 将消息发送到指定的 Kafka 主题。

3. 项目的配置文件介绍

项目的配置文件主要是 logback.xml，位于 src/main/resources/ 目录下。

logback.xml

logback.xml 是 Logback 的配置文件，用于配置日志记录的行为。以下是一个示例配置：

<configuration>
    <appender name="kafkaAppender" class="com.github.danielwegener.logback.kafka.KafkaAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <topic>logback_topic</topic>
        <brokerList>localhost:9092</brokerList>
    </appender>

    <root level="info">
        <appender-ref ref="kafkaAppender" />
    </root>
</configuration>

配置文件介绍

• <appender>：定义一个 Kafka Appender，名称为 kafkaAppender。
• <encoder>：定义日志消息的格式。
• <topic>：指定 Kafka 主题。
• <brokerList>：指定 Kafka broker 的地址。
• <root>：定义根日志记录器的级别和引用。

通过以上配置，可以将日志消息发送到指定的 Kafka 主题。