spring-boot-actuator_skill

This skill helps you configure Spring Boot Actuator for production-grade monitoring, health checks, and secure, observable JVM services.

Python

99

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill giuseppe-trisciuoglio/developer-kit --skill spring-boot-actuator

SKILL.md9.4 KB

Overview

This skill provides production-ready patterns to configure Spring Boot Actuator for monitoring, health probes, secured management endpoints, and Micrometer metrics across JVM services. It standardizes endpoint exposure, security, health grouping, and exporter wiring so teams can quickly enable robust observability and safe diagnostics. Use it to meet platform SLOs, automate health probes, and centralize metrics export to Prometheus or OTLP.

How this skill works

The skill inspects and prescribes configuration settings and code patterns for actuator dependencies, management ports, endpoint exposure, and Spring Security integration. It guides enabling readiness/liveness probes, creating health groups and custom HealthIndicator implementations, and wiring Micrometer registries for chosen exporters. It also recommends diagnostic endpoints (/startup, /conditions, /httpexchanges) and validation steps to verify endpoints and metrics are available.

When to use it

Bootstrapping Actuator for a new or existing Spring Boot service
Securing management traffic and isolating a management port
Defining readiness and liveness probes for orchestrators (Kubernetes, Cloud Foundry)
Exporting metrics to Prometheus, OTLP, or another Micrometer backend
Troubleshooting missing or slow actuator endpoints during startup

Best practices

Apply least privilege: expose only required endpoints and protect sensitive ones with role-based rules
Use a dedicated management port and firewall/service-mesh policies for operator access
Enable health probes and group indicators to match orchestrator expectations
Add application and environment tags via MeterRegistryCustomizer for cross-service correlation
Automate endpoint and metrics checks in CI/CD with scripted curl probes

Example use cases

Enable /actuator/health and /actuator/info for safe production health checks
Create a readiness group that includes DB and external payment gateway indicators
Secure all endpoints except /actuator/health when public access is required
Run a Prometheus exporter on a dedicated management port with SSL and role-based access
Enable /actuator/startup and /actuator/conditions temporarily for incident diagnosis

FAQ

Avoid exposing /env, /configprops, /logfile, /heapdump, /beans, and /mappings on public networks; restrict via exposure list and security rules.

How do I add custom health checks without harming performance?

Implement small, non-blocking HealthIndicator or ReactiveHealthContributor; avoid long-running calls and aim for <250 ms, or delegate expensive checks to asynchronous background samplers.