Logback-gelf 用户技术文档

1. 安装指南

首先，确保您的项目中已经包含了Logback日志框架。接下来，您需要将logback-gelf模块添加到您的项目中。在项目的pom.xml文件中添加以下依赖信息：

<dependency>
  <groupId>me.moocar</groupId>
  <artifactId>logback-gelf</artifactId>
  <version>0.3</version>
</dependency>

然后，您需要配置Logback以使用logback-gelf模块。以下是一个基本的logback.xml配置示例：

<configuration>
    <appender name="GELF UDP APPENDER" class="me.moocar.logbackgelf.GelfUDPAppender">
        <encoder class="me.moocar.logbackgelf.GZIPEncoder">
            <layout class="me.moocar.logbackgelf.GelfLayout"/>
        </encoder>
    </appender>
   <root level="debug">
    <appender-ref ref="GELF UDP APPENDER" />
  </root>
</configuration>

2. 项目的使用说明

logback-gelf是一个Logback的Appender，它可以将日志编码为GELF（Graylog Extended Log Format）并发送到Graylog服务器。GELF是一种用于将日志数据结构化为JSON格式并发送到Graylog的日志格式。

在配置文件中，您可以定义GelfLayout的多个属性来自定义日志消息的格式。以下是一些可用的属性：

• useLoggerName: 是否在每条GELF消息中添加记录器的完全限定名称。
• useThreadName: 是否在每条GELF消息中添加线程名称。
• host: 发送日志的主机名。
• useMarker: 如果设置了slf4j的Marker，是否将其添加到GELF消息中。
• shortMessageLayout: 用于创建GELF short_message字段的布局。
• fullMessageLayout: 用于创建GELF full_message字段的布局。
• additionalFields: 额外的键/值对，可以添加到GELF JSON中。
• fieldType: 字段类型转换。
• staticFields: 静态字段，用于设置不经常变化的字段值。
• includeFullMDC: 是否包括完整的MDC（Mapped Diagnostic Context）。

3. 项目API使用文档

logback-gelf提供的API主要是通过配置logback.xml文件来实现的。您不需要直接调用API，而是通过配置文件中的标签和属性来定义日志的格式和处理方式。

例如，以下是如何配置使用TCP发送日志的示例：

<appender name="GELF TCP APPENDER" class="me.moocar.logback.net.SocketEncoderAppender">
    <port>12201</port>
    <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
        <layout class="me.moocar.logbackgelf.GelfLayout">
            <!-- 配置您的GelfLayout属性 -->
        </layout>
    </encoder>
</appender>

4. 项目安装方式

项目的安装方式已在“安装指南”一节中描述。简要概括，您需要将logback-gelf的依赖添加到项目的pom.xml文件中，并配置相应的logback.xml文件以使用logback-gelf模块。确保Graylog服务器已安装并正在运行，以便接收和处理GELF格式的日志消息。