JVM

The JVM receiver can retrieve metrics from a Java Virtual Machine (JVM) through Java Management Extensions (JMX).

This receiver collects metrics only from the JVM. Currently, the Ops Agent doesn't collect metrics from Java-based applications, such as Cassandra and Tomcat.

Prerequisites

To collect JVM metrics, you must install Ops Agent version 2.2.0 or higher.

Configure your JVM

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 metrics from your JVM instances, and restart the agent.

Metrics collection

To collect metrics from JVM instances, you must create a receiver for JVM metrics and then create a pipeline for the new receiver. To configure a receiver for your JVM metrics, specify the following fields:

Field	Default	Description
`type`		The value must be `jvm`.
`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`.
`username`		The configured username if JMX is configured to require authentication.
`password`		The configured password if JMX is configured to require authentication.
`collection_interval`	`60s`	A time.Duration value, such as `30s` or `5m`.

Example configuration:

In this example, the com.sun.management.jmxremote.port and com.sun.management.jmxremote.rmi.port system properties were set to 9999, and the java.rmi.server.hostname system property was set to 127.0.0.1.

metrics:
  receivers:
    jvm_metrics:
      type: jvm
      endpoint: localhost:9999
      collection_interval: 60s
  service:
    pipelines:
      jvm_pipeline:
        receivers:
          - jvm_metrics

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