Kibana 中的日志记录设置

编辑

Kibana 中的日志记录设置编辑

您无需配置任何其他设置即可使用 Kibana 中的日志记录功能。默认情况下启用日志记录,并将使用 pattern 布局以 info 级别记录日志,该布局将日志输出到 stdout

但是,如果您计划使用 Elasticsearch 或其他工具提取日志,我们建议使用 json 布局,该布局以 ECS 格式生成日志。通常,当人工读取原始日志时,建议使用 pattern 布局,而当机器读取日志时,建议使用 json 布局。

日志记录配置将根据预定义的架构进行验证,如果配置有任何问题,Kibana 将无法启动并显示详细的错误消息。

Kibana 依靠三个高级实体来设置日志记录服务:追加器、记录器和根记录器。这些可以在 kibana.ymllogging 命名空间中配置。

  • 追加器定义日志消息的显示位置(标准输出或控制台)及其布局(patternjson)。它们还允许您指定是否要存储日志,以及如果要存储,存储在何处(磁盘上的文件)。
  • 记录器定义要应用于特定上下文的日志记录设置,例如详细级别和追加器。每个日志条目上下文都提供有关发出该条目的服务或插件及其任何子部分的信息,例如,metrics.opselasticsearch.query
  • 根记录器是一个应用于 Kibana 中所有日志条目的记录器。

下表是不同日志记录配置键的快速参考。请注意,这些不是独立的设置,可能需要额外的日志记录配置。有关常见配置用例,请参阅配置 Kibana 中的日志记录指南和完整的示例

logging.appenders[].<追加器名称>

唯一的追加器标识符。

logging.appenders[].console

用于将记录日志到 stdout 的追加器。默认情况下,使用 [%date][%level][%logger] %message pattern 布局。要使用 json,请将布局类型设置为 json

logging.appenders[].file

允许您指定一个文件名,用于将日志记录写入磁盘。要将所有日志记录写入文件,请将文件追加器添加到 root.appenders。如果已配置,您还需要指定logging.appenders.file.pathName

logging.appenders[].rolling-file

Log4j 的 RollingFileAppender 类似,此追加器将记录到文件并在配置的策略触发时按照滚动策略进行轮换。当前支持两种策略:size-limittime-interval

logging.appenders[].<追加器名称>.type

追加器类型决定了日志消息的发送位置。选项包括 consolefilerewriterolling-file。必需。

logging.appenders[].<追加器名称>.fileName

确定将日志消息写入文件和滚动文件追加器类型的文件路径。对于写入文件的追加器是必需的。

logging.appenders[].<追加器名称>.policy.type

指定何时应为 rolling-file 类型追加器执行滚动的触发策略。

logging.appenders[].<追加器名称>.policy.interval

指定轮换 time-interval 类型 rolling-file 追加器的日志文件的时间间隔。默认值为 24 小时

logging.appenders[].<追加器名称>.policy.size

指定策略应为 size-limit 类型 rolling-file 追加器触发滚动的 size 限制。默认值为 100mb

logging.appenders[].<追加器名称>.policy.interval

指定策略应为 time-interval 类型 rolling-file 追加器触发滚动的 time 间隔。

logging.appenders[].<追加器名称>.policy.modulate

是否应调整间隔以使下一次滚动发生在间隔边界上。布尔值。默认值为 true

logging.appenders[].<追加器名称>.strategy.type

滚动文件策略类型。当前仅支持 numeric

logging.appenders[].<追加器名称>.strategy.pattern

滚动时要追加到文件路径的后缀。必须包含 %i

logging.appenders[].<追加器名称>.strategy.max

要保留的最大文件数。可选。默认值为 7,最大值为 100

logging.appenders[].<追加器名称>.layout.type

确定日志消息的显示方式。选项包括 pattern(提供人类可读的输出)或 json(提供符合 ECS 的输出)。必需。

logging.appenders[].<追加器名称>.layout.highlight

可选的布尔值,用于以彩色突出显示日志消息。仅适用于 pattern 布局。默认值为 false

logging.appenders[].<追加器名称>.layout.pattern

占位符的可选字符串模式,这些占位符将替换为实际日志消息中的数据。仅适用于模式类型布局。

logging.root.appenders[]

要应用于 root 的特定追加器列表。默认为使用 pattern 布局的 console

logging.root.level

指定所有日志消息的默认详细级别,如果未在单个记录器级别进行特定配置,则回退到该级别。选项包括 allfatalerrorwarninfodebugtraceoffalloff 级别只能在配置中使用,它们只是方便的快捷方式,允许您记录每个日志记录或完全禁用日志记录或针对特定记录器禁用日志记录。默认值为 info

logging.loggers[].<记录器>.name

特定的记录器实例。

logging.loggers[].<记录器>.level

指定 <记录器> 上下文的日志消息的详细级别。可选,并继承任何祖先记录器的详细级别,直到 root 记录器 level

logging.loggers[].<记录器>.appenders

确定要应用于特定记录器上下文的追加器,以数组形式表示。可选,如果未指定,则回退到 root 记录器的追加器。