{"id":132031,"date":"2025-03-10T08:39:00","date_gmt":"2025-03-10T06:39:00","guid":{"rendered":"https:\/\/www.javacodegeeks.com\/?p=132031"},"modified":"2025-03-06T20:54:52","modified_gmt":"2025-03-06T18:54:52","slug":"custom-spring-boot-actuator-endpoints","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2025\/03\/custom-spring-boot-actuator-endpoints.html","title":{"rendered":"Custom Spring Boot Actuator Endpoints"},"content":{"rendered":"

Spring Boot Actuator is a powerful tool that provides production-ready features to monitor and manage your application. It comes with built-in endpoints for health checks, metrics, environment properties, and more. However, in many cases, you may need to extend these capabilities by creating custom endpoints, securing them, or tailoring them to your application’s specific needs.<\/p>\n

\n
\"\"<\/a><\/figure>\n<\/div>\n

In this article, we\u2019ll explore:<\/p>\n

    \n
  1. Creating custom health checks and metrics endpoints.<\/strong><\/li>\n
  2. Securing actuator endpoints with Spring Security<\/a>.<\/strong><\/li>\n
  3. Best practices and opinions from the developer community.<\/strong><\/li>\n<\/ol>\n

    1. Creating Custom Health Checks and Metrics Endpoints<\/h2>\n

    1.1 Custom Health Checks<\/h3>\n

    Spring Boot Actuator provides a \/health<\/code> endpoint that shows the health status of your application. You can extend this by creating custom health indicators.<\/p>\n

    Example: Custom Health Indicator<\/h4>\n

    Let\u2019s say you want to check the health of an external service (e.g., a database or an API).<\/p>\n

    \nimport org.springframework.boot.actuate.health.Health;\nimport org.springframework.boot.actuate.health.HealthIndicator;\nimport org.springframework.stereotype.Component;\n\n@Component\npublic class ExternalServiceHealthIndicator implements HealthIndicator {\n\n    @Override\n    public Health health() {\n        \/\/ Simulate a check to an external service\n        boolean isServiceUp = checkExternalService();\n\n        if (isServiceUp) {\n            return Health.up().withDetail(\"External Service\", \"Available\").build();\n        } else {\n            return Health.down().withDetail(\"External Service\", \"Unavailable\").build();\n        }\n    }\n\n    private boolean checkExternalService() {\n        \/\/ Logic to check the external service\n        return true; \/\/ Replace with actual check\n    }\n}\n<\/pre>\n
    When you hit the\u00a0\/actuator\/health<\/code>\u00a0endpoint, you\u2019ll see the custom health indicator in the response:<\/p>\n
    \n{\n  \"status\": \"UP\",\n  \"components\": {\n    \"externalService\": {\n      \"status\": \"UP\",\n      \"details\": {\n        \"External Service\": \"Available\"\n      }\n    }\n  }\n}\n<\/pre>\n
    1.2 Custom Metrics<\/h3>\n
    Spring Boot Actuator integrates with Micrometer, a metrics collection library. You can create custom metrics to track application-specific data.<\/p>\n
    Example: Custom Metric<\/h4>\n
    Let\u2019s create a custom counter metric to track the number of times a specific method is called.<\/p>\n
    \nimport io.micrometer.core.instrument.Counter;\nimport io.micrometer.core.instrument.MeterRegistry;\nimport org.springframework.stereotype.Service;\n\n@Service\npublic class MyService {\n\n    private final Counter myCounter;\n\n    public MyService(MeterRegistry registry) {\n        this.myCounter = registry.counter(\"my.custom.counter\");\n    }\n\n    public void doSomething() {\n        \/\/ Business logic\n        myCounter.increment(); \/\/ Increment the counter\n    }\n}\n<\/pre>\n
    You can view this metric at the \/actuator\/metrics\/my.custom.counter<\/code> endpoint.<\/p>\n
    2. Securing Actuator Endpoints with Spring Security<\/h2>\n
    Actuator endpoints expose sensitive information about your application, so it\u2019s crucial to secure them. Spring Security can help you restrict access to these endpoints.
     
    <\/div> <\/div><\/p>\n
    2.1 Example: Securing Actuator Endpoints<\/h3>\n
    Add Spring Security to your project and configure it to secure actuator endpoints.<\/p>\n
    Step 1: Add Dependencies<\/h4>\n
    Add the following dependencies to your pom.xml<\/code> or build.gradle<\/code>:<\/p>\n
    \n<dependency>\n    <groupId>org.springframework.boot<\/groupId>\n    <artifactId>spring-boot-starter-security<\/artifactId>\n<\/dependency>\n<dependency>\n    <groupId>org.springframework.boot<\/groupId>\n    <artifactId>spring-boot-starter-actuator<\/artifactId>\n<\/dependency>\n<\/pre>\n
    Step 2: Configure Security<\/h4>\n
    Create a security configuration class to restrict access to actuator endpoints.<\/p>\n
    \nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.security.config.annotation.web.builders.HttpSecurity;\nimport org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;\nimport org.springframework.security.core.userdetails.User;\nimport org.springframework.security.core.userdetails.UserDetails;\nimport org.springframework.security.core.userdetails.UserDetailsService;\nimport org.springframework.security.provisioning.InMemoryUserDetailsManager;\nimport org.springframework.security.web.SecurityFilterChain;\n\n@Configuration\n@EnableWebSecurity\npublic class SecurityConfig {\n\n    @Bean\n    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {\n        http\n            .authorizeHttpRequests((requests) -> requests\n                .requestMatchers(\"\/actuator\/**\").hasRole(\"ADMIN\") \/\/ Secure actuator endpoints\n                .anyRequest().permitAll()\n            )\n            .httpBasic(); \/\/ Use HTTP Basic authentication\n\n        return http.build();\n    }\n\n    @Bean\n    public UserDetailsService userDetailsService() {\n        UserDetails user = User.withDefaultPasswordEncoder()\n            .username(\"admin\")\n            .password(\"password\")\n            .roles(\"ADMIN\")\n            .build();\n        return new InMemoryUserDetailsManager(user);\n    }\n}\n<\/pre>\n
    Now, only users with the ADMIN<\/code> role can access actuator endpoints. You can test this by visiting \/actuator\/health<\/code> and providing the credentials (admin\/password<\/code>).<\/p>\n
    3. Best Practices and Opinions<\/h2>\n
    3.1 Best Practices<\/h3>\n