Location of telemetry logs, error logs, and configuration files

Find the logs, error logs, and configuration files used by MQ Telemetry.

Note: The examples are coded for Windows systems. Change the syntax to run the examples on AIX or Linux systems.


Server-side logs

The telemetry (MQXR) service writes FDC files to the IBM MQ error directory: 

WMQ data directory\errors\AMQ nnn.n.FDC

The format of the FDC files is MQXRn.FDC.

It also writes a log for the telemetry (MQXR) service. The log path is: 

WMQ data directory\Qmgrs\qMgrName\errors\mqxr.log

The format of the log file is mqxr_n.log.

The IBM MQ telemetry sample configuration created by IBM MQ Explorer starts the telemetry (MQXR) service using the command runMQXRService, which is in WMQ Telemetry installation directory\bin. This command writes to: 
WMQ data directory\Qmgrs\qMgrName\mqxr.stdout
WMQ data directory\Qmgrs\qMgrName\mqxr.stderr


Server-side configuration files

    Telemetry channels and telemetry (MQXR) service
    Restriction: The format, location, content, and interpretation of the telemetry channel configuration file might change in future releases. We must use IBM MQ Explorer, or MQSC commands, to configure telemetry channels.

    IBM MQ Explorer saves telemetry configurations in the mqxr_win.properties file on Windows systems, and the mqxr_unix.properties file on AIX or Linux systems. The properties files are saved in the telemetry configuration directory:

    Figure 1. Telemetry configuration directory on Windows 
    WMQ data directory\Qmgrs\qMgrName\mqxr
    Figure 2. Telemetry configuration directory on AIX or Linux 
     /var/mqm/qmgrs/qMgrName/mqxr

    JVM
    Set Java properties that are passed as arguments to the telemetry (MQXR) service in the file, java.properties. The properties in the file are passed directly to the JVM running the telemetry (MQXR) service. They are passed as additional JVM properties on the Java command line. Properties set on the command line take precedence over properties added to the command line from the java.properties file.
    Find the java.properties file in the same folder as the telemetry configurations. See Figure 1 and Figure 2.
    Modify java.properties by specifying each property as a separate line. Format each property exactly as you would to pass the property to the JVM as an argument. For example: 
    -Xmx1024m
-Xms1024m

    JAAS
    The JAAS configuration file is described in Telemetry channel JAAS configuration, which includes the sample JAAS configuration file, JAAS.config, shipped with MQ Telemetry.
    If you configure JAAS, we are almost certainly going to write a class to authenticate users to replace the standard JAAS authentication procedures.
    To include your Login class in the class path used by the telemetry (MQXR) service class path, provide an IBM MQ service.env configuration file.
    Set the class path for the JAAS LoginModule in service.env. We cannot use the variable, %classpath% in service.env. The class path in service.env is added to the class path already set in the telemetry (MQXR) service definition.
    Display the class paths that are being used by the telemetry (MQXR) service by adding echo set classpath to runMQXRService.bat. The output is sent to mqxr.stdout.
    The default location for the service.env file is: 
    WMQ data directory\service.env
    Override these settings with a service.env file for each queue manager in: 
    WMQ data directory\Qmgrs\qMgrName\service.env
    Figure 3. Sample service.env for Windows.

    A sample service.env file to use the sample LoginModule.class. 

    CLASSPATH= WMQ Installation Directory\mqxr\samples\samples
    Note: service.env must not contain any variables. Substitute the actual value of WMQ Installation Directory.

    Trace
    See Tracing the telemetry (MQXR) service. The parameters to configure trace are stored in two files: 
    WMQ data directory\Qmgrs\qMgrName\mqxr\trace.config
WMQ data directory\Qmgrs\qMgrName\mqxr\mqxrtraceOn.properties
    and there is a corresponding file: 
    WMQ data directory\Qmgrs\qMgrName\mqxr\mqxrtraceOff.properties


Client-side log files and client-side configuration files

For the latest information and downloads, see the following resources:

  • The Eclipse Paho project, and MQTT.org, have free downloads of the latest telemetry clients and samples for a range of programming languages. Use these sites to help you develop sample programs for publishing and subscribing IBM MQ Telemetry Transport, and for adding security features.
  • Early versions of MA9C: IBM Messaging Telemetry Clients included a compiled sample application (mqttv3app.jar) and associated client library (mqttv3.jar). They were provided in the following directories:

    • ma9c/SDK/clients/java/org.eclipse.paho.sample.mqttv3app.jar
    • ma9c/SDK/clients/java/org.eclipse.paho.client.mqttv3.jar

    In later versions of this SupportPac, the /SDK/ directory and contents is removed:

    • Only the source for the sample application (mqttv3app.jar) is provided. It is in this directory: 
      ma9c/clients/java/samples/org/eclipse/paho/sample/mqttv3app/*.java
    • The compiled client library is still provided. It is in this directory: 
      ma9c/clients/java/org.eclipse.paho.client.mqttv3-1.0.2.jar

  • The deprecated MA9B: Mobile Messaging and M2M Client Pack is no longer available.

Parent topic: MQ Telemetry troubleshooting