14.3.5. 在 CLI 里配置定期日志处理程序

您可以在 CLI 里添加、删除和编辑定期日志处理程序。
配置定期日志处理程序的主要任务是：
  • 添加新的定期日志处理程序。
  • 显示定期日志处理程序的配置
  • 设置处理程序的日志级别。
  • 设置处理程序的附加行为。
  • 设置处理程序是否使用自动冲刷。
  • 设置用于处理程序输出的编码。
  • 指定日志处理程序将写入的文件。
  • 设置用于处理程序输出的格式器。
  • 设置用于轮换日志的后缀
  • 删除定期日志处理程序。
每个任务都将在下面进行描述。

重要

当在日志配置集里配置日志处理程序时，配置路径的根目录是 /subsystem=logging/logging-profile=NAME/ 而不是/subsystem=logging/。
添加新的定期轮换文件日志处理程序
使用 add 操作和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:add(file={"path"=>"PATH", "relative-to"=>"DIR"}, suffix="SUFFIX")
用日志文件的名称替换 HANDLER。用写入的日志文件的名称替换 PATH。用文件所在的目录的名称替换 DIR。DIR 的值可以是一个路径变量。用轮换后缀替换 SUFFIX。

例 14.29. 添加新的日志处理程序

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:add(file={"path"=>"daily-debug.log", "relative-to"=>"jboss.server.log.dir"}, suffix=".yyyy.MM.dd")
{"outcome" => "success"}
[standalone@localhost:9999 /]
显示定期轮换文件日志处理程序的配置
使用 read-resource 操作和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:read-resource
用文件日志处理程序的名称替换 HANDLER。

例 14.30. 使用 read-resource 操作

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:read-resource
{
    "outcome" => "success",
    "result" => {
        "append" => true,
        "autoflush" => true,
        "encoding" => undefined,
        "file" => {
            "path" => "daily-debug.log",
            "relative-to" => "jboss.server.log.dir"
        },
        "filter" => undefined,
        "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n",
        "level" => undefined
    }
}
设置日志级别
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="level". value="LOG_LEVEL_VALUE")
用定期日志处理程序的名称替换 HANDLER，并用日志级别替换 LOG_LEVEL_VALUE。

例 14.31. 设置日志级别

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="level", value="DEBUG")
{"outcome" => "success"}
设置附加行为
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/periodic-rotating-handler=HANDLER:write-attribute(name="append", value="BOOLEAN")
用定期日志处理程序的名称替换 HANDLER。如果要求每次启动服务器时都创建新的日志文件，则用 false 替换 BOOLEAN。如果应用服务器应该继续使用相同的文件，则请用 true 替换 BOOLEAN。
重启 JBoss EAP 6 服务器以使修改生效。

例 14.32. 设置附加行为

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="append", value="true")
{
    "outcome" => "success",
    "response-headers" => {
        "operation-requires-reload" => true,
        "process-state" => "reload-required"
    }
}
设置自动冲刷
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")
用定期日志处理程序的名称替换 HANDLER。如果处理程序立即写入到输出，则用 true 替换 BOOLEAN。
重启 JBoss EAP 6 服务器以使修改生效。

例 14.33. 设置自动冲刷行为

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="autoflush", value="false")
{
    "outcome" => "success",
    "response-headers" => {"process-state" => "reload-required"}
}
设置编码
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")
用定期日志处理程序的名称替换 HANDLER，并用所需的字符编码系统替换 ENCODING。

例 14.34. 设置编码

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="encoding", value="utf-8")     
{"outcome" => "success"}
指定日志处理程序将写入的文件
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="file", value={"path"=>"PATH", "relative-to"=>"DIR"})
用定期文件的名称替换 HANDLER。用写入的日志文件的名称替换 PATH。用文件所在的目录的名称替换 DIR。DIR 的值可以是一个路径变量。

例 14.35. 指定日志处理程序将写入的文件

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="file", value={"path"=>"daily-debug.log", "relative-to"=>"jboss.server.log.dir"})
{"outcome" => "success"}
设置格式器
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="formatter", value="FORMAT")
用定期日志处理程序的名称替换 HANDLER，并用格式器字符串替换 FORMAT。

例 14.36. 设置格式器

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n")
{"outcome" => "success"}
[standalone@localhost:9999 /]
设置用于轮换日志的后缀
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="suffix", value="SUFFIX")
用日志处理程序的名称替换 HANDLER，并用所需的后缀替换 SUFFIX。

例 14.37. 

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="suffix", value=".yyyy-MM-dd-HH")
{"outcome" => "success"}
[standalone@localhost:9999 /]
删除定期日志处理程序
使用 remove 操作和下列语法。 
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:remove
用定期日志处理程序的名称替换 HANDLER。

例 14.38. 删除定期日志处理程序

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:remove
{"outcome" => "success"}
[standalone@localhost:9999 /]
提交 bug 报告