Configuring logging for administrative REST API and IBM MQ Console

You can configure the logging levels, maximum log file size, and the maximum number of log files that are used by the mqweb server that hosts the IBM® MQ Console and administrative REST API.

Before you begin

You can view the current configuration of the logs by using the dspmqweb properties command with the -a flag. For more information, see dspmqweb. You can reset the logging configuration by using the setmqweb properties command with the -k and -d flags. For more information, see setmqweb.

About this task

The log files for the mqweb server can be found in the :mqtrace/webui url of the appliance.

Procedure

Use the setmqweb properties command from the mqcli prompt to configure logging:

  • To set the maximum log file size, use the following command:
    setmqweb properties -k maxTraceFileSize -v size
    where size specifies the size, in MB, that each log file can reach. The default value is 20.
  • To set the maximum number of files to use for logging, use the following command:
    setmqweb properties -k maxTraceFiles -v max
    where max specifies the maximum number of files. The default value is 2.
  • To configure the level of logging that is used, use the following command:
    setmqweb properties -k traceSpec -v level

    where level is one of the values listed in Table 1. The table outlines the logging levels in increasing level of detail. When you enable a logging level, you also enable each level before it. For example, if you enable the *=warning logging level, you also enable *=severe, and *=fatal logging levels.

    The default value is *=info. Change this value when IBM Service requests it.

    Table 1. Valid logging levels
    Value Logging level applied
    *=off Logging is turned off.
    *=fatal Task cannot continue and component, application, and server cannot function.
    *=severe Task cannot continue but component, application, and server can still function. This level can also indicate an impending unrecoverable error.
    *=warning Potential error or impending error. This level can also indicate a progressive failure (for example, the potential leaking of resources).
    *=audit Significant event affecting server state or resources
    *=info General information outlining overall task progress
    *=config Configuration change or status
    *=detail General information detailing subtask progress
    *=fine Trace information - General trace + method entry, exit, and return values
    *=finer Trace information - Detailed trace
    *=finest Trace information - A more detailed trace that includes all the detail that is needed to debug problems
    *=all All events are logged