Menu
Grafana Cloud Data configuration Grafana integrations Integrations reference Spring Boot
Grafana Cloud

Spring Boot integration for Grafana Cloud

Spring Boot is Spring’s convention-over-configuration solution for creating stand-alone, production-grade Spring-based Applications. This integration enables the agent to send metrics to Grafana Cloud along with a useful default dashboard for visualization.

The provided dashboard is a modified version of the Spring Boot Statistics community dashboard.

This integration includes 1 pre-built dashboard to help monitor and visualize Spring Boot metrics.

Before you begin

The Spring Boot application must have the actuator enabled.

Please see the demo application for details.

We have added a custom label to the dashboard to help you observe multiple applications. To use it, make sure to add a line of code like the following in your @SpringBootApplication class to include an application label to your metrics. Please change MYAPPNAME value accordingly. This is also present in the demo application.

@Bean
MeterRegistryCustomizer<MeterRegistry> metricsCommonTags() {
    return registry -> registry.config().commonTags("application", "MYAPPNAME");
}

Install Spring Boot integration for Grafana Cloud

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

Post-install configuration for the Spring Boot integration

After enabling the metrics generation, instruct Grafana Agent to scrape your Spring Boot application.

Actuator exposes a /actuator/prometheus endpoint. To scrape it, add the provided snippet 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:

    - job_name: integrations/spring-boot
      static_configs:
        - targets: ['localhost:1235']
      metrics_path: /actuator/prometheus

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 Spring Boot integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

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_.*|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/spring-boot
      static_configs:
        - targets: ['localhost:1235']
      metrics_path: /actuator/prometheus
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

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

  • Spring Boot Statistics

Spring Boot Statistics

image

Metrics

The most important metrics provided by the Spring Boot integration, which are used on the pre-built dashboard, are as follows:

  • hikaricp_connections
  • hikaricp_connections_acquire_seconds_count
  • hikaricp_connections_acquire_seconds_sum
  • hikaricp_connections_active
  • hikaricp_connections_creation_seconds_count
  • hikaricp_connections_creation_seconds_sum
  • hikaricp_connections_idle
  • hikaricp_connections_pending
  • hikaricp_connections_timeout_total
  • hikaricp_connections_usage_seconds_count
  • hikaricp_connections_usage_seconds_sum
  • http_server_requests_seconds_count
  • http_server_requests_seconds_sum
  • jvm_buffer_memory_used_bytes
  • jvm_buffer_total_capacity_bytes
  • jvm_classes_loaded_classes
  • jvm_classes_unloaded_classes_total
  • jvm_gc_memory_allocated_bytes_total
  • jvm_gc_memory_promoted_bytes_total
  • jvm_gc_pause_seconds_count
  • jvm_gc_pause_seconds_sum
  • jvm_memory_committed_bytes
  • jvm_memory_max_bytes
  • jvm_memory_used_bytes
  • jvm_threads_daemon_threads
  • jvm_threads_live_threads
  • jvm_threads_peak_threads
  • logback_events_total
  • process_cpu_usage
  • process_files_max_files
  • process_files_open_files
  • process_start_time_seconds
  • process_uptime_seconds
  • system_cpu_count
  • system_cpu_usage
  • system_load_average_1m
  • tomcat_global_error_total
  • tomcat_global_received_bytes_total
  • tomcat_global_sent_bytes_total
  • tomcat_sessions_active_current_sessions
  • tomcat_threads_busy
  • tomcat_threads_config_max_threads
  • tomcat_threads_current_threads

Changelog

# 0.0.4 - January 2023

* Adding Job filter and making filters All and Multi selectable

# 0.0.3 - September 2022

* Update dashboard panels descriptions.

# 0.0.2 - October 2021

* Update mixin to latest version:
  - Update queries to use $__rate_interval

# 0.0.1 - December 2020

* Initial release

Cost

By connecting your Spring Boot 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.