spring-boot-actuator
Set up production-ready observability for Spring Boot services using Actuator endpoints, health probes, and Micrometer integration. This skill covers dependency setup, endpoint exposure, security policies, custom health indicators, and metrics export to systems like Prometheus. Follow step-by-step instructions to bootstrap monitoring, secure management traffic, and enable diagnostics tooling for incident response.
Spring Boot Actuator Skill enables production-grade monitoring, health checks, and metrics for Spring Boot services.
AI-generated summary based on this skill's SKILL.md
Install
giuseppe-trisciuoglio/developer-kit/spring-boot-actuator · repository language: Python
git clone https://github.com/giuseppe-trisciuoglio/developer-kit
cp -r developer-kit/plugins/developer-kit-java/skills/spring-boot-actuator ~/.claude/skills/spring-boot-actuatornpx skillfed install giuseppe-trisciuoglio/developer-kit/spring-boot-actuatorFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I enable actuator endpoints in Spring Boot?
spring-boot-actuator endpoints are enabled by adding the spring-boot-starter-actuator dependency and configuring exposure in application.properties or application.yml. By default, only the /health endpoint is exposed over HTTP; enable others via management.endpoints.web.include=* or list specific endpoints like metrics,info,env. Use management.endpoints.web.base-path to customize the path prefix (default /actuator).
What is spring boot actuator setup and how do I start?
spring-boot-actuator setup begins with adding the starter dependency, then configuring which endpoints to expose and on which port. Add spring-boot-starter-actuator to your pom.xml or build.gradle, set management.endpoints.web.include in application.properties, and optionally configure management.server.port for a separate management interface. This enables health checks, metrics, and diagnostics endpoints for production monitoring.
How do I secure spring boot actuator endpoints with authentication?
Secure spring-boot-actuator endpoints by integrating Spring Security and restricting access to management endpoints. Configure security rules to require authentication for sensitive endpoints like /actuator/env or /actuator/shutdown. Use role-based access control (e.g., ROLE_ADMIN) and consider running the management port on a private network. Disable unnecessary endpoints via management.endpoints.web.exclude to reduce attack surface.
How do I configure actuator metrics prometheus export?
Configure spring-boot-actuator metrics for Prometheus by adding the micrometer-registry-prometheus dependency. This exposes metrics at /actuator/prometheus in Prometheus text format. Add spring-boot-starter-actuator and micrometer-registry-prometheus to your build, then configure Prometheus to scrape your application's /actuator/prometheus endpoint. Customize metric collection with management.metrics.* properties.
What are readiness and liveness probes in spring boot actuator?
spring-boot-actuator provides /actuator/health/readiness and /actuator/health/liveness endpoints for Kubernetes and container orchestration. Readiness probes indicate if the application can handle traffic; liveness probes detect if it needs restart. Enable them via management.health.livenessState.enabled=true and management.health.readinessState.enabled=true. Customize health indicators to reflect your application's dependencies and startup requirements.
How do I troubleshoot missing spring boot actuator endpoints?
Troubleshoot spring-boot-actuator endpoint issues by verifying the starter dependency is present, checking management.endpoints.web.include configuration, and confirming the endpoint is not excluded. Use /actuator to list available endpoints, inspect application logs for startup errors, and validate that Spring Security rules don't block access. Ensure management.server.port is accessible if using a separate management interface.
SKILL.md
rendered from the published skill — quoted content, verbatim
Spring Boot Actuator Skill
Overview
- Deliver production-ready observability for Spring Boot services using Actuator endpoints, probes, and Micrometer integration.
- Standardize health, metrics, and diagnostics configuration while delegating deep reference material to
references/. - Support platform requirements for secure operations, SLO reporting, and incident diagnostics.
When to Use
- Trigger: "enable actuator endpoints" – Bootstrap Actuator for a new or existing Spring Boot service.
- Trigger: "secure management port" – Apply Spring Security policies to protect management traffic.
- Trigger: "configure health probes" – Define readiness and liveness groups for orchestrators.
- Trigger: "export metrics to prometheus" – Wire Micrometer registries and tune metric exposure.
- Trigger: "debug actuator startup" – Inspect condition
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 15 files
plugins/developer-kit-java/skills/spring-boot-actuator/SKILL.md
plugins/developer-kit-java/skills/spring-boot-actuator/assets/.gitkeep
plugins/developer-kit-java/skills/spring-boot-actuator/references/auditing.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/cloud-foundry.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/enabling.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/endpoint-reference.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/endpoints.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/examples.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/http-exchanges.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/jmx.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/loggers.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/metrics.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/monitoring.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/observability.md
plugins/developer-kit-java/skills/spring-boot-actuator/references/process-monitoring.md