Prometheus and Grafana integration concept in Spring Boot - Mini Project: Build & Apply

Prometheus and Grafana Integration with Spring Boot

📖 Scenario: You are building a simple Spring Boot application that exposes metrics for monitoring. You want to integrate Prometheus to collect these metrics and Grafana to visualize them. This project will guide you step-by-step to set up the basic integration.

🎯 Goal: Build a Spring Boot application that exposes Prometheus metrics, configure Prometheus to scrape these metrics, and set up Grafana to visualize them.

📋 What You'll Learn

Create a Spring Boot application with actuator dependency

Enable Prometheus metrics endpoint

Configure Prometheus to scrape the Spring Boot metrics endpoint

Set up Grafana dashboard to visualize the metrics

💡 Why This Matters

🌍 Real World

Monitoring applications is essential to detect issues early and understand system performance. Prometheus collects metrics, and Grafana visualizes them in dashboards.

💼 Career

DevOps engineers and backend developers often integrate Prometheus and Grafana with applications to ensure reliability and performance monitoring.

1

Create Spring Boot application with Actuator

Create a Spring Boot application class named DemoApplication with the @SpringBootApplication annotation and a main method that runs the application using SpringApplication.run(DemoApplication.class, args).

Spring Boot

# Create the DemoApplication class with @SpringBootApplication and main method
# Your code here

Need a hint?

Use the @SpringBootApplication annotation on the class and write a main method that calls SpringApplication.run.

2

Add Actuator and Prometheus dependencies

Add the spring-boot-starter-actuator and micrometer-registry-prometheus dependencies to your pom.xml file inside the <dependencies> section.

Spring Boot

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}


# Your code here

Need a hint?

Add the actuator and micrometer Prometheus registry dependencies inside the <dependencies> section of pom.xml.

3

Enable Prometheus endpoint in application properties

Add the following line to src/main/resources/application.properties to enable the Prometheus metrics endpoint: management.endpoints.web.exposure.include=prometheus.

Spring Boot

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

 in pom.xml -->

    org.springframework.boot
    spring-boot-starter-actuator


    io.micrometer
    micrometer-registry-prometheus

-->

# Add the line below to application.properties
# Your code here

Need a hint?

Open application.properties and add the line to expose the Prometheus endpoint.

4

Print Prometheus metrics endpoint URL

Write a System.out.println statement in the main method to print: "Prometheus metrics available at http://localhost:8080/actuator/prometheus".

Spring Boot

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        // Print the Prometheus metrics URL below
        // Your code here
        SpringApplication.run(DemoApplication.class, args);
    }
}

 in pom.xml -->

    org.springframework.boot
    spring-boot-starter-actuator


    io.micrometer
    micrometer-registry-prometheus

-->

# In src/main/resources/application.properties
management.endpoints.web.exposure.include=prometheus

Need a hint?

Use System.out.println to print the exact URL string.