IBM MQ diagnostic message services
The diagnostic message services provides various options for consuming the IBM® MQ error logs.
You can define one or more services that configure IBM MQ to output messages to a file. The messages can be filtered by their severity, specific messages can be excluded, and duplicates can be suppressed. Messages can be output in JSON format or as text. You can also specify a service that sends messages to a logging target that you have defined on the appliance (see Appliance log targets).
You configure the services by using commands that alter stanzas in the
qm.ini and mqs.ini files. (You cannot edit these files
directly on the appliance.) The following stanzas are configured in the qm.ini
and mqs.ini files:
- DiagnosticSystemMessages
- This stanza is defined in mqs.ini. It configures a service for IBM MQ diagnostic messages that are not associated with a specific queue manager. These messages equate to those written to the system error log (MQSystem.log on the appliance).
- DiagnosticMessages
- This stanza is defined in qm.ini. It configures a service for IBM MQ diagnostic messages that are associated with the queue manager. These messages equate to those written to the queue manager error log (AMQERR0x.LOG on the appliance). Changes to this stanza take effect only after the queue manager is restarted.
- DiagnosticMessagesTemplate
- This stanza is defined in mqs.ini. It defines a service for IBM MQ diagnostic messages that is configured for newly
created queue managers. When a queue manager is created, this stanza is copied to the new queue
manager qm.ini file as a
DiagnosticMessages
stanza.
You can specify the following keys (attributes) in the diagnostic message stanzas:
- Name
- Specifies a unique identifier for the service. The name must follow the rules for naming IBM MQ objects, see Rules for naming IBM MQ objects. The name of each diagnostic message service is used only to uniquely identify it in the configuration file, the name does not need to match the name of a log target or other definition.
- MessageDetail
- Set to
Extended
by default. The extended setting appends insert fields to error messages sent to log targets (that is, when the Service field is set toAppliance
). Set toStandard
to exclude the inserts. See Format of IBM MQ logs sent to log targets for an example of adding inserts to messages. - Service
- The Service attribute can be set to either
File
for output messages to a file, orAppliance
for routing messages to log targets. A service of typeAppliance
can be defined once for system messages (DiagnosticSystemMessages), once for a template service (DiagnosticMessagesTemplate), and once for each queue manager (DiagnosticMessages). IBM MQ diagnostic messages are published to all subscribing log targets. By default, queue managers are created with a DiagnosticMessages service of typeAppliance
. If you have queue managers that were created in an earlier version of appliance firmware, you might have to manually add the appliance diagnostic message service to yourqm.ini
files. - ExcludeMessages
- Optionally specify a comma-separated list of message identifiers to exclude from the log. The
following values are valid for this attribute:
- 5211 - Maximum property name length exceeded.
- 5973 - Distributed publish/subscribe subscription inhibited
- 5974 - Distributed publish/subscribe publication inhibited
- 6254 - The system could not dynamically load shared library
- 7234 - Number of messages loaded
- 8245 - Entity has insufficient authority to display object
- 9001 - Channel program ended normally
- 9002 - Channel program started
- 9202 - Remote host not available
- 9208 - Error on receive from host
- 9209 - Connection closed
- 9228 - Cannot start channel responder
- 9489 - SVRCONN max instances limit exceeded
- 9490 - SVRCONN max instances per client limit exceeded
- 9508 - Cannot connect to queue manager
- 9524 - Remote queue manager unavailable
- 9528 - User requested closure of channel
- 9545 - Disconnect interval expired
- 9558 - Remote Channel is not available
- 9637 - Channel is lacking a certificate
- 9776 - Channel was blocked by user ID
- 9777 - Channel was blocked by NOACCESS map
- 9782 - Connection was blocked by address
- 9999 - Channel program ended abnormally
- SuppressMessages
- Optionally specify a comma-separated list of message identifiers that are only output once per
time interval. This attribute is not supported in the
DiagnosticSystemMessages
stanza. The following values are valid for this attribute:- 5211 - Maximum property name length exceeded.
- 5973 - Distributed publish/subscribe subscription inhibited
- 5974 - Distributed publish/subscribe publication inhibited
- 6254 - The system could not dynamically load shared library
- 7234 - Number of messages loaded
- 8245 - Entity has insufficient authority to display object
- 9001 - Channel program ended normally
- 9002 - Channel program started
- 9202 - Remote host not available
- 9208 - Error on receive from host
- 9209 - Connection closed
- 9228 - Cannot start channel responder
- 9489 - SVRCONN max instances limit exceeded
- 9490 - SVRCONN max instances per client limit exceeded
- 9508 - Cannot connect to queue manager
- 9524 - Remote queue manager unavailable
- 9528 - User requested closure of channel
- 9545 - Disconnect interval expired
- 9558 - Remote Channel is not available
- 9637 - Channel is lacking a certificate
- 9776 - Channel was blocked by user ID
- 9777 - Channel was blocked by NOACCESS map
- 9782 - Connection was blocked by address
- 9999 - Channel program ended abnormally
- SuppressInterval
- Optionally specify the time interval in seconds for the
SuppressMessages
list. The value must be in the range 1 to 86400. The default value is 30. This attribute is not supported in theDiagnosticSystemMessages
stanza. - Severities
- Optionally specify a comma-separated list of severity levels for messages to be output by the
message service. The following values are permitted:
I
,Information
, or0
W
,Warning
, or10
E
,Error
, or20
or30
S
,Stop
, or40
T
,System
, or50
all
E+
" would include messages of severityError
,Stop
, andSystem
. - FilePrefix
- Optionally specify the prefix for the log file name. The default value is
AMQERR
. - FileSize
- Optionally specify the size at which the log file rolls over (is rotated). The default value id 32 MB.
- Format
- Optionally specify the format of the log file, which can be
text
orjson
. The file suffix is determined by the type, and is either.LOG
or.json
.