00:00

Help Us Improve

We're sorry this tutorial wasn't helpful. Please tell us what we can do better.

Spring Boot Actuator

Spring Boot Actuator is a powerful module provided by the Spring Boot framework that helps you monitor, manage, and observe your application in production. It exposes a set of built-in endpoints that give insights into the application’s health, metrics, environment, configuration, and runtime behavior.

In simple terms, Actuator answers questions like:

  • Is my application running?
  • Is the database connected?
  • How much memory is being used?
  • How many requests are coming to my APIs?

Why Do We Need Spring Boot Actuator?

When an application goes live, developers and operations teams need visibility into what is happening inside it. Spring Boot Actuator provides this visibility without writing extra code.

  • Helps monitor application health
  • Provides runtime metrics
  • Supports production-ready features
  • Helps in troubleshooting issues quickly
  • Integrates easily with monitoring tools

Adding Spring Boot Actuator Dependency

To use Actuator, you just need to add one dependency to your Spring Boot project.

Maven Dependency:

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

Once added, Actuator endpoints become available automatically.

What Are Actuator Endpoints?

Actuator endpoints are special URLs that expose information about the application. By default, these endpoints are exposed under the /actuator base path.

Example: 

    http://localhost:8080/actuator

This endpoint returns a list of all available actuator endpoints.

Important Actuator Endpoints

1. Health Endpoint

The /actuator/health endpoint shows the health status of the application. It checks components like database, disk space, and custom health indicators. 

    http://localhost:8080/actuator/health

Possible health status:

  • UP – Application is healthy
  • DOWN – Application is not healthy
  • OUT_OF_SERVICE – Temporarily unavailable
  • UNKNOWN – Status cannot be determined

2. Info Endpoint

The /actuator/info endpoint displays custom application information such as application name, version, or build details. 

    http://localhost:8080/actuator/info

You can configure this information in the application.properties file.

3. Metrics Endpoint

The /actuator/metrics endpoint provides various metrics like memory usage, CPU usage, HTTP request count, and response time. 

    http://localhost:8080/actuator/metrics

Example metrics include:

  • jvm.memory.used
  • jvm.gc.memory.promoted
  • http.server.requests
  • process.cpu.usage

4. Environment Endpoint

The /actuator/env endpoint exposes environment properties such as system variables, JVM properties, and application configuration. 

    http://localhost:8080/actuator/env

This is useful for debugging configuration-related issues.

5. Beans Endpoint

The /actuator/beans endpoint shows all Spring beans loaded in the application context along with their dependencies. 

    http://localhost:8080/actuator/beans

6. Mappings Endpoint

The /actuator/mappings endpoint displays all HTTP request mappings (controller URLs) in the application. 

    http://localhost:8080/actuator/mappings

7. Loggers Endpoint

The /actuator/loggers endpoint allows you to view and change log levels at runtime without restarting the application. 

    http://localhost:8080/actuator/loggers

Enabling and Exposing Actuator Endpoints

By default, only a few endpoints are exposed. You can control which endpoints are enabled using configuration.

application.properties:

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

To expose all endpoints: 

    management.endpoints.web.exposure.include=*

Securing Actuator Endpoints

Actuator endpoints expose sensitive information, so they should be secured in production. Spring Security can be used to restrict access.

  • Expose only required endpoints
  • Restrict access to authorized users
  • Disable sensitive endpoints in production

Custom Health Indicators

Spring Boot Actuator allows you to create custom health checks for your application components. For example, you can check the status of an external API or a custom service.

Custom health indicators help ensure complete application observability.

Integrating Actuator with Monitoring Tools

Actuator integrates seamlessly with monitoring and observability tools such as:

  • Prometheus
  • Grafana
  • Micrometer
  • Elastic Stack

These tools help visualize metrics and set alerts based on application behavior.

Advantages of Spring Boot Actuator

  • Minimal configuration required
  • Production-ready monitoring
  • Improves application reliability
  • Helps in proactive issue detection
  • Standardized monitoring approach

Conclusion

Spring Boot Actuator is an essential tool for building production-ready applications. It provides deep insights into application health, performance, and configuration with minimal effort. By using Actuator effectively and securely, teams can ensure better monitoring, faster troubleshooting, and improved system stability.