giuseppe-trisciuoglio/developer-kit

Comprehensive developer toolkit providing reusable skills for Java/Spring Boot, TypeScript/NestJS/React/Next.js, Python, PHP, AWS CloudFormation, AI/RAG, DevOps, and more.

Quality

82%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Securityby

Risky

Do not use without reviewing

Validation failed for skills in this tile

One or more skills have errors that need to be fixed before they can move to Implementation and Discovery review.

Endpoint Reference

Name: giuseppe-trisciuoglio/developer-kit
Rating: 82.6470588235294 (1 reviews)
Author: giuseppe-trisciuoglio

This document provides a comprehensive reference for all available Spring Boot Actuator endpoints.

Built-in Endpoints

Endpoint	HTTP Method	Description	Default Exposure
`auditevents`	GET	Audit events for the application	JMX
`beans`	GET	Complete list of Spring beans	JMX
`caches`	GET, DELETE	Available caches	JMX
`conditions`	GET	Configuration and auto-configuration conditions	JMX
`configprops`	GET	Configuration properties	JMX
`env`	GET, POST	Environment properties	JMX
`flyway`	GET	Flyway database migrations	JMX
`health`	GET	Application health information	Web, JMX
`heapdump`	GET	Heap dump	JMX
`httpexchanges`	GET	HTTP exchange information	JMX
`info`	GET	Application information	Web, JMX
`integrationgraph`	GET	Spring Integration graph	JMX
`logfile`	GET	Application log file	JMX
`loggers`	GET, POST	Logger configuration	JMX
`liquibase`	GET	Liquibase database migrations	JMX
`mappings`	GET	Request mapping information	JMX
`metrics`	GET	Application metrics	JMX
`prometheus`	GET	Prometheus metrics	None
`quartz`	GET	Quartz scheduler information	JMX
`scheduledtasks`	GET	Scheduled tasks	JMX
`sessions`	GET, DELETE	User sessions	JMX
`shutdown`	POST	Graceful application shutdown	JMX
`startup`	GET	Application startup information	JMX
`threaddump`	GET	Thread dump	JMX

Endpoint URLs

Web Endpoints

Base path: /actuator
Example: GET /actuator/health
Custom base path: management.endpoints.web.base-path

JMX Endpoints

Domain: org.springframework.boot
Example: org.springframework.boot:type=Endpoint,name=Health

Endpoint Configuration

Global Configuration

management:
  endpoints:
    enabled-by-default: true
    web:
      exposure:
        include: "health,info,metrics"
        exclude: "env,beans"
      base-path: "/actuator"
      path-mapping:
        health: "status"
    jmx:
      exposure:
        include: "*"

Individual Endpoint Configuration

management:
  endpoint:
    health:
      enabled: true
      show-details: when-authorized
      show-components: always
      cache:
        time-to-live: 10s
    metrics:
      enabled: true
      cache:
        time-to-live: 0s
    info:
      enabled: true

Security Configuration

Web Security

@Configuration
public class ActuatorSecurityConfiguration {

    @Bean
    @Order(1)
    public SecurityFilterChain actuatorSecurityFilterChain(HttpSecurity http) throws Exception {
        return http
            .requestMatcher(EndpointRequest.toAnyEndpoint())
            .authorizeHttpRequests(requests -> 
                requests
                    .requestMatchers(EndpointRequest.to("health", "info")).permitAll()
                    .anyRequest().hasRole("ACTUATOR")
            )
            .httpBasic(withDefaults())
            .build();
    }
}

Method-level Security

@PreAuthorize("hasRole('ADMIN')")
@GetMapping("/actuator/shutdown")
public Object shutdown() {
    // Shutdown logic
}

Custom Endpoints

Creating Custom Endpoints

@Component
@Endpoint(id = "custom")
public class CustomEndpoint {

    @ReadOperation
    public Map<String, Object> customEndpoint() {
        return Map.of("custom", "data");
    }

    @WriteOperation
    public void writeOperation(@Selector String name, String value) {
        // Write operation
    }

    @DeleteOperation
    public void deleteOperation(@Selector String name) {
        // Delete operation
    }
}

Web-specific Endpoints

@Component
@WebEndpoint(id = "web-custom")
public class WebCustomEndpoint {

    @ReadOperation
    public WebEndpointResponse<Map<String, Object>> webCustomEndpoint() {
        Map<String, Object> data = Map.of("web", "specific");
        return new WebEndpointResponse<>(data, 200);
    }
}