Skip to main content

Spring Boot

Monitor Spring Boot applications via the Actuator Prometheus endpoint — HTTP request rates, JVM memory, GC pauses, and connection pool usage.

Spring Boot Dashboard

Key Metrics

MetricDescription
http_server_requests_seconds_countHTTP request count per endpoint
http_server_requests_seconds_sumTotal HTTP request duration
jvm_memory_used_bytesJVM heap and non-heap usage
jvm_gc_pause_seconds_sumGC pause duration
hikaricp_connections_activeActive HikariCP connections
system_cpu_usageSystem CPU utilisation

Prerequisites

  • Spring Boot 2.x / 3.x
  • spring-boot-starter-actuator + micrometer-registry-prometheus dependencies

Configuration

pom.xml dependencies

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

application.properties

management.endpoints.web.exposure.include=prometheus,health
management.endpoint.prometheus.enabled=true

Metrics are available at http://localhost:8080/actuator/prometheus.

Option A — Prometheus scrape

scrape_configs:
- job_name: spring_boot
metrics_path: /actuator/prometheus
static_configs:
- targets: ['localhost:8080']

remote_write:
- url: https://<region>.xscalerlabs.com/api/v1/push
headers:
X-Scope-OrgID: <tenant-id>
basic_auth:
password: <api-token>

Option B — Grafana Alloy

prometheus.scrape "spring_boot" {
targets = [{"__address__" = "localhost:8080"}]
metrics_path = "/actuator/prometheus"
forward_to = [prometheus.remote_write.xscaler.receiver]
}

prometheus.remote_write "xscaler" {
endpoint {
url = "https://<region>.xscalerlabs.com/api/v1/push"
headers = { "X-Scope-OrgID" = "<tenant-id>" }
basic_auth { password = "<api-token>" }
}
}

Option C — OpenTelemetry Collector

receivers:
prometheus:
config:
scrape_configs:
- job_name: spring_boot
metrics_path: /actuator/prometheus
static_configs:
- targets: ['localhost:8080']

exporters:
prometheusremotewrite:
endpoint: https://<region>.xscalerlabs.com/api/v1/push
headers:
Authorization: Bearer <api-token>
X-Scope-OrgID: <tenant-id>

service:
pipelines:
metrics:
receivers: [prometheus]
exporters: [prometheusremotewrite]

Logs

Collect Spring Boot application log — configure logging.file.name and tail the output file. Add the following to your Alloy config, adjusting __path__ to match your application's log file location:

local.file_match "spring_boot_logs" {
path_targets = [{
__address__ = "localhost",
__path__ = "/var/log/spring_boot/app.log",
instance = constants.hostname,
job = "integrations/spring_boot",
}]
}

loki.source.file "spring_boot_logs" {
targets = local.file_match.spring_boot_logs.targets
forward_to = [loki.write.xscaler.receiver]
}

loki.write "xscaler" {
endpoint {
url = "https://euw1-01.l.xscalerlabs.com/api/v1/logs/push"

http_client_config {
authorization {
type = "Bearer"
credentials = env("XSCALER_TOKEN")
}
}

headers = { "X-Scope-OrgID" = env("XSCALER_TENANT_ID") }
}
}