This is a translation of the original English documentation page. Help us make it better.
Table of Contents

JMX template operation

Steps to ensure correct operation of templates that collect metrics by JMX:

1. Make sure Zabbix Java gateway is installed and set up properly.
2. Link the template to the target host. The host should have JMX interface set up.
If the template is not available in your Zabbix installation, you may need to import the template's .xml file first - see Templates out-of-the-box section for instructions.
3. Adjust the values of mandatory macros as needed.
4. Configure the instance being monitored to allow sharing data with Zabbix - see instructions in the Additional steps/comments column.

This page contains only a minimum set of macros and setup steps that are required for proper template operation. A detailed description of a template, including the full list of macros, items, and triggers, is available in the template's Readme.md file (accessible by clicking on a template name).

Template Mandatory macros Additional steps/comments
Apache ActiveMQ by JMX {$ACTIVEMQ.PORT} - port for JMX (default: 1099).
{$ACTIVEMQ.USERNAME}, {$ACTIVEMQ.PASSWORD} - login credentials for JMX
(default username: admin, password: activemq).
JMX access to Apache ActiveMQ should be enabled and configured per instructions in the official documentation.
Apache Cassandra by JMX {$CASSANDRA.USER}, {$CASSANDRA.PASSWORD} - Apache Cassandra login credentials
(default username: zabbix, password: zabbix)
JMX access to Apache Cassandra should be enabled and configured per instructions in the official documentation.
Apache Kafka by JMX {$KAFKA.USER}, {$KAFKA.PASSWORD} - Apache Kafka login credentials
(default username: zabbix, password: zabbix)
JMX access to Apache Kafka should be enabled and configured per instructions in the official documentation.
Apache Tomcat by JMX {$TOMCAT.USER}, {$TOMCAT.PASSWORD} - Apache Tomcat login credentials; leave blank if Tomcat installation does not require authentication
(default: not set).
JMX access to Apache Tomcat should be enabled and configured per instructions in the official documentation (choose the correct version).
GridGain by JMX {$GRIDGAIN.USER}, {$GRIDGAIN.PASSWORD} - GridGain login credentials (default username: zabbix, password: <secret>). JMX access to GridGain In-Memory Computing Platform should be enabled and configured per instructions in the documentation.
Ignite by JMX {$IGNITE.USER}, {$IGNITE.PASSWORD} - Apache Ignite login credentials (default username: zabbix, password: <secret>). Enable and configure JMX access to Apache Ignite.

JMX tree hierarchy contains ClassLoader by default. Adding the following Java Virtual Machine option -DIGNITE_MBEAN_APPEND_CLASS_LOADER_ID=false will exclude one level with ClassLoader name.

Cache and Data Region metrics can be configured as needed - see Ignite documentation for details.

See also: Monitoring and Management Using JMX Technology
WildFly Domain by JMX {$WILDFLY.JMX.PROTOCOL} - JMX scheme (default: remote+http)
{$WILDFLY.USER}, {$WILDFLY.PASSWORD} - WildFly login credentials (default username: zabbix, password: zabbix).
1. Enable and configure JMX access to WildFly according to instructions in the official documentation.

2. Copy jboss-client.jar from /(wildfly,EAP,Jboss,AS)/bin/client into directory /usr/share/zabbix-java-gateway/lib.

3. Restart Zabbix Java gateway.
WildFly Server by JMX {$WILDFLY.JMX.PROTOCOL} - JMX scheme (default: remote+http)
{$WILDFLY.USER}, {$WILDFLY.PASSWORD} - WildFly login credentials (default username: zabbix, password: zabbix).
1. Enable and configure JMX access to WildFly according to instructions in the official documentation.

2. Copy jboss-client.jar from /(wildfly,EAP,Jboss,AS)/bin/client into directory /usr/share/zabbix-java-gateway/lib.

3. Restart Zabbix Java gateway.