JVM Actuator

Monitoring Connector Assets

Monitored Objects

The Pack collects metrics for:

• Class
• Memory
• System (cpu, load-average, fd)
• Threads

Collected Metrics

Class-count

Metric name	Description	Unit
class.loaded.current.count	Current number of classes loaded
class.unloaded.count	Number of classes unloaded

Cpu-load

Metric name	Description	Unit
system.cpu.load.percentage	Cpu load of the machine	%
process.cpu.load.percentage	Cpu load of the jvm instance	%

Fd-usage

Metric name	Description	Unit
fd.opened.usage.count	Number of used file descriptors
fd.opened.free.count	Number of free file descriptors
fd.opened.usage.percentage	Number of used file descriptors in percentage	%

Load-average

Metric name	Description	Unit
system.load.1m.count	System load average for the last minute

Memory

Metric name	Description	Unit
memory.heap.usage.bytes	Current heap memory usage	B
memory.nonheap.usage.bytes	Current memory usage outside the heap	B

Memory-detailed

Metric name	Description	Unit
memory.eden.usage.bytes	Current eden memory usage	B
memory.tenured.usage.bytes	Current tenured memory usage	B
memory.survivor.usage.bytes	Current survivor memory usage	B
memory.permanent.usage.bytes	Current permanent memory usage	B
memory.code.usage.bytes	Current code memory usage	B

Threads

Metric name	Description	Unit
threads.active.count	Number of active threads
threads.daemon.count	Count of threads marked as daemons

Prerequisites

Please install Spring Boot Actuator module: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html Ask to your admin to deploy it and give you the URL.

Setup

Online License

1. Install the Centreon Plugin on every Poller:

yum install centreon-plugin-Applications-Jvm-Actuator

2. On the Centreon Web interface in Configuration > Connectors > Monitoring Connectors, install the JVM Actuator Pack

Offline License

1. Install the Centreon Plugin on every Poller:

yum install centreon-plugin-Applications-Jvm-Actuator

2. On the Centreon Central server, install the Centreon Pack from the RPM:

yum install centreon-pack-applications-jvm-actuator

3. On the Centreon Web interface in Configuration > Connectors > Monitoring Connectors, install the JVM Actuator Pack

Host configuration

• Add a new Host and apply the App-Jvm-Actuator-custom Host Template

Once the template applied, some Macros have to be configured:

Mandatory	Name	Description
X	ACTUATORCUSTOMMODE	Custom mode to get metrics (Default: standard)
X	ACTUATORAPIPORT	Port used (Default: 8080)
X	ACTUATORAPIPROTO	Specify https if needed (Default: http)
X	ACTUATORAPIURLPATH	Api endpoint (Default: /actuator)
	ACTUATORAPIUSERNAME	Api username
	ACTUATORAPIPASSWORD	Api password
	ACTUATORAPIEXTRAOPTIONS	Any extra option you may want to add to the command (eg. a --verbose flag)

To monitor centreon-map JVM, please use following macro values:

Name	Value
ACTUATORCUSTOMMODE	centreonmap
ACTUATORAPIURLPATH	/centreon-studio/api/beta
ACTUATORAPIUSERNAME	Api username must be set
ACTUATORAPIPASSWORD	Api password must be set

How to test the Plugin and what are the main options for?

Once the Plugin installed, log into your Poller using the centreon-engine user account and test by running the following command:

/usr/lib/centreon/plugins/centreon_jvm_actuator.pl \
    --plugin=apps::java::jvm::actuator::plugin \
    --custommode=standard \
    --mode=class-count \
    --hostname='10.30.2.79' \
    --port='8080' \
    --proto='http' \
    --url-path='/actuator'
    --verbose

Output example:

OK: Class current: 6486, unloaded: 38 | 'class.loaded.current.count'=6486;;;0; 'class.unloaded.count'=38;;;0;

The command above monitors JVM class usage (--mode=class-count). It connects to the host 10.30.2.79 (--hostname='10.30.2.79') on the port 8080 (--port='8080') using http (--proto='http').

All the options that can be used with this plugin can be found over the --help command:

/usr/lib/centreon/plugins/centreon_jvm_actuator.pl \
    --plugin=apps::java::jvm::actuator::plugin \
    --custommode=standard \
    --mode=class-count \
    --help

Troubleshooting

Troubleshooting plugins