Enabling and Configuring the JMX Exporter Agent

About this task

When you start a Universal Messaging realm instance, the JMX Exporter agent is not running by default. To enable the agent, you must modify the Server_Common.conf file or Custom_Server_Common.conf file in the Software AG_directory \UniversalMessaging\server\instance_name\bin directory, which refer to the jmx_sag_um_exporter.yaml configuration.

Important:

In Universal Messaging Docker images version 10.15 and higher, monitoring using Prometheus is enabled by default. The JMX Exporter agent is running by default on port 9200.

For more information about monitoring containers, see Monitoring Universal Messaging Containers with Prometheus.

To enable the JMX Exporter agent

Procedure

Open the Server_Common.conf file in a text editor and search for the line referring to the JMX Exporter agent. The line looks similar to this:

wrapper.java.additional.<n>=
-javaagent:Software AG_directory\UniversalMessaging\lib\jmx_prometheus_javaagent.jar=0.0.0.0:9200:
Software AG_directory\UniversalMessaging\server\instance_name\bin\jmx_sag_um_exporter.yaml

Uncomment the line.
Optionally, change the port number from the default 9200.
Restart the Universal Messaging realm instance.