11.3.3. Configure a Console Log Handler in the CLI

Console log handlers can be added, removed and edited in the CLI.

Procedure 11.1. Display a console log handler configuration

  • Use the read-resource operation with the following syntax. Replace HANDLER with the name of the console log handler.
     /subsystem=logging/console-handler=HANDLER:read-resource 

    Example 11.12. 

    [standalone@localhost:9999 /] /subsystem=logging/console-handler=CONSOLE:read-resource
    {
        "outcome" => "success",
        "result" => {
            "autoflush" => true,
            "encoding" => undefined,
            "filter" => undefined,
            "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n",
            "level" => "INFO",
            "target" => "System.out"
        }
    }
    [standalone@localhost:9999 /]

Procedure 11.2. Add a Console Log Handler

  • Use the add operation with the following syntax. Replace HANDLER with the console log handler to be added.
     /subsystem=logging/console-handler=HANDLER:add 

    Example 11.13. 

    [standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:add     
    {"outcome" => "success"}
    [standalone@localhost:9999 /]

Procedure 11.3. Set the Log Level

  • Use the change-log-level operation with the following syntax. Replace HANDLER with the name of the console log handler and LEVEL with the log level that is to be set.
     /subsystem=logging/console-handler=HANDLER:change-log-level(level="LEVEL") 

    Example 11.14. 

    [standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:change-log-level(level="TRACE")
    {"outcome" => "success"}
    [standalone@localhost:9999 /]

Procedure 11.4. Set the Target

  • Use the write-attribute operation with the following syntax. Replace HANDLER with the name of the console log handler. Replace TARGET with either System.err or System.out for the system error stream or standard out stream respectively.
     /subsystem=logging/console-handler=HANDLER:write-attribute(name="target", value="TARGET") 

    Example 11.15. 

    [standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="target", value="System.err")
    {"outcome" => "success"}
    [standalone@localhost:9999 /]

Procedure 11.5. Set the Encoding

  • Use the write-attribute operation with the following syntax. Replace HANDLER with the name of the console log handler. Replace ENCODING with the name of the required character encoding system.
     /subsystem=logging/console-handler=HANDLER:write-attribute(name="encoding", value="ENCODING") 

    Example 11.16. 

    [standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="encoding", value="utf-8")     
    {"outcome" => "success"}
    [standalone@localhost:9999 /]

Procedure 11.6. Set the Formatter

  • Use the write-attribute operation with the following syntax. Replace HANDLER with the name of the console log handler. Replace FORMAT with the required formatter string.
     /subsystem=logging/console-handler=HANDLER:write-attribute(name="formatter", value="FORMAT") 

    Example 11.17. 

    [standalone@l/subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"))
    {"outcome" => "success"}
    [standalone@localhost:9999 /]

Procedure 11.7. Set the Auto Flush

  • Use the write-attribute operation with the following syntax. Replace HANDLER with the name of the console log handler. Replace BOOLEAN with true if this handler is to immediately write its output.
     /subsystem=logging/console-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN") 

    Example 11.18. 

    [standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="autoflush", value="true")                                  
    {"outcome" => "success"}
    [standalone@localhost:9999 /]

Procedure 11.8. Remove a Console Log Handler

  • Use the remove operation with the following syntax. Replace HANDLER with the name of the console log handler to be removed.
     /subsystem=logging/console-handler=HANDLER:remove 

    Example 11.19. 

    [standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:remove
    {"outcome" => "success"}
    [standalone@localhost:9999 /]