Menu
Grafana Cloud

JVM integration for Grafana Cloud

A Java Virtual Machine (jvm) provides a runtime environment that converts Java bytecode into machine language, allowing computers to run Java programs. This integration enables the agent to send metrics to Grafana Cloud from JVM apps instrumented with Prometheus JVM client.

This integration includes 1 useful alert and 1 pre-built dashboard to help monitor and visualize JVM metrics.

Before you begin

To instrument your JVM application with Prometheus client, please follow the official instrumentation guide client_java.

Install JVM integration for Grafana Cloud

  1. In your Grafana Cloud stack, click Connections in the left-hand menu.
  2. Find JVM and click its tile to open the integration.
  3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send JVM metrics to your Grafana Cloud instance.
  4. Click Install to add this integration’s pre-built dashboard and alert to your Grafana Cloud instance, and you can start monitoring your JVM setup.

Post-install configuration for the JVM integration

After instrumenting your application, you should instruct Grafana Agent to scrape your JMV process instance.

By default, the client_java lib exposes metrics at a /metrics endpoint. To scrape it, add the snippet provided to your agent configuration file.

Make sure to change targets in the snippet according to your environment.

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

yaml
    - job_name: integrations/jvm
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
        - targets: ['localhost:1234']

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the JVM integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml
integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/jvm
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
        - targets: ['localhost:1234']
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The JVM integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

  • JVM overview - Prometheus

Alerts

The JVM integration includes the following useful alerts:

AlertDescription
JvmMemoryFillingUpWarning: JVM memory filling up (instance {{ $labels.instance }})

Metrics

The most important metrics provided by the JVM integration, which are used on the pre-built dashboard and Prometheus alert, are as follows:

  • jvm_classes_loaded
  • jvm_gc_collection_seconds_count
  • jvm_gc_collection_seconds_sum
  • jvm_memory_bytes_max
  • jvm_memory_bytes_used
  • jvm_threads_current
  • jvm_threads_daemon

Changelog

md
# 0.0.5 - September 2023

* Update Grafana Agent configuration snippets to include filtered metrics used in gauge panels

# 0.0.4 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.3 - September 2022

* Update dashboard panels descriptions.

# 0.0.2 - October 2021

* Update mixin to latest version:
  - Update the datasource template variable label to 'Data Source'
  - Update all rate queries to use `$__rate_interval` so they respect the default resolution

# 0.0.1 - October 2020

* Initial release

Cost

By connecting your JVM instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.