Spring Boot 4 Microservices & REST APIs · Lezione

Health check e metriche

Implementi Spring Boot Actuator per esporre endpoint di health check e raccogliere le metriche dell’applicazione.

Lezione 2 di 312 passaggi

Health check e metriche è una lezione Spring Boot 4 Microservices & REST APIs gratuita su CoddyKit. Questa è la lezione 2 di 3. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Spring Boot 4 Microservices & REST APIs, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Spring Boot 4 Microservices & REST APIs include 3 lezioni in totale.

Parti di questa lezione non sono ancora state tradotte e vengono mostrate in inglese.

What is Spring Boot Actuator?

When running microservices, monitoring their health and performance is super important. Spring Boot Actuator provides a set of production-ready features to help you do just that!

It exposes operational information about your running application, making it easier to observe and manage.

Add Actuator Dependency

To start using Actuator, you just need to add its dependency to your Spring Boot project. This is typically done in your pom.xml for Maven or build.gradle for Gradle.

Here's how to add it with Maven:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

Explore Default Endpoints

Once the Actuator dependency is added, Spring Boot automatically configures several useful endpoints. These endpoints provide valuable insights into your application's state.

  • /actuator/health: Shows the application's health status.
  • /actuator/info: Displays general application information.
  • /actuator/metrics: Provides detailed metrics data.

Checking Application Health

The /actuator/health endpoint is a fundamental part of monitoring. It tells you if your application and its integrated components (like databases or disk space) are functioning correctly.

A simple "UP" status means everything is good! Run this basic app and check its health endpoint.

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

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

Accessing Health Endpoint

After running the previous application, open your browser and navigate to http://localhost:8080/actuator/health.

You should see a JSON response indicating the application's overall status, typically {"status":"UP"}.

This is a quick way to verify if your service is alive!

Create Custom Health Checks

You can extend Actuator's health checks to include your own custom logic. For example, checking the status of an external API, a message queue, or a specific business process.

To do this, you implement the HealthIndicator interface:

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class CustomServiceHealthIndicator implements HealthIndicator {
  private final String SERVICE_NAME = "MyExternalService";

  @Override
  public Health health() {
    if (isServiceUp()) {
      return Health.up().withDetail(SERVICE_NAME, "Available").build();
    }
    return Health.down().withDetail(SERVICE_NAME, "Not Available").build();
  }

  private boolean isServiceUp() {
    // Simulate checking an external service
    return Math.random() > 0.3; // 70% chance of being up
  }
}

Understanding Application Metrics

Metrics are numerical data points that describe your application's behavior over time. They are crucial for understanding performance, resource usage, and identifying potential bottlenecks.

Spring Boot Actuator, powered by Micrometer, automatically collects various metrics:

  • CPU and memory usage
  • HTTP request counts and latencies
  • Database connection pool statistics

Querying Metrics Data

The /actuator/metrics endpoint provides a list of all available metrics. You can then query specific metrics for detailed information.

  • Visit http://localhost:8080/actuator/metrics to see available metrics.
  • Then, try http://localhost:8080/actuator/metrics/jvm.memory.used to see the specific memory usage metric.

This allows you to gather precise data for monitoring dashboards.

Implement Custom Metrics

Beyond the default metrics, you can track application-specific events using custom metrics. Micrometer provides simple APIs for different metric types like Counters, Gauges, and Timers.

Here's an example of a custom Counter:

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Service;

@Service
public class MyService {
  private final Counter customCounter;

  public MyService(MeterRegistry meterRegistry) {
    this.customCounter = Counter.builder("my_app.processed.items")
                                .description("Number of items processed by MyService")
                                .register(meterRegistry);
  }

  public void processItem() {
    System.out.println("Processing an item...");
    customCounter.increment(); // Increment the counter
  }
}

Customize Endpoint Exposure

By default, only /health and /info are typically exposed over HTTP. You can configure which other endpoints Actuator makes available using application.properties or application.yml.

To expose more endpoints like metrics, beans, and env, add this line:

management.endpoints.web.exposure.include=health,info,metrics,beans,env

Actuator Knowledge Check

Let's quickly check your understanding of Spring Boot Actuator's benefits.

Lesson Recap

Great job! In this lesson, you learned about:

  • Spring Boot Actuator for monitoring and managing microservices.
  • Implementing health checks using the /actuator/health endpoint.
  • Creating custom health indicators for specific services.
  • Understanding and collecting application metrics via /actuator/metrics.
  • Implementing custom metrics with Micrometer.
  • The importance of securing Actuator endpoints in production.

Next, we'll dive into centralized logging and dashboarding!

Gratis per iniziare

Impara Java con un tutor IA — gratis

Scrivi ed esegui vero codice nel tuo browser, ricevi aiuto istantaneo da un tutor IA disponibile 24/7, e riprendi da dove hai lasciato sul web o nell'app.

Corsi
24
Lezioni
93

Domande Frequenti

La lezione «Health check e metriche» è gratuita?

Sì — il testo completo di «Health check e metriche» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Spring Boot 4 Microservices & REST APIs, passa a CoddyKit PRO. Il corso Spring Boot 4 Microservices & REST APIs include 3 lezioni in totale.

Cosa imparerò in «Health check e metriche»?

Implementi Spring Boot Actuator per esporre endpoint di health check e raccogliere le metriche dell’applicazione. Eserciti Spring Boot 4 Microservices & REST APIs con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Spring Boot 4 Microservices & REST APIs?

Non è richiesta alcuna esperienza precedente. Spring Boot 4 Microservices & REST APIs su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 2 di 3.

Quanto tempo richiede la lezione «Health check e metriche»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Spring Boot 4 Microservices & REST APIs?

Sì. Ogni lezione Spring Boot 4 Microservices & REST APIs include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

  1. Logging centralizzato con lo stack ELK
  2. Health check e metriche
  3. Alert e dashboard
← Torna a Spring Boot 4 Microservices & REST APIs