日志记录配置选项

log_level编辑

设置代理的日志记录级别。此选项不区分大小写。

有效选项：OFF、ERROR、CRITICAL、WARN、WARNING、INFO、DEBUG、TRACE

log_file编辑

设置代理日志的路径。特殊值 _AGENT_HOME_ 是 elastic-apm-agent.jar 所在文件夹的占位符。例如：_AGENT_HOME_/logs/elastic-apm.log

当设置为特殊值 *System.out* 时，日志将发送到标准输出。

log_ecs_reformatting ( [1.22.0] 在 1.22.0 中添加。 实验性)编辑

指定代理是否以及如何自动将应用程序日志重新格式化为与 ECS 兼容的 JSON，适合摄取到 Elasticsearch 中以进行进一步的日志分析。此功能适用于 log4j1、log4j2、Logback 和 java.util.logging。ECS 日志行将包含活动的跟踪/事务/错误 ID（如果有）。

默认情况下，此选项仅适用于模式布局/格式化程序。另请参阅 log_ecs_formatter_allow_list。要正确摄取和解析 ECS JSON 日志，请遵循入门指南。

可用选项

有效选项：OFF、SHADE、REPLACE、OVERRIDE

log_ecs_reformatting_additional_fields ( [1.26.0] 在 1.26.0 中添加。 )编辑

以逗号分隔的键值对列表，这些键值对将作为附加字段添加到所有日志事件中。采用格式 key=value[,key=value[,...]]，例如：key1=value1,key2=value2。仅当 log_ecs_reformatting 设置为 OFF 以外的任何选项时才相关。附加字段当前不支持通过代理直接发送日志。

log_ecs_formatter_allow_list编辑

当 log_ecs_reformatting 设置为 OFF 以外的任何选项时，只有与此列表中的项目匹配的格式化程序才会自动重新格式化为 ECS。格式化程序是特定于日志记录框架的实体，负责格式化日志事件。例如，在 log4j 中，它是一个 Layout 实现，而在 Logback 中，它是一个 Encoder 实现。

此选项支持通配符 *，它匹配零个或多个字符。例如：/foo/*/bar/*/baz*、*foo*。默认情况下，匹配不区分大小写。在元素前面加上 (?-i) 会使匹配区分大小写。

log_ecs_reformatting_dir编辑

如果 log_ecs_reformatting 设置为 SHADE 或 REPLACE，则默认情况下，阴影日志文件将与原始日志一起写入同一目录中。使用此配置可以将阴影日志写入备用目标。省略此配置或将其设置为空字符串将恢复默认行为。如果使用相对路径，则此路径将相对于原始日志目录使用。

log_file_size ( [1.17.0] 在 1.17.0 中添加。 )编辑

日志文件的大小。

代理始终保留一个历史文件，以便最大日志文件总大小是此设置值的两倍。

log_format_sout ( [1.17.0] 在 1.17.0 中添加。 )编辑

定义记录到 System.out 时的日志格式。

当设置为 JSON 时，代理将以与 ECS 兼容的 JSON 格式格式化日志，其中每个日志事件都序列化为一行。

有效选项：PLAIN_TEXT、JSON

log_format_file ( [1.17.0] 在 1.17.0 中添加。 )编辑

定义记录到文件时的日志格式。

当设置为 JSON 时，代理将以与 ECS 兼容的 JSON 格式格式化日志，其中每个日志事件都序列化为一行。

有效选项：PLAIN_TEXT、JSON

log_sending ( [1.36.0] 在 1.36.0 中添加。 实验性)编辑

将代理和应用程序日志直接发送到 APM 服务器。

请注意，如果代理无法跟上日志，如果 APM 服务器不可用，或者如果 Elasticsearch 无法足够快地索引日志，则日志可能会丢失。

为了获得更好的交付保证，建议使用 Filebeat 传输 ECS JSON 日志文件。另请参阅 log_ecs_reformatting。日志发送当前不支持自定义 MDC 字段，如果需要自定义 MDC 字段，则必须使用 log_ecs_reformatting 并使用 Filebeat 传输日志。