14.3.6. 在 CLI 里配置 Size 日志处理程序

您可以在 CLI 里添加、删除和编辑 Size 轮换文件日志处理程序。
配置 Size 日志处理程序的主要任务是：
  • 添加新的日志处理程序。
  • 显示日志处理程序的配置
  • 设置处理程序的日志级别。
  • 设置处理程序的附加行为。
  • 设置处理程序是否使用自动冲刷。
  • 设置用于处理程序输出的编码。
  • 指定日志处理程序将写入的文件。
  • 设置用于处理程序输出的格式器。
  • 设置每个日志文件的最大尺寸。
  • 设置要保持的备份日志的最大数目。
  • 为 Size 轮换文件处理程序设置 rotate on boot 选项
  • 删除日志处理程序。
每个任务都将在下面进行描述。

重要

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

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

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

例 14.40. 显示日志处理程序的配置

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

例 14.41. 设置处理程序的日志级别

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

例 14.42. 设置处理程序的附加行为。

[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="append", value="true")
{
    "outcome" => "success",
    "response-headers" => {
        "operation-requires-reload" => true,
        "process-state" => "reload-required"
    }
}
[standalone@localhost:9999 /]
设置处理程序是否使用自动冲刷。
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")
用文件日志处理程序的名称替换 HANDLER。如果处理程序立即写入到输出，则用 true 替换 BOOLEAN。

例 14.43. 设置处理程序是否使用自动冲刷。

[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="autoflush", value="true")
{"outcome" => "success"}
[standalone@localhost:9999 /]
设置用于处理程序输出的编码。
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")
用文件日志处理程序的名称替换 HANDLER，并用所需的字符编码系统替换 ENCODING。

例 14.44. 设置用于处理程序输出的编码。

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

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

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

例 14.46. 设置用于处理程序输出的格式器。

[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p (%c) [%t] %s%E%n")
{"outcome" => "success"}
设置每个日志文件的最大尺寸。
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="rotate-size", value="SIZE")
用文件日志处理程序的名称替换 HANDLER，并用文件大小的最大值替换 SIZE。

例 14.47. 设置每个日志文件的最大尺寸。

[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="rotate-size", value="50m")  
{"outcome" => "success"}
[standalone@localhost:9999 /]
设置要保持的备份日志的最大数目。
请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="max-backup-index", value="NUMBER")
用文件日志处理程序的名称替换 HANDLER，并用要保留的日志文件的数目替换 NUMBER。

例 14.48. 设置要保持的备份日志的最大数目。

[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="max-backup-index", value="5")
{"outcome" => "success"}
[standalone@localhost:9999 /]
为 size-rotating-file-handler 设置 rotate-on-boot 选项
这个选项只用于 size-rotating-file-handler 文件处理程序。它的默认值是 size-rotating-file-handler，表示在服务器重启时不创建新的日志文件。
要修改它，请使用 write-attribute 命令和下列语法。 
 /subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="rotate-on-boot", value="BOOLEAN")
用 size-rotating-file-handler 日志处理程序的名称替换 HANDLER。如果在重启应该创建新的 size-rotating-file-handler 日志文件，则请用 true 替换 BOOLEAN。

例 14.49. 指定在服务器重启时创建新的 size-rotating-file-handler 日志文件。

[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="rotate-on-boot", value="true")
{"outcome" => "success"}
[standalone@localhost:9999 /]
删除日志处理程序
使用 remove 操作和下列语法。 
 /subsystem=logging/size-rotating-file-handler=HANDLER:remove
用文件日志处理程序的名称替换 HANDLER。

例 14.50. 删除日志处理程序

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