logback gelf

回溯GELF

Logback 附加程序用于发送具有零附加依赖性的 GELF（Graylog 扩展日志格式）消息。

特征

• UDP（带分块）
• TCP（带或不带 TLS 加密）
• HTTP
• GZIP和ZLIB压缩（UDP和HTTP模式）
• 客户端负载均衡（循环）
• MDC（映射诊断上下文）的转发
• 转发来电数据
• 静态字段的转发
• 异常根源转发
• 除了 Logback 之外没有运行时依赖项

要求

• 爪哇11
• 登录1.5.7

示例

简单的UDP配置：

< configuration >

    < appender name = " GELF " class = " de.siegmar.logbackgelf.GelfUdpAppender " >
        < graylogHost >localhost</ graylogHost >
        < graylogPort >12201</ graylogPort >
    </ appender >

    < root level = " debug " >
        < appender-ref ref = " GELF " />
    </ root >

</ configuration >

简单的TCP配置：

< configuration >

    < appender name = " GELF " class = " de.siegmar.logbackgelf.GelfTcpAppender " >
        < graylogHost >localhost</ graylogHost >
        < graylogPort >12201</ graylogPort >
    </ appender >

    <!-- Use AsyncAppender to prevent slowdowns -->
    < appender name = " ASYNC GELF " class = " ch.qos.logback.classic.AsyncAppender " >
        < appender-ref ref = " GELF " />
        < neverBlock >true</ neverBlock >
    </ appender >

    < root level = " debug " >
        < appender-ref ref = " ASYNC GELF " />
    </ root >

</ configuration >

带有 TLS 配置的简单 TCP：

< configuration >

    < appender name = " GELF " class = " de.siegmar.logbackgelf.GelfTcpTlsAppender " >
        < graylogHost >localhost</ graylogHost >
        < graylogPort >12201</ graylogPort >
    </ appender >

    <!-- Use AsyncAppender to prevent slowdowns -->
    < appender name = " ASYNC GELF " class = " ch.qos.logback.classic.AsyncAppender " >
        < appender-ref ref = " GELF " />
        < neverBlock >true</ neverBlock >
    </ appender >

    < root level = " debug " >
        < appender-ref ref = " ASYNC GELF " />
    </ root >

</ configuration >

简单的HTTP配置：

< configuration >

    < appender name = " GELF " class = " de.siegmar.logbackgelf.GelfHttpAppender " >
        < uri >https://my.server:12201/gelf</ uri >
    </ appender >

    <!-- Use AsyncAppender to prevent slowdowns -->
    < appender name = " ASYNC GELF " class = " ch.qos.logback.classic.AsyncAppender " >
        < appender-ref ref = " GELF " />
        < neverBlock >true</ neverBlock >
    </ appender >

    < root level = " debug " >
        < appender-ref ref = " ASYNC GELF " />
    </ root >

</ configuration >

在示例目录中查找更多高级示例。

配置

附加器

de.siegmar.logbackgelf.GelfUdpAppender

• GraylogHost ：graylog 服务器的 IP 或主机名。如果主机名解析为多个 IP 地址，则将使用循环法。
• GraylogPort ：graylog 服务器的端口。默认值：12201。
• maxChunkSize ：GELF 块的最大大小（以字节为单位）。默认块大小为 508 - 这可以防止 IP 数据包碎片。这也是建议的最小值。支持的最大块大小为 65,467 字节。
• compressionMethod ：要使用的压缩方法（NONE、GZIP 或 ZLIB）。默认值：GZIP。
• messageIdSupplier ：提供 GELF UDP 协议所需的唯一消息 ID 的机制。默认值： de.siegmar.logbackgelf.MessageIdSupplier 。
• 编码器：请参阅下面的编码器配置。

de.siegmar.logbackgelf.GelfTcpAppender

• GraylogHost ：graylog 服务器的 IP 或主机名。如果主机名解析为多个 IP 地址，则将使用循环法。
• GraylogPort ：graylog 服务器的端口。默认值：12201。
• connectTimeout ：等待建立连接的最长时间（以毫秒为单位）。值为 0 会禁用连接超时。默认值：15,000 毫秒。
• socketTimeout ：读取套接字时阻塞的最长时间（以毫秒为单位）。值为 0 会禁用套接字超时。默认值：5,000 毫秒。
• reconnectInterval ：现有连接关闭并重新打开后的时间间隔（以秒为单位）。值为 -1 会禁用自动重新连接。默认值：60 秒。
• maxRetries ：重试次数。值为 0 会禁用重试尝试。默认值：2。
• retryDelay ：重试尝试之间的时间（以毫秒为单位）。如果 maxRetries 为 0，则忽略。默认值：3,000 毫秒。
• poolSize ：并发 tcp 连接数（最小 1）。默认值：2。
• poolMaxWaitTime ：等待连接从池中变为可用的最长时间（以毫秒为单位）。值为 -1 将禁用超时。默认值：5,000 毫秒。
• poolMaxIdleTime ：池连接在被视为“过时”并且不会被重用之前可以空闲的最长时间（以秒为单位）。值为 -1 将禁用最大空闲时间功能。默认值：-1（禁用）。
• 编码器：请参阅下面的编码器配置。

de.siegmar.logbackgelf.GelfTcpTlsAppender

• 一切都来自 GelfTcpAppender
• insecure ：如果为 true，则跳过 TLS 证书验证。你不应该在生产中使用它！默认值：假。

de.siegmar.logbackgelf.GelfHttpAppender

• uri ：graylog 服务器的 HTTP(s) URI（例如 https://my.server:12201/gelf）。
• insecure ：如果为 true，则跳过 TLS 证书验证。你不应该在生产中使用它！默认值：假。
• connectTimeout ：等待建立连接的最长时间（以毫秒为单位）。值为 0 会禁用连接超时。默认值：15,000 毫秒。
• requestTimeout ：等待响应的最长时间（以毫秒为单位）。值为 0 会禁用超时。默认值：5,000 毫秒。
• maxRetries ：重试次数。值为 0 将禁用重试尝试。默认值：2。
• retryDelay ：重试尝试之间的时间（以毫秒为单位）。如果 maxRetries 为 0，则忽略。默认值：3,000 毫秒。
• compressionMethod ：要使用的压缩方法（NONE、GZIP 或 ZLIB）。默认值：GZIP。
• 编码器：请参阅下面的编码器配置。

编码器

de.siegmar.logbackgelf.GelfEncoder

• originHost ：原始主机名 - 如果未指定，将自动检测。
• includeRawMessage ：如果为 true，则原始消息（带有参数占位符）也将被发送。默认值：假。
• includeKeyValues ：如果为 true，键值对也会被发送。默认值：true。
• includeMarker ：如果为 true，则也会发送 logback 标记。默认值：假。
• includeMdcData ：如果为 true，MDC 键/值也将被发送。默认值：true。
• includeCallerData ：如果为 true，则调用者数据（源文件、方法、类名和行）也将被发送。默认值：假。
• includeRootCauseData ：如果为 true，则随日志消息传递的异常的根本原因异常将在 root_cause_class_name 和 root_cause_message 字段中公开。默认值：假。
• includeLevelName ：如果为 true，日志级别名称（例如 DEBUG）也将被发送。默认值：假。
• levelNameKey ：应用于日志级别名称的键（即字段名称）。这仅在 includeLevelName 为 true 时才相关。默认值：级别名称。
• loggerNameKey ：应用于记录器名称的键（即字段名称）。默认值：logger_name。
• threadNameKey ：应用于线程名称的键（即字段名称）。默认值：线程名称。
• appendNewline ：如果为 true，则将在每条消息的末尾添加与系统相关的换行符分隔符。不要将其与 TCP/UDP/HTTP 附加程序结合使用，因为这仅适用于控制台日志记录！
• ShortMessageLayout ：短消息格式。默认值： "%m%nopex" 。
• fullMessageLayout ：完整消息格式（Stacktrace）。默认值： "%m%n" 。
• NumbersAsString ：将数字记录为字符串。默认值：假。
• staticFields ：发送到graylog的附加静态字段。默认值：无。

故障排除

如果有任何问题，请启用调试模式并检查日志。

< configuration debug = " true " >
    ...
</ configuration >