11.5.6. 配置 Syslog 处理程序

本节介绍如何使用管理 CLI 配置 syslog 处理程序,该 CLI 可用于将消息发送到支持 Syslog 协议的远程记录服务器,可以是 RFC-3164 或 RFC-5424。您还可以使用管理控制台配置 syslog 处理程序,方法是导航到 ConfigurationSubsystemsLoggingConfiguration,点 View,然后选择 HandlerSyslog Handler

在配置 syslog 处理程序时要执行的主要任务有:

重要

如果您要为日志记录配置集配置此日志处理程序,则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/

此外,如果您在受管域中运行,请在命令前加上 /profile=PROFILE_NAME

添加 Syslog 处理程序
/subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:add
配置 Syslog 处理程序设置

根据您的需要,您可能需要设置以下一个或多个 syslog 处理程序属性:有关可用 syslog 处理程序属性及其描述的完整列表,请参阅 Syslog Handler Attributes

  • 设置处理程序的日志级别。默认级别为 ALL有关所有可用选项,请参阅日志级别

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 设置正在记录的应用的名称。默认名称为 java

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=app-name,value=APP_NAME)
  • 设置 syslog 服务器的地址。默认地址为 localhost

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=server-address,value=SERVER_ADDRESS)
  • 设置 syslog 服务器的端口。默认端口为 514

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=port,value=PORT)
  • 设置 syslog 格式,如 RFC 规范所定义。默认格式为 RFC5424

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=syslog-format,value=SYSLOG_FORMAT)
  • 指定 named-formatter 属性,以格式化 syslog 有效负载的消息。

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=named-formatter, value=FORMATTER_NAME)
将 Syslog Handler 分配给日志记录器

要激活日志处理程序,您必须将其分配到日志记录器。

以下管理 CLI 命令将 syslog 处理程序分配给根日志记录器:

/subsystem=logging/root-logger=ROOT:add-handler(name=SYSLOG_HANDLER_NAME)

以下管理 CLI 命令将 syslog 处理程序分配给名称由 CATEGORY 指定的日志记录器:

/subsystem=logging/logger=CATEGORY:add-handler(name=SYSLOG_HANDLER_NAME)
删除 Syslog 处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序,则无法移除日志处理程序。

/subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:remove