JVM

The JVM integration collects JVM metrics exposed through Java Management Extensions (JMX). The integration primarily collects metrics on memory and garbage collection. Additional runtime metrics, such as thread count and classes loaded, are also available.

For more information about JVM, see the JVM documentation.

Prerequisites

To collect JVM telemetry, you must install the Ops Agent:

For metrics, install version 2.2.0 or higher.

This integration supports JVM versions Java 16 and Java 11.

Configure your JVM instance

To expose a JMX endpoint, you must set the com.sun.management.jmxremote.port system property when starting the JVM. We also recommend setting the com.sun.management.jmxremote.rmi.port system property to the same port.

To expose a JMX endpoint remotely, you must also set the java.rmi.server.hostname system property.

To set system properties by using command-line arguments, prepend the property name with -D when starting the JVM.

For example, to set com.sun.management.jmxremote.port to port 9999, specify the following when starting the JVM:

-Dcom.sun.management.jmxremote.port=9999

Configure the Ops Agent for JVM

Following the guide for Configuring the Ops Agent, add the required elements to collect telemetry from JVM instances, and restart the agent.

Example configuration

The following command creates the configuration to collect and ingest telemetry for JVM and restarts the Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    jvm:
      type: jvm
      endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:9010/jmxrmi
  service:
    pipelines:
      jvm:
        receivers:
          - jvm
EOF

sudo systemctl restart google-cloud-ops-agent.service
sleep 60

Configure metrics collection

To ingest metrics from JVM, you must create receivers for the metrics that JVM produces and then create a pipeline for the new receivers.

To configure a receiver for your jvm metrics, specify the following fields:

Field	Default	Description
`collection_interval`	`60s`	A time duration, such as `30s` or `5m`.
`endpoint`	`localhost:9999`	The JMX Service URL or host and port used to construct the service URL. This value must be in the form of `service:jmx:<protocol>:<sap>` or `host:port`. Values in `host:port` form are used to create a service URL of `service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi`.
`password`		The configured password if JMX is configured to require authentication.
`type`		This value must be `jvm`.
`username`		The configured username if JMX is configured to require authentication.

What is monitored

The following table provides the list of metrics that the Ops Agent collects from the JVM instance.

Metric type
Kind, Type Monitored resources	Labels
`workload.googleapis.com/jvm.classes.loaded`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.gc.collections.count`
`CUMULATIVE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.gc.collections.elapsed`
`CUMULATIVE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.heap.committed`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.heap.init`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.heap.max`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.heap.used`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.committed`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.init`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.max`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.used`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.pool.committed`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.pool.init`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.pool.max`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.pool.used`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.threads.count`
`GAUGE`, `INT64` gce_instance

Sample dashboard

To view your JVM metrics, you must have a chart or dashboard configured. Cloud Monitoring provides a library of sample dashboards for integrations, which contain preconfigured charts. For information about installing these dashboards, see Installing sample dashboards.

Verify the configuration

This section describes how to verify that you correctly configured the JVM receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that the metrics are ingested, go to Metrics Explorer and run the following query in the MQL tab:

fetch gce_instance
| metric 'workload.googleapis.com/jvm.memory.heap.used'
| every 1m

What's next

For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.