Chapter 10. Logging with JBoss EAP

Procedure

1. Set the language by adding the user.language property to the JAVA_OPTS variable. For example, to set the locale to French, add the following line to the startup configuration file:

   Copy to Clipboard Toggle word wrap

   JAVA_OPTS="$JAVA_OPTS -Duser.language=fr"

2. Set the language and country by adding the user.language and user.country properties. For example, to set the locale to Brazilian Portuguese, add the following line:

   Copy to Clipboard Toggle word wrap

   JAVA_OPTS="$JAVA_OPTS -Duser.language=pt -Duser.country=BR"

3. Set the server locale using the o`rg.jboss.logging.locale` property to specify a different locale for log messages. This overrides the default locale for logging. For example, to set the server locale to Brazilian Portuguese, add the following line:

   Copy to Clipboard Toggle word wrap

   JAVA_OPTS="$JAVA_OPTS -Dorg.jboss.logging.locale=pt-BR"

   This property affects only log messages that use JBoss Logging and its dependencies. Other dependencies, such as Jakarta Server Faces, cannot get an overridden locale.

   Note

   To start JBoss EAP with a different locale than the system default, edit EAP_HOME/bin/standalone.conf for standalone mode or EAP_HOME/bin/domain.conf for managed domain mode. Use the org.jboss.logging.locale property to set the locale in BCP 47 format.

Procedure

1. Log in to the management console.
2. Select the Runtime tab and choose the appropriate server.
3. Select Log Files and choose a log file from the list.

4. Click View to open and search the log contents, or choose Download from the dropdown to save the log file to your local file system.

   Warning

   The management console log viewer is not designed for very large log files, for example, greater than 100MB. You will receive a confirmation prompt if you attempt to open a log file larger than 15MB. Opening a very large file in the management console may crash your browser. It is recommended to download large log files and open them in a text editor.

Procedure

1. Use the following command to read the contents of a log file:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/log-file=LOG_FILE_NAME:read-log-file

   Note

   In a managed domain, precede this command with /host=HOST_NAME/server=SERVER_NAME.

2. Customize the log output using the following parameters:

   • encoding: Specify the character encoding used to read the file.
   • lines: Set the number of lines to read from the file. A value of -1 will read all log lines. The default is 10.
   • skip: Specify the number of lines to skip before reading. The default is 0.
   • tail: Set whether to read from the end of the file. Defaults to true.

Procedure

1. Add a log category by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/logger=LOG_CATEGORY:add

2. You can set one or more of the following log category attributes based on your needs:

   • Set the log level for the log category by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/logger=LOG_CATEGORY:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set whether this category should use the log handlers of the root logger by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/logger=LOG_CATEGORY:write-attribute(name=use-parent-handlers,value=USE_PARENT_HANDLERS)

     By default, log categories use the handlers of the root logger in addition to their own. Set the use-parent-handlers attribute to false to ensure the log category uses only its assigned handlers.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/logger=LOG_CATEGORY:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

     Specify the expression to filter log messages for the log category. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to set a filter expression of not(match("WFLY")).

Procedure

1. Assign a log handler to the log category by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/logger=LOG_CATEGORY:add-handler(name=LOG_HANDLER_NAME)

2. If needed, you can remove a log category by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/logger=LOG_CATEGORY:remove

   Note

   You can remove a log category when it is no longer required for your logging configuration.

Procedure

1. Add a console log handler by using the following command:

   Copy to Clipboard Toggle word wrap

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

2. You can set one or more of the following console log handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the target for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=target,value=TARGET)

     The target can be System.out, System.err, or console. The default is System.out.

   • Set the encoding for the handler, such as utf-8, by using the following command.

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set the formatter string for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

     For example, the default format string is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n. Enclose the FORMAT value in quotation marks.

     Note

     Use the named-formatter attribute if you want to reference a saved formatter.

   • Set auto flush by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

     Specify whether to automatically flush after each write. The default value is true.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

3. Assign the console log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the console log handler to the root logger or any other logger.

4. If needed, you can remove a log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add a file log handler by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/file-handler=FILE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})

   Note

   When you add a file log handler, specify the file path using the file attribute, which consists of the path and relative-to attributes. Use the path attribute to set the log file path, including the file name, for example, my-log.log. Optionally, use the relative-to attribute to indicate that the path is relative to a named path, such as jboss.server.log.dir.

2. You can set one or more of the following file log handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the append behavior for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=append,value=APPEND)

     Set the append attribute to false to overwrite the file upon server restart. By default, JBoss EAP appends log messages to the same file when the server restarts.

   • Set the encoding for the handler, such as utf-8, by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set the formatter string for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

     For example, the default format string is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n. Enclose the FORMAT value in quotation marks.

     Note

     Use the named-formatter attribute if you want to reference a saved formatter.

   • Set auto flush by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

     Specify whether to automatically flush after each write. The default value is true.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

3. Assign the file log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the file log handler to the root logger or any other logger.

4. Assign the file log handler to a specific logger named CATEGORY by using the following command:

   Copy to Clipboard Toggle word wrap

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

   Replace CATEGORY with the name of the logger to which you want to assign the file log handler.

5. If needed, you can remove a log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add a periodic rotating log handler by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)

   Note

   When you add a periodic rotating log handler, specify the file path using the file attribute, which consists of the path and relative-to attributes. Use the path attribute to set the log file path, including the file name, for example, my-log.log. Optionally, use the relative-to attribute to indicate that the path is relative to a named path, such as jboss.server.log.dir.

   You must set the suffix for rotated logs by using the suffix attribute. The suffix must follow a format that java.text.SimpleDateFormat can understand, such as .yyyy-MM-dd-HH. The rotation period is automatically calculated based on this suffix.

2. You can set one or more of the following periodic rotating log handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the append behavior for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=append,value=APPEND)

     Set the append attribute to false to overwrite the file upon server restart. By default, JBoss EAP appends log messages to the same file when the server restarts.

   • Set the encoding for the handler, such as utf-8, by using the following command.

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set the formatter string for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

     For example, the default format string is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n. Enclose the FORMAT value in quotation marks.

     Note

     Use the named-formatter attribute if you want to reference a saved formatter.

   • Set auto flush by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

     Specify whether to automatically flush after each write. The default value is true.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

3. Assign the periodic rotating log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the periodic rotating log handler to the root logger or any other logger.

4. If needed, you can remove a log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add a size log handler by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})

   Note

   When you add a size log handler, specify the file path using the file attribute, which consists of the path and relative-to attributes. Use the path attribute to set the log file path, including the file name, for example, my-log.log. Optionally, use the relative-to attribute to indicate that the path is relative to a named path, such as jboss.server.log.dir.

2. You can set one or more of the following size log handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the suffix for rotated logs by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=suffix, value=SUFFIX)

     Note

     If specified, the suffix must follow a format that java.text.SimpleDateFormat can understand, such as .yyyy-MM-dd-HH. The suffix is optional for the size-rotating-file-handler. It indicates when the file was rotated, not the rotation period itself.

   • Set the encoding for the handler, such as utf-8, by using the following command.

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set the rotation size by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)

     Set the maximum file size before rotation. The default is 2m for 2 megabytes.

   • Set the maximum number of backup logs to keep by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)

     Specify the number of backups to retain. The default is 1.

     Note

     Rotation occurs based on the size limit, not the suffix. If a suffix is defined, it is added to the rotated files, but those files will not be deleted. Only files that reach the size limit are deleted during rotation.

   • Set whether to rotate the log on boot by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)

     By default, a new log file is not created on server restart. Set this to true to rotate the log when the server restart.

   • Set the append behavior for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)

     Set the append attribute to false to overwrite the file upon server restart. By default, JBoss EAP appends log messages to the same file when the server restarts.

   • Set the encoding for the handler, such as utf-8, by using the following command.

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set the formatter string for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

     For example, the default format string is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n. Enclose the FORMAT value in quotation marks.

     Note

     Use the named-formatter attribute if you want to reference a saved formatter.

   • Set auto flush by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

     Specify whether to automatically flush after each write. The default value is true.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

3. Assign the size log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the size log handler to the root logger or any other logger.

4. If needed, you can remove a log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add a periodic size log handler by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)

   Note

   When you add a periodic size log handler, specify the file path using the file attribute, which consists of the path and relative-to attributes. Use the path attribute to set the log file path, including the file name, for example, my-log.log. Optionally, use the relative-to attribute to indicate that the path is relative to a named path, such as jboss.server.log.dir.

   You must set the suffix for rotated logs by using the suffix attribute. The suffix must follow a format that java.text.SimpleDateFormat can understand, such as .yyyy-MM-dd-HH. The rotation period is automatically calculated based on this suffix.

2. You can set one or more of the following periodic size log handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the rotation size by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)

     Set the maximum file size before rotation. The default is 2m for 2 megabytes.

   • Set the maximum number of backup logs to keep by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)

     Specify the number of backups to retain. The default is 1.

     Note

     When rotated by the suffix, the rotated files will not be deleted. Only files that reach the size limit when rotated will be deleted during rotation.

   • Set whether to rotate the log on boot by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)

     By default, a new log file is not created on server restart. Set this to true to rotate the log when the server restart.

   • Set the append behavior for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)

     Set the append attribute to false to overwrite the file upon server restart. By default, JBoss EAP appends log messages to the same file when the server restarts.

   • Set the encoding for the handler, such as utf-8, by using the following command.

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set the formatter string for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

     For example, the default format string is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n. Enclose the FORMAT value in quotation marks.

     Note

     Use the named-formatter attribute if you want to reference a saved formatter.

   • Set auto flush by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

     Specify whether to automatically flush after each write. The default value is true.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

3. Assign the periodic size log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the periodic size log handler to the root logger or any other logger.

4. If needed, you can remove a log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add a syslog handler by using the following command:

   Copy to Clipboard Toggle word wrap

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

2. You can set one or more of the following syslog handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the application name for logging by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=app-name,value=APP_NAME)

     The default application name is java.

   • Set the address of the syslog server by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=server-address,value=SERVER_ADDRESS)

     The default address is localhost.

   • Set the port of the syslog server by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=port,value=PORT)

     The default port is 514.

   • Set the syslog format according to an RFC specification by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=syslog-format,value=SYSLOG_FORMAT)

     The default format is RFC5424.

   • Specify the named-formatter attribute to format the syslog payload message by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=named-formatter, value=FORMATTER_NAME)

3. Assign the syslog handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the syslog handler to the root logger or any other logger.

4. If needed, you can remove a log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add the socket binding by using the following command:

   Copy to Clipboard Toggle word wrap

   /socket-binding-group=SOCKET_BINDING_GROUP/remote-destination-outbound-socket-binding=SOCKET_BINDING_NAME:add(host=HOST, port=PORT)

   Note

   You can define either a remote-destination-outbound-socket-binding or local-destination-outbound-socket-binding as the socket binding to use.

2. Add the log formatter to use, such as a JSON formatter, by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/json-formatter=FORMATTER:add

3. Add the socket log handler by specifying the socket binding and formatter to use by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:add(outbound-socket-binding-ref=SOCKET_BINDING_NAME,named-formatter=FORMATTER)

4. You can set one or more of the following socket log handler attributes based on your needs:

   • Set the protocol by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=protocol,value=PROTOCOL)

     The default protocol is TCP.

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

     Note

     During server startup, log messages handled by a socket log handler are queued until the socket binding is configured and the logging subsystem is initialized. If the log level is set low, such as TRACE or DEBUG, it can result in large memory consumption during startup.

   • Set the encoding for the handler, such as utf-8, by using the following command.

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set auto flush by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

     Specify whether to automatically flush after each write. The default value is true.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

5. Assign the socket log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the socket log handler to the root logger or any other logger.

6. If needed, you can remove a socket log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:remove

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add a custom log handler by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:add(class=CLASS_NAME,module=MODULE_NAME)

   Note

   When you add a custom log handler, specify the Java class of the handler and the JBoss EAP module that contains it. The class must extend java.util.logging.Handler.

   Ensure you have created a module containing the custom logger or this command will fail.

2. You can set one or more of the following custom log handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the properties for the log handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=properties.PROPERTY_NAME,value=PROPERTY_VALUE)

     The properties must be accessible using a setter method.

   • Set the encoding for the handler, such as utf-8, by using the following command.

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)

   • Set the formatter string for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

     For example, the default format string is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n. Enclose the FORMAT value in quotation marks.

     Note

     Use the named-formatter attribute if you want to reference a saved formatter.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

3. Assign the custom log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the handler to the root logger or any other logger.

4. Assign the custom log handler to a specific logger named CATEGORY by using the following command:

   Copy to Clipboard Toggle word wrap

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

   Replace CATEGORY with the name of the logger to which you want to assign the custom log handler.

5. If needed, you can remove a custom log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger or an async log handler.

Procedure

1. Add an async log handler by using the following command:

   Copy to Clipboard Toggle word wrap

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

   Note

   When you add an async log handler, specify the queue length, which is the maximum number of log requests that can be held in the queue at any given time.

2. Add a sub-handler by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:add-handler(name=HANDLER_NAME)

   Note

   You can add one or more handlers as sub-handlers for this async log handler. The handlers must already exist in the configuration or this command will fail.

3. You can set one or more of the following async log handler attributes based on your needs:

   • Set the log level for the handler by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

     The default is ALL.

   • Set the overflow action by using the following command:

     Copy to Clipboard Toggle word wrap

     /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=overflow-action,value=OVERFLOW_ACTION)

     The default value is BLOCK, which means that threads will block if the queue is full. You can change this value to DISCARD, which means that the oldest log messages will be deleted to accommodate new messages in the event of a full queue.

   • Set the filter expression by using the following command:

     Copy to Clipboard Toggle word wrap

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

     Specify the expression to filter log messages for the handler. Escape any commas and quotation marks, and surround the expression with quotation marks. For example, replace the FILTER_EXPRESSION variable with "not(match(\"WFLY\"))" to create a filter expression of not(match("WFLY")).

4. Assign the async log handler to a logger by using the following command:

   Copy to Clipboard Toggle word wrap

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

   To activate the log handler, you can assign the async log handler to the root logger or any other logger.

5. If needed, you can remove an async log handler by using the remove operation with the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:remove

   Note

   You can remove a log handler when it is no longer required for your logging configuration. However, a log handler cannot be removed if it is currently assigned to a logger.

Procedure

1. Create a pattern formatter by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/pattern-formatter=PATTERN_FORMATTER_NAME:add(pattern=PATTERN)

   When defining a pattern formatter, provide a pattern string to format log messages. For example, the default configuration uses the following log formatter string for server log messages: %d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n.

   Example

   Copy to Clipboard Toggle word wrap

   2016-03-18 15:49:32,075 INFO  [org.jboss.as] (Controller Boot Thread) WFLYSRV0051: Admin console listening on http://127.0.0.1:9990

2. Set the color map for a pattern formatter by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/pattern-formatter=PATTERN_FORMATTER_NAME:write-attribute(name=color-map,value="LEVEL:COLOR,LEVEL:COLOR")

   Define a color map to assign a color to different log levels. The format is a comma-separated list of LEVEL:COLOR.

   • Valid levels: finest, finer, fine, config, trace, debug, info, warning, warn, error, fatal, severe
   • Valid colors: black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite

Procedure

1. Add a JSON log formatter.

   Example

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/json-formatter=JSON_FORMATTER_NAME:add(pretty-print=true, exception-output-type=formatted)

   Expected output

   Copy to Clipboard Toggle word wrap

   {
       "timestamp": "2018-10-18T13:53:43.031-04:00",
       "sequence": 62,
       "loggerClassName": "org.jboss.as.server.logging.ServerLogger_$logger",
       "loggerName": "org.jboss.as",
       "level": "INFO",
       "message": "WFLYSRV0025: JBoss EAP 8.1.0.GA (WildFly Core 21.0.5.Final-redhat-00001) started in 5227ms - Started 317 of 556 services (343 services are lazy, passive or on-demand),
       "threadName": "Controller Boot Thread",
       "threadId": 22,
       "mdc": {
       },
       "ndc": "",
       "hostName": "localhost.localdomain",
       "processName": "jboss-modules.jar",
       "processId": 7461
   }

2. Add a Logstash JSON log formatter by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/json-formatter=logstash:add(exception-output-type=formatted, key-overrides=[timestamp="@timestamp"], meta-data=[@version=1])

   Note

   You can modify the JSON log formatter output keys and add static metadata. The primary purpose of the JSON log formatter is to format log messages in JSON. Logstash consumes this JSON output and searches for the @timestamp and @version fields. The following example creates a JSON log formatter that formats messages for Logstash.

   You can use the JSON formatter attributes as follows:

   • The key-overrides attribute overrides the names of the defined keys.
   • Format exceptions as objects by setting the exception-output-type attribute to formatted.
   • Include the exception stack trace by setting the exception-output-type attribute to detailed.
   • Format exceptions as objects and include stack traces by setting the exception-output-type to detailed-and-formatted.
   • Add metadata to log records using the meta-data attribute.

Procedure

1. Add an XML log formatter.

   Example

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/xml-formatter=XML_FORMATTER_NAME:add(pretty-print=true, exception-output-type=detailed-and-formatted)

   Expected output

   Copy to Clipboard Toggle word wrap

   <record>
       <timestamp>2018-10-18T13:55:53.419-04:00</timestamp>
       <sequence>62</sequence>
       <loggerClassName>org.jboss.as.server.logging.ServerLogger_$logger</loggerClassName>
       <loggerName>org.jboss.as</loggerName>
       <level>INFO</level>
       <message>WFLYSRV0025: {ProductCurrentVersionExamples} (WildFly Core 10.0.0.Final-redhat-20190924) started in 6271ms - Started 495 of 679 services (331 services are lazy, passive or on-demand)</message>
       <threadName>Controller Boot Thread</threadName>
       <threadId>22</threadId>
       <mdc>
       </mdc>
       <ndc></ndc>
       <hostName>localhost.localdomain</hostName>
       <processName>jboss-modules.jar</processName>
       <processId>7790</processId>
   </record>

2. Add a key override XML log formatter by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/xml-formatter=XML_FORMATTER_NAME:add(pretty-print=true, print-namespace=true, namespace-uri="urn:custom:1.0", key-overrides={message=msg, record=logRecord, timestamp=date}, print-details=true)

   You can use the XML formatter attributes as follows:

   • The key-overrides attribute overrides the names of the defined keys.
   • Format exceptions as objects by setting the exception-output-type attribute to formatted.
   • Include the exception stack trace by setting the exception-output-type attribute to detailed.
   • Format exceptions as objects and include stack traces by setting the exception-output-type to detailed-and-formatted.
   • Add metadata to log records using the meta-data attribute.

Procedure

1. Add the custom log formatter by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/custom-formatter=CUSTOM_FORMATTER_NAME:add(class=CLASS_NAME, module=MODULE_NAME)

   Note

   When you add a custom log formatter, specify the Java class of the formatter and the JBoss EAP module that contains it. This class must extend java.util.logging.Formatter. Ensure you have created a module containing the custom logger or this command will fail.

2. Set the properties for the log formatter by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/custom-formatter=CUSTOM_FORMATTER_NAME:write-attribute(name=properties.PROPERTY_NAME,value=PROPERTY_VALUE)

   The properties must be accessible using a setter method.

3. Assign the custom formatter to a log handler by using the following command:

   Copy to Clipboard Toggle word wrap

   /subsystem=logging/periodic-rotating-file-handler=FILE_HANDLER_NAME:write-attribute(name=named-formatter, value=CUSTOM_FORMATTER_NAME)

   This command assigns a custom formatter for use by a periodic rotating file handler.

Procedure

1. Retrieve the logging configuration for a specific deployment by using the following command:

   Copy to Clipboard Toggle word wrap

   /deployment=DEPLOYMENT_NAME/subsystem=logging/configuration=CONFIG:read-resource

   The CONFIG value can be one of the following:

   • default: If the deployment is using the logging subsystem, this will output the logging subsystem configuration.
   • profile-PROFILE_NAME: If the deployment is using a logging profile defined in the logging subsystem, this will output the logging profile configuration.
   • The path to the configuration file being used, for example, myear.ear/META-INF/logging.properties.

2. To display the configuration for a specific logging profile, run the following command:

   Copy to Clipboard Toggle word wrap

   /deployment=mydeployment.war/subsystem=logging/configuration=profile-MYPROFILE:read-resource(recursive=true,include-runtime=true)

   This command retrieves the configuration for the MYPROFILE logging profile, which is used by the specified deployment.

   Expected output

   Copy to Clipboard Toggle word wrap

   {
       "outcome" => "success",
       "result" => {
           "error-manager" => undefined,
           "filter" => undefined,
           "formatter" => {
               "MYFORMATTER" => {
                   "class-name" => "org.jboss.logmanager.formatters.PatternFormatter",
                   "module" => undefined,
                   "properties" => {"pattern" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n"}
               }
           },
           "handler" => {
               "MYPERIODIC" => {
                   "class-name" => "org.jboss.logmanager.handlers.PeriodicRotatingFileHandler",
                   "encoding" => undefined,
                   "error-manager" => undefined,
                   "filter" => undefined,
                   "formatter" => "MYFORMATTER",
                   "handlers" => [],
                   "level" => "ALL",
                   "module" => undefined,
                   "properties" => {
                       "append" => "true",
                       "autoFlush" => "true",
                       "enabled" => "true",
                       "suffix" => ".yyyy-MM-dd",
                       "fileName" => "EAP_HOME/standalone/log/deployment.log"
                   }
               }
           },
           "logger" => {"MYCATEGORY" => {
               "filter" => undefined,
               "handlers" => [],
               "level" => "DEBUG",
               "use-parent-handlers" => true
           }},
           "pojo" => undefined
       }
   }

3. You can also perform a recursive read-resource operation to retrieve the entire logging configuration and other information about a deployment, by using the following command:

   Copy to Clipboard Toggle word wrap

   /deployment=DEPLOYMENT_NAME/subsystem=logging:read-resource(include-runtime=true, recursive=true)