zabbix/templates/app/generic_java_jmx/README.md

# Generic Java JMX

## Overview

Official JMX Template from Zabbix distribution. Could be useful for many Java Applications (JMX).

## Requirements

Zabbix version: 7.0 and higher.

## Tested versions

This template has been tested on:
- Java Applications

## Configuration

> Zabbix should be configured according to the instructions in the [Templates out of the box](https://www.zabbix.com/documentation/7.0/manual/config/templates_out_of_the_box) section.

## Setup

Refer to the vendor documentation.

### Macros used

|Name|Description|Default|
|----|-----------|-------|
|{$JMX.NONHEAP.MEM.USAGE.MAX}|<p>A threshold in percent for Non-heap memory utilization trigger.</p>|`85`|
|{$JMX.NONHEAP.MEM.USAGE.TIME}|<p>The time during which the Non-heap memory utilization may exceed the threshold.</p>|`10m`|
|{$JMX.HEAP.MEM.USAGE.MAX}|<p>A threshold in percent for Heap memory utilization trigger.</p>|`85`|
|{$JMX.HEAP.MEM.USAGE.TIME}|<p>The time during which the Heap memory utilization may exceed the threshold.</p>|`10m`|
|{$JMX.MP.USAGE.MAX}|<p>A threshold in percent for memory pools utilization trigger. Use a context to change the threshold for a specific pool.</p>|`85`|
|{$JMX.MP.USAGE.TIME}|<p>The time during which the memory pools utilization may exceed the threshold.</p>|`10m`|
|{$JMX.FILE.DESCRIPTORS.MAX}|<p>A threshold in percent for file descriptors count trigger.</p>|`85`|
|{$JMX.FILE.DESCRIPTORS.TIME}|<p>The time during which the file descriptors count may exceed the threshold.</p>|`3m`|
|{$JMX.CPU.LOAD.MAX}|<p>A threshold in percent for CPU utilization trigger.</p>|`85`|
|{$JMX.CPU.LOAD.TIME}|<p>The time during which the CPU utilization may exceed the threshold.</p>|`5m`|
|{$JMX.MEM.POOL.NAME.MATCHES}|<p>This macro used in memory pool discovery as a filter.</p>|`Old Gen\|G1\|Perm Gen\|Code Cache\|Tenured Gen`|
|{$JMX.USER}|<p>JMX username.</p>||
|{$JMX.PASSWORD}|<p>JMX password.</p>||

### Items

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|ClassLoading: Loaded class count|<p>Displays number of classes that are currently loaded in the Java virtual machine.</p>|JMX agent|jmx["java.lang:type=ClassLoading","LoadedClassCount"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|ClassLoading: Total loaded class count|<p>Displays the total number of classes that have been loaded since the Java virtual machine has started execution.</p>|JMX agent|jmx["java.lang:type=ClassLoading","TotalLoadedClassCount"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|ClassLoading: Unloaded class count|<p>Displays the total number of classes that have been loaded since the Java virtual machine has started execution.</p>|JMX agent|jmx["java.lang:type=ClassLoading","UnloadedClassCount"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Compilation: Name of the current JIT compiler|<p>Displays the total number of classes unloaded since the Java virtual machine has started execution.</p>|JMX agent|jmx["java.lang:type=Compilation","Name"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `30m`</p></li></ul>|
|Compilation: Accumulated time spent|<p>Displays the approximate accumulated elapsed time spent in compilation, in seconds.</p>|JMX agent|jmx["java.lang:type=Compilation","TotalCompilationTime"]<p>**Preprocessing**</p><ul><li><p>Custom multiplier: `0.001`</p></li><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory: Heap memory committed|<p>Current heap memory allocated. This amount of memory is guaranteed for the Java virtual machine to use.</p>|JMX agent|jmx["java.lang:type=Memory","HeapMemoryUsage.committed"]|
|Memory: Heap memory maximum size|<p>Maximum amount of heap that can be used for memory management. This amount of memory is not guaranteed to be available if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size.</p>|JMX agent|jmx["java.lang:type=Memory","HeapMemoryUsage.max"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory: Heap memory used|<p>Current memory usage outside the heap.</p>|JMX agent|jmx["java.lang:type=Memory","HeapMemoryUsage.used"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory: Non-Heap memory committed|<p>Current memory allocated outside the heap. This amount of memory is guaranteed for the Java virtual machine to use.</p>|JMX agent|jmx["java.lang:type=Memory","NonHeapMemoryUsage.committed"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory: Non-Heap memory maximum size|<p>Maximum amount of non-heap memory that can be used for memory management. This amount of memory is not guaranteed to be available if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size.</p>|JMX agent|jmx["java.lang:type=Memory","NonHeapMemoryUsage.max"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory: Non-Heap memory used|<p>Current memory usage outside the heap</p>|JMX agent|jmx["java.lang:type=Memory","NonHeapMemoryUsage.used"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory: Object pending finalization count|<p>The approximate number of objects for which finalization is pending.</p>|JMX agent|jmx["java.lang:type=Memory","ObjectPendingFinalizationCount"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|OperatingSystem: File descriptors maximum count|<p>This is the number of file descriptors we can have opened in the same process, as determined by the operating system. You can never have more file descriptors than this number.</p>|JMX agent|jmx["java.lang:type=OperatingSystem","MaxFileDescriptorCount"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|OperatingSystem: File descriptors opened|<p>This is the number of opened file descriptors at the moment, if this reaches the MaxFileDescriptorCount, the application will throw an IOException: Too many open files. This could mean you are opening file descriptors and never closing them.</p>|JMX agent|jmx["java.lang:type=OperatingSystem","OpenFileDescriptorCount"]|
|OperatingSystem: Process CPU Load|<p>ProcessCpuLoad represents the CPU load in this process.</p>|JMX agent|jmx["java.lang:type=OperatingSystem","ProcessCpuLoad"]<p>**Preprocessing**</p><ul><li><p>Custom multiplier: `100`</p></li></ul>|
|Runtime: JVM uptime||JMX agent|jmx["java.lang:type=Runtime","Uptime"]<p>**Preprocessing**</p><ul><li><p>Custom multiplier: `0.001`</p></li></ul>|
|Runtime: JVM name||JMX agent|jmx["java.lang:type=Runtime","VmName"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `30m`</p></li></ul>|
|Runtime: JVM version||JMX agent|jmx["java.lang:type=Runtime","VmVersion"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `30m`</p></li></ul>|
|Threading: Daemon thread count|<p>Number of daemon threads running.</p>|JMX agent|jmx["java.lang:type=Threading","DaemonThreadCount"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Threading: Peak thread count|<p>Maximum number of threads being executed at the same time since the JVM was started or the peak was reset.</p>|JMX agent|jmx["java.lang:type=Threading","PeakThreadCount"]|
|Threading: Thread count|<p>The number of threads running at the current moment.</p>|JMX agent|jmx["java.lang:type=Threading","ThreadCount"]|
|Threading: Total started thread count|<p>The number of threads started since the JVM was launched.</p>|JMX agent|jmx["java.lang:type=Threading","TotalStartedThreadCount"]|

### Triggers

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Compilation: {HOST.NAME} uses suboptimal JIT compiler||`find(/Generic Java JMX/jmx["java.lang:type=Compilation","Name"],,"like","Client")=1`|Info|**Manual close**: Yes|
|Memory: Heap memory usage is high||`min(/Generic Java JMX/jmx["java.lang:type=Memory","HeapMemoryUsage.used"],{$JMX.HEAP.MEM.USAGE.TIME})>(last(/Generic Java JMX/jmx["java.lang:type=Memory","HeapMemoryUsage.max"])*{$JMX.HEAP.MEM.USAGE.MAX}/100) and last(/Generic Java JMX/jmx["java.lang:type=Memory","HeapMemoryUsage.max"])>0`|Warning||
|Memory: Non-Heap memory usage is high||`min(/Generic Java JMX/jmx["java.lang:type=Memory","NonHeapMemoryUsage.used"],{$JMX.NONHEAP.MEM.USAGE.TIME})>(last(/Generic Java JMX/jmx["java.lang:type=Memory","NonHeapMemoryUsage.max"])*{$JMX.NONHEAP.MEM.USAGE.MAX}/100) and last(/Generic Java JMX/jmx["java.lang:type=Memory","NonHeapMemoryUsage.max"])>0`|Warning||
|OperatingSystem: Opened file descriptor count is high||`min(/Generic Java JMX/jmx["java.lang:type=OperatingSystem","OpenFileDescriptorCount"],{$JMX.FILE.DESCRIPTORS.TIME})>(last(/Generic Java JMX/jmx["java.lang:type=OperatingSystem","MaxFileDescriptorCount"])*{$JMX.FILE.DESCRIPTORS.MAX}/100)`|Warning||
|OperatingSystem: Process CPU Load is high||`min(/Generic Java JMX/jmx["java.lang:type=OperatingSystem","ProcessCpuLoad"],{$JMX.CPU.LOAD.TIME})>{$JMX.CPU.LOAD.MAX}`|Average||
|Runtime: JVM is not reachable||`nodata(/Generic Java JMX/jmx["java.lang:type=Runtime","Uptime"],5m)=1`|Average|**Manual close**: Yes|
|Runtime: {HOST.NAME} runs suboptimal VM type||`find(/Generic Java JMX/jmx["java.lang:type=Runtime","VmName"],,"like","Server")<>1`|Info|**Manual close**: Yes|

### LLD rule Garbage collector discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Garbage collector discovery|<p>Garbage collectors metrics discovery.</p>|JMX agent|jmx.discovery["beans","java.lang:name=*,type=GarbageCollector"]|

### Item prototypes for Garbage collector discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|GarbageCollector: {#JMXNAME} number of collections per second|<p>Displays the total number of collections that have occurred per second.</p>|JMX agent|jmx["java.lang:name={#JMXNAME},type=GarbageCollector","CollectionCount"]<p>**Preprocessing**</p><ul><li>Change per second</li></ul>|
|GarbageCollector: {#JMXNAME} accumulated time spent in collection|<p>Displays the approximate accumulated collection elapsed time, in seconds.</p>|JMX agent|jmx["java.lang:name={#JMXNAME},type=GarbageCollector","CollectionTime"]<p>**Preprocessing**</p><ul><li><p>Custom multiplier: `0.001`</p></li><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|

### LLD rule Memory pool discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Memory pool discovery|<p>Memory pools metrics discovery.</p>|JMX agent|jmx.discovery["beans","java.lang:name=*,type=MemoryPool"]|

### Item prototypes for Memory pool discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Memory pool: {#JMXNAME} committed|<p>Current memory allocated.</p>|JMX agent|jmx["java.lang:name={#JMXNAME},type=MemoryPool","Usage.committed"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory pool: {#JMXNAME} maximum size|<p>Maximum amount of memory that can be used for memory management. This amount of memory is not guaranteed to be available if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size.</p>|JMX agent|jmx["java.lang:name={#JMXNAME},type=MemoryPool","Usage.max"]<p>**Preprocessing**</p><ul><li><p>Discard unchanged with heartbeat: `10m`</p></li></ul>|
|Memory pool: {#JMXNAME} used|<p>Current memory usage.</p>|JMX agent|jmx["java.lang:name={#JMXNAME},type=MemoryPool","Usage.used"]|

### Trigger prototypes for Memory pool discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Memory pool: {#JMXNAME} memory usage is high||`min(/Generic Java JMX/jmx["java.lang:name={#JMXNAME},type=MemoryPool","Usage.used"],{$JMX.MP.USAGE.TIME:"{#JMXNAME}"})>(last(/Generic Java JMX/jmx["java.lang:name={#JMXNAME},type=MemoryPool","Usage.max"])*{$JMX.MP.USAGE.MAX:"{#JMXNAME}"}/100) and last(/Generic Java JMX/jmx["java.lang:name={#JMXNAME},type=MemoryPool","Usage.max"])>0`|Warning||

## Feedback

Please report any issues with the template at [`https://support.zabbix.com`](https://support.zabbix.com)

You can also provide feedback, discuss the template, or ask for help at [`ZABBIX forums`](https://www.zabbix.com/forum/zabbix-suggestions-and-feedback)