12.5. 配置日志处理程序


日志处理程序定义如何记录捕获的日志消息。有关配置您需要的日志处理程序类型,请参阅相应的部分。

12.5.1. 配置控制台日志处理程序

本节介绍如何使用管理 CLI 配置控制台日志处理程序。您还可以通过从 Configuration 选项卡中导航到 Logging 子系统,选择 Handler 选项卡并从左侧菜单中选择 Console,来使用管理控制台配置控制台日志处理程序。

配置控制台日志处理程序要执行的主要任务有:

重要

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

另外,如果您在受管域中运行,请在命令前使用 /profile=PROFILE_NAME

添加控制台日志处理程序
/subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:add
配置控制台日志处理程序设置

根据您的需要,您可能需要设置以下一个或多个控制台日志处理程序属性。有关可用控制台日志处理程序属性及其描述的完整列表,请参阅 控制台日志处理程序属性

  • 设置日志级别。

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

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 设置目标。

    为处理程序设置目标,可以是 System.outSystem.errconsole 之一。默认值为 System.out

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=target,value=TARGET)
  • 设置编码。

    设置处理程序的编码,例如 utf-8

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
  • 设置日志格式器。

    设置处理程序的 formatter 字符串。例如,默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必将 FORMAT 值包括在引号中。

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    注意
  • 设置自动清除。

    设置是否在每次写入后自动刷新。默认值为 true

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
  • 设置过滤器表达式。

    设置过滤处理程序的日志消息的表达式。务必转义任何逗号和引号,并用引号括起来。例如,以下 FILTER_EXPRESSION 可替换变量需要替换为 "not (match (\"WFLY\")) ", 用于 不匹配("WFLY"))的过滤器表达式

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

    有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。

将 Console Log Handler 分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

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

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

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

/subsystem=logging/logger=CATEGORY:add-handler(name=CONSOLE_HANDLER_NAME)
删除控制台日志处理程序

可以通过 remove 操作来删除日志处理程序。当前分配给日志记录器或 async 日志处理程序,则无法删除日志处理程序。

/subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:remove

12.5.2. 配置文件日志处理程序

本节介绍如何使用管理 CLI 配置文件日志处理程序。您还可以通过从 Configuration 选项卡导航到 Logging 子系统,选择 Handler 选项卡并从左侧菜单中选择 File,来使用管理控制台配置文件日志处理程序。

配置文件日志处理器时要执行的主要任务有:

重要

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

另外,如果您在受管域中运行,请在命令前使用 /profile=PROFILE_NAME

添加文件日志处理程序

在添加文件日志处理程序时,您必须使用 file 属性指定文件路径,该属性由 pathrelative-to 属性组成。使用 path 属性设置日志的文件路径,包括名称,如 my-log.log。(可选)使用 relative-to 属性来设置路径相对于 指定路径,如 jboss.server.log.dir

/subsystem=logging/file-handler=FILE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})
配置文件日志处理程序设置

根据您的需要,您可能需要设置以下一个或多个文件日志处理程序属性。有关可用文件日志处理程序属性及其描述的完整列表,请参阅 文件日志处理程序属性

  • 设置日志级别。

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

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 设置附加行为。

    默认情况下,JBoss EAP 会在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false,使文件在服务器重启后被覆盖。

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=append,value=APPEND)
  • 设置编码。

    设置处理程序的编码,例如 utf-8

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
  • 设置日志格式器。

    设置处理程序的 formatter 字符串。例如,默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必将 FORMAT 值包括在引号中。

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    注意
  • 设置自动清除。

    设置是否在每次写入后自动刷新。默认值为 true

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
  • 设置过滤器表达式。

    设置过滤处理程序的日志消息的表达式。务必转义任何逗号和引号,并用引号括起来。例如,以下 FILTER_EXPRESSION 可替换变量需要替换为 "not (match (\"WFLY\")) ", 用于 不匹配("WFLY"))的过滤器表达式

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

    有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。

将 File Log Handler 分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

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

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

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

/subsystem=logging/logger=CATEGORY:add-handler(name=FILE_HANDLER_NAME)
删除文件日志处理程序

可以通过 remove 操作来删除日志处理程序。当前分配给日志记录器或 async 日志处理程序,则无法删除日志处理程序。

/subsystem=logging/file-handler=FILE_HANDLER_NAME:remove

12.5.3. 配置定期轮转日志处理程序

本节介绍如何使用管理 CLI 配置定期轮转日志处理程序。您还可以通过从 Configuration 选项卡导航到 Logging 子系统,选择 Handler 选项卡,然后从左侧菜单中选择 Periodic 来配置定期日志处理程序。

配置定期日志处理器您要执行的主要任务有:

重要

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

另外,如果您在受管域中运行,请在命令前使用 /profile=PROFILE_NAME

添加定期日志处理程序

添加定期日志处理程序时,您必须使用 file 属性指定文件路径,该属性由 pathrelative-to 属性组成。使用 path 属性设置日志的文件路径,包括名称,如 my-log.log。(可选)使用 relative-to 属性来设置路径相对于 指定路径,如 jboss.server.log.dir

您还必须使用 suffix 属性为轮转日志设置 后缀。这必须采用可由 java.text.SimpleDateFormat 理解的格式,如 .yyyy-MM-dd-HH。轮转的期间会根据这个后缀自动计算。

/subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)
配置定期日志处理程序设置

根据您的需要,您可能需要设置以下一个或多个定期日志处理程序属性。有关可用定期日志处理程序属性及其描述的完整列表,请参阅 Periodic Log Handler 属性

  • 设置日志级别。

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

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 设置附加行为。

    默认情况下,JBoss EAP 会在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false,使文件在服务器重启后被覆盖。

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=append,value=APPEND)
  • 设置编码。

    设置处理程序的编码,例如 utf-8

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
  • 设置日志格式器。

    设置处理程序的 formatter 字符串。例如,默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必将 FORMAT 值包括在引号中。

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    注意
  • 设置自动清除。

    设置是否在每次写入后自动刷新。默认值为 true

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
  • 设置过滤器表达式。

    设置过滤处理程序的日志消息的表达式。务必转义任何逗号和引号,并用引号括起来。例如,以下 FILTER_EXPRESSION 可替换变量需要替换为 "not (match (\"WFLY\")) ", 用于 不匹配("WFLY"))的过滤器表达式

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

    有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。

将 Periodic Log Handler 分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

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

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

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

/subsystem=logging/logger=CATEGORY:add-handler(name=PERIODIC_HANDLER_NAME)
删除定期日志处理程序

可以通过 remove 操作来删除日志处理程序。当前分配给日志记录器或 async 日志处理程序,则无法删除日志处理程序。

/subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:remove

12.5.4. 配置大小轮转日志处理程序

本节介绍如何使用管理 CLI 配置大小轮转日志处理程序。您还可以通过从 Configuration 选项卡中导航到 Logging 子系统,选择 Handler 选项卡并从左侧菜单中选择 Size,来使用管理控制台配置大小日志处理程序。

配置大小日志处理程序要执行的主要任务有:

重要

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

另外,如果您在受管域中运行,请在命令前使用 /profile=PROFILE_NAME

添加大小日志处理程序

在添加大小日志处理程序时,您必须使用 file 属性指定文件路径,该属性由 pathrelative-to 属性组成。使用 path 属性设置日志的文件路径,包括名称,如 my-log.log。(可选)使用 relative-to 属性来设置路径相对于 指定路径,如 jboss.server.log.dir

/subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})
配置大小日志处理程序设置

根据您的需要,您可能需要设置以下一个或多个大小日志处理程序属性。有关可用大小日志处理程序属性及其描述的完整列表,请参阅 大小日志处理程序属性

  • 设置日志级别。

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

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 为轮转日志设置后缀。

    设置后缀字符串,其格式为 java.text.SimpleDateFormat,如 .yyyy-MM-dd-HH。轮转的期间会根据这个后缀自动计算。

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=suffix, value=SUFFIX)
  • 设置轮转大小。

    设置文件在轮转前可以达到的最大大小。默认值为 2m,2m 表示 2MB。

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)
  • 设置要保留的最大备份日志数。

    设置要保留的备份数量。默认值为 1

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)
  • 设置是否在引导时轮转日志。

    默认情况下,在服务器重启时不会创建新的日志文件。您可以将其设置为 true,以在服务器重启时轮转日志。

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)
  • 设置附加行为。

    默认情况下,JBoss EAP 会在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false,使文件在服务器重启后被覆盖。

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)
  • 设置编码。

    设置处理程序的编码,例如 utf-8

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
  • 设置日志格式器。

    设置处理程序的 formatter 字符串。例如,默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必将 FORMAT 值包括在引号中。

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    注意
  • 设置自动清除。

    设置是否在每次写入后自动刷新。默认值为 true

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
  • 设置过滤器表达式。

    设置过滤处理程序的日志消息的表达式。务必转义任何逗号和引号,并用引号括起来。例如,以下 FILTER_EXPRESSION 可替换变量需要替换为 "not (match (\"WFLY\")) ", 用于 不匹配("WFLY"))的过滤器表达式

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

    有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。

将 Size Log Handler 分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

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

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

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

/subsystem=logging/logger=CATEGORY:add-handler(name=SIZE_HANDLER_NAME)
删除大小日志处理程序

可以通过 remove 操作来删除日志处理程序。当前分配给日志记录器或 async 日志处理程序,则无法删除日志处理程序。

/subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:remove

12.5.5. 配置定期大小轮转日志处理程序

本节介绍如何使用管理 CLI 配置定期大小轮转日志处理程序。您还可以通过导航到 Logging 子系统,选择 Handler 选项卡,然后从左侧菜单中选择 Periodic Size,来使用管理控制台配置定期大小日志处理程序。

配置定期日志处理器时要执行的主要任务有:

重要

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

另外,如果您在受管域中运行,请在命令前使用 /profile=PROFILE_NAME

添加定期大小日志处理程序

添加定期大小日志处理程序时,您必须使用 file 属性指定文件路径,该属性由 pathrelative-to 属性组成。使用 path 属性设置日志的文件路径,包括名称,如 my-log.log。(可选)使用 relative-to 属性来设置路径相对于 指定路径,如 jboss.server.log.dir

您还必须使用 suffix 属性为轮转日志设置 后缀。这必须采用可由 java.text.SimpleDateFormat 理解的格式,如 .yyyy-MM-dd-HH。轮转的期间会根据这个后缀自动计算。

/subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)
配置定期大小日志处理程序设置

根据您的需要,您可能需要设置以下定期大小日志处理程序属性的一个或多个。有关可用定期大小日志处理程序属性及其描述的完整列表,请参阅 Periodic Size Log Handler 属性

  • 设置日志级别。

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

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 设置轮转大小。

    设置文件在轮转前可以达到的最大大小。默认值为 2m,2m 表示 2MB。

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)
  • 设置要保留的最大备份日志数。

    设置要保留的备份数量。默认值为 1

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)
  • 设置是否在引导时轮转日志。

    默认情况下,在服务器重启时不会创建新的日志文件。您可以将其设置为 true,以在服务器重启时轮转日志。

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)
  • 设置附加行为。

    默认情况下,JBoss EAP 会在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false,使文件在服务器重启后被覆盖。

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)
  • 设置编码。

    设置处理程序的编码,例如 utf-8

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
  • 设置日志格式器。

    设置处理程序的 formatter 字符串。例如,默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必将 FORMAT 值包括在引号中。

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    注意
  • 设置自动清除。

    设置是否在每次写入后自动刷新。默认值为 true

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
  • 设置过滤器表达式。

    设置过滤处理程序的日志消息的表达式。务必转义任何逗号和引号,并用引号括起来。例如,以下 FILTER_EXPRESSION 可替换变量需要替换为 "not (match (\"WFLY\")) ", 用于 不匹配("WFLY"))的过滤器表达式

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

    有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。

将 Periodic Size Log Handler 分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

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

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

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

/subsystem=logging/logger=CATEGORY:add-handler(name=PERIODIC_SIZE_HANDLER_NAME)
删除定期大小日志处理程序

可以通过 remove 操作来删除日志处理程序。当前分配给日志记录器或 async 日志处理程序,则无法删除日志处理程序。

/subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:remove

12.5.6. 配置 Syslog 处理程序

本节介绍如何使用管理 CLI 配置 syslog 处理程序,该处理程序可用于发送消息到支持 Syslog 协议(RFC-3164 或 RFC-5424)的远程日志记录服务器。您还可以通过从 Configuration 选项卡导航到 Logging 子系统,选择 Handler 选项卡并从左侧菜单中选择 Syslog 来配置 syslog 处理程序。

配置 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 处理程序属性

  • 设置处理程序的日志级别。默认级别为 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)
将 Syslog Handler 分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

以下管理 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 操作来删除日志处理程序。当前分配给日志记录器或 async 日志处理程序,则无法删除日志处理程序。

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

12.5.7. 配置自定义日志处理程序

本节介绍如何使用管理 CLI 配置自定义日志处理程序。您还可以通过从 Configuration 选项卡导航到 Logging 子系统,选择 Handler 选项卡并从左侧菜单中选择 Custom,来使用管理控制台配置自定义日志处理程序。

配置自定义日志处理器您要执行的主要任务有:

重要

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

另外,如果您在受管域中运行,请在命令前使用 /profile=PROFILE_NAME

添加自定义日志处理程序

添加自定义日志处理程序时,您必须指定处理程序的 Java 类以及其中包含的 JBoss EAP 模块。类必须扩展 java.util.logging.Handler

注意
/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:add(class=CLASS_NAME,module=MODULE_NAME)
配置自定义日志处理程序设置

根据您的需要,您可能需要设置以下一个或多个自定义日志处理程序属性。有关可用自定义日志处理程序属性及其描述的完整列表,请参阅 自定义日志处理程序属性

  • 设置日志级别。

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

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 设置属性。

    设置日志处理程序的必要属性。属性必须能够通过 setter 方法访问。

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=properties.PROPERTY_NAME,value=PROPERTY_VALUE)
  • 设置编码。

    设置处理程序的编码,例如 utf-8

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
  • 设置日志格式器。

    设置处理程序的 formatter 字符串。例如,默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必将 FORMAT 值包括在引号中。

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    注意
  • 设置过滤器表达式。

    设置过滤处理程序的日志消息的表达式。务必转义任何逗号和引号,并用引号括起来。例如,以下 FILTER_EXPRESSION 可替换变量需要替换为 "not (match (\"WFLY\")) ", 用于 不匹配("WFLY"))的过滤器表达式

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

    有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。

将自定义日志处理程序分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

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

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

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

/subsystem=logging/logger=CATEGORY:add-handler(name=CUSTOM_HANDLER_NAME)
删除自定义日志处理程序

可以通过 remove 操作来删除日志处理程序。当前分配给日志记录器或 async 日志处理程序,则无法删除日志处理程序。

/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:remove

12.5.8. 配置 Async 日志处理程序

本节介绍如何使用管理 CLI 配置 async 日志处理程序。您还可以通过从 Configuration 选项卡导航到 Logging 子系统,选择 Handler 选项卡并从左侧菜单中选择 Async,来使用管理控制台配置 async 日志处理程序。

配置 async 日志处理器时要执行的主要任务有:

重要

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

另外,如果您在受管域中运行,请在命令前使用 /profile=PROFILE_NAME

添加异步日志处理程序

添加 async 日志处理程序时,您必须指定队列长度。这是队列中可以保存的日志请求的最大数量。

/subsystem=logging/async-handler=ASYNC_HANDLER_NAME:add(queue-length=QUEUE_LENGTH)
添加 Sub-handler

您可以将一个或多个处理程序添加为此 async 日志处理程序的子处理程序。请注意,处理程序必须已存在于配置中,否则此命令将失败。

/subsystem=logging/async-handler=ASYNC_HANDLER_NAME:add-handler(name=HANDLER_NAME)
配置同步日志处理程序设置

根据您的需要,您可能需要设置以下一个或多个 async 日志处理程序属性。有关可用 async 日志处理程序属性及其描述的完整列表,请参阅 Async Log Handler 属性

  • 设置日志级别。

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

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
  • 设置溢出操作。

    将操作设置为溢出时要执行的操作。默认值为 BLOCK,这意味着线程将在完整队列时阻止。您可以将此值更改为 DISCARD,这意味着当完整队列出现日志消息时,将丢弃日志消息。

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=overflow-action,value=OVERFLOW_ACTION)
  • 设置过滤器表达式。

    设置过滤处理程序的日志消息的表达式。务必转义任何逗号和引号,并用引号括起来。例如,以下 FILTER_EXPRESSION 可替换变量需要替换为 "not (match (\"WFLY\")) ", 用于 不匹配("WFLY"))的过滤器表达式

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

    有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。

将 Async Log Handler 分配给 Logger

要让日志处理程序处于活动状态,您必须将它分配给日志记录器。

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

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

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

/subsystem=logging/logger=CATEGORY:add-handler(name=ASYNC_HANDLER_NAME)
删除异步日志处理程序

可以通过 remove 操作来删除日志处理程序。当前分配给日志记录器,则无法删除日志处理程序。

/subsystem=logging/async-handler=ASYNC_HANDLER_NAME:remove
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.