Spring Boot 4 Microservices & REST APIs · Leçon

Contrôles d’intégrité et métriques

Mettez en œuvre Spring Boot Actuator pour exposer des points de terminaison d’intégrité et recueillir les métriques de l’application.

Leçon 2 sur 312 étapes

Contrôles d’intégrité et métriques est une leçon Spring Boot 4 Microservices & REST APIs gratuite sur CoddyKit. Ceci est la leçon 2 sur 3. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Spring Boot 4 Microservices & REST APIs, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Spring Boot 4 Microservices & REST APIs comprend 3 leçons au total.

Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.

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!

Gratuit pour commencer

Apprends Java avec un tuteur IA — gratuit

Écris et exécute du vrai code dans ton navigateur, obtiens de l'aide instantanée d'un tuteur IA disponible 24h/24, et reprends là où tu t'es arrêté sur le web ou dans l'app.

Cours
24
Leçons
93

Questions Fréquemment Posées

La leçon « Contrôles d’intégrité et métriques » est-elle gratuite ?

Oui — le texte complet de « Contrôles d’intégrité et métriques » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Spring Boot 4 Microservices & REST APIs, passe à CoddyKit PRO. Le cours Spring Boot 4 Microservices & REST APIs comprend 3 leçons au total.

Qu'est-ce que j'apprendrai dans « Contrôles d’intégrité et métriques » ?

Mettez en œuvre Spring Boot Actuator pour exposer des points de terminaison d’intégrité et recueillir les métriques de l’application. Tu pratiques Spring Boot 4 Microservices & REST APIs avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Spring Boot 4 Microservices & REST APIs ?

Aucune expérience préalable n'est requise. Spring Boot 4 Microservices & REST APIs sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 3.

Combien de temps prend la leçon « Contrôles d’intégrité et métriques » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Spring Boot 4 Microservices & REST APIs ?

Oui. Chaque leçon Spring Boot 4 Microservices & REST APIs inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

  1. Journalisation centralisée avec la pile ELK
  2. Contrôles d’intégrité et métriques
  3. Alertes et tableaux de bord
← Retour à Spring Boot 4 Microservices & REST APIs