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，則忽略。
• 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，則忽略。
• 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 >