如何添加 HTTP 标头日志日志

Question

我通读了以下文档，但无法弄清楚我需要什么其他配置：https://github.com/logstash/logstash-logback-encoder#header-fields

我的配置文件：

<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder class="net.logstash.logback.encoder.LogstashEncoder">
<customFields>{"app_name":"${APP_NAME:-N/A}","app_version":"${APP_VERSION:-N/A}","hostname":"${HOST:-N/A}","environment":"${environment:-${ENVIRONMENT:-N/A}}"}</customFields>
<includeContext>false</includeContext>
<timeZone>UTC</timeZone>
</encoder>
<encoder class="net.logstash.logback.encoder.LogstashAccessEncoder">
<fieldNames>
<requestHeaders>request_headers</requestHeaders>
</fieldNames>
</encoder>
<file>${LOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${LOG_FILE_ROTATION:-${LOG_FILE}%d{yyyy-MM-dd}.%i}</fileNamePattern>
<maxHistory>${LOG_FILE_ROTATION_MAX_HISTORY:-1}</maxHistory>
<totalSizeCap>${LOG_FILE_ROTATION_TOTAL_SIZE_CAP:-3GB}</totalSizeCap>
<maxFileSize>${LOG_FILE_ROTATION_MAX_FILE_SIZE:-1GB}</maxFileSize>
</rollingPolicy>
</appender>
<root level="${LOG_LEVEL:-INFO}">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</configuration>

错误：

java.lang.IllegalStateException: Logback configuration error detected: 
ERROR in ch.qos.logback.core.joran.spi.Interpreter@19:29 - no applicable action for [requestHeaders], current ElementPath  is [[configuration][appender][encoder][fieldNames][requestHeaders]]

Answer 1

您提供的 xml 配置文件似乎是用于 logback-classic 的(因为它包含<root level=...(。

logstash-logback-encoder 自动记录请求标头仅适用于通过 logback-access 记录IAccessEvent。

换句话说，请求标头的自动日志记录不适用于通过 logback-classicLogger记录的ILoggingEvent。但是，您可以在使用经典登录时手动包含它们，如下所述。

使用回日志访问记录请求标头

要记录通过 logback 访问记录的IAccessEvent的请求标头，请按照为 tomcat 或码头设置回日志访问的说明进行操作，并将以下内容添加到您的logback-access.xml中。 (请注意，这不是logback-classic 使用logback.xml文件(

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="net.logstash.logback.encoder.LogstashAccessEncoder">
<fieldNames>
<requestHeaders>request_headers</requestHeaders>
</fieldNames>
</encoder>
</appender>
<appender-ref ref="console"/>
</configuration>

此配置已使用 logstash-logback-encoder 5.3 进行了测试。 请注意，在 5.0 之前的 logstash-logback-encoder 版本中，xml 元素名称是不同的，因此请确保在该配置中使用 5.0+。

使用经典日志记录请求标头

logstash-logback-encoder 不为通过 logback-classic 记录请求标头提供一流的支持。 但是，您可以使用特定于事件的自定义字段将它们包含在通过Logger记录的日志事件中。

例如，在有权访问 http 请求的类(如 servlet 过滤器(中，您可以执行以下操作：

Map<String, String> httpHeadersMap = ...; // get http request headers as a map
LOGGER.info("request", StructuredArguments.entries(httpHeadersMap));

并在logback.xml中配置LogbackEncoder，如下所示：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="net.logstash.logback.encoder.LogstashEncoder"/>
</appender>
<root level="info">
<appender-ref ref="console" />
</root>
</configuration>