spring-observability — GitHub Copilot skill: what it does, install
spring-observability — a GitHub Copilot skill that sets up and audits observability in Spring Boot 3 and 4 services. Runs when adding Micrometer metrics, OpenTelemetry tracing, and structured logging around Actuator.
MIT ★ 41,430 updated 2026-10-23
gh skill install github/awesome-copilot skills/spring-observabilityWhat spring-observability does
This skill guides the implementation and inspection of monitoring tooling in Spring Boot 3 and 4 codebases. It checks whether the project uses Boot 3 or 4, audits existing starters for Actuator, Micrometer registries, and logging configs, and guides Prometheus or OTLP export setup alongside Observation API tracing.
Security guardrails are built directly into its rules. It strictly avoids reading environment tokens or credentials from /actuator/env, prevents public exposure of heapdump or threaddump endpoints without authentication and TLS, and pins all dependencies to the Spring Boot BOM rather than hardcoding artifact versions.
What it helps with
- expose and secure Spring Boot Actuator endpoints
- export Micrometer metrics to Prometheus or OTLP collectors
- configure OpenTelemetry tracing using the Observation API
- set up JSON structured logs with trace and span IDs
Example prompts for the agent
- Configure Kubernetes container liveness and readiness health checks in Actuator inside
application.yaml. - Set up Micrometer metric exports to Prometheus and enable OpenTelemetry tracing.
- Add trace and span correlation IDs to JSON structured logging.
How to install spring-observability
1GitHub CLI
gh skill install github/awesome-copilot skills/spring-observability2Manually: put the files in place
.github/skills/spring-observability/SKILL.md1Skills CLI (Vercel)
npx skills add github/awesome-copilot --skill spring-observability -a claude-code2Manually: put the files in place
~/.claude/skills/spring-observability/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/spring-observability/
1Skills CLI (Vercel)
npx skills add github/awesome-copilot --skill spring-observability -a codex2Manually: put the files in place
.agents/skills/spring-observability/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add github/awesome-copilot --skill spring-observability -a cursor2Manually: put the files in place
.cursor/skills/spring-observability/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1Skills CLI (Vercel)
npx skills add github/awesome-copilot --skill spring-observability -a gemini-cli2Platform CLI
gemini skills install https://github.com/github/awesome-copilot --path skills/spring-observabilityManually: put the files in place
.devin/skills/spring-observability/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about spring-observability
How to install spring-observability in GitHub Copilot?
Run gh skill install github/awesome-copilot skills/spring-observability. The definition is saved to .github/skills/spring-observability/SKILL.md.
What does spring-observability do?
It provides checklists and configuration templates for Actuator endpoints, Micrometer metrics, OpenTelemetry tracing, and structured logging in Spring Boot 3 and 4.
What security rules does spring-observability follow?
It refuses to print secrets from /actuator/env, avoids unauthenticated exposure of diagnostic endpoints like heapdump, and requires version management via the Boot BOM.
Source text
SKILL.md · MIT
---
name: spring-observability
description: 'Add and review observability in Spring Boot 3/4 apps: Actuator exposure and health probes, Micrometer metrics, Observation API, OpenTelemetry tracing and OTLP/Prometheus export, structured logging with correlation ids, and safe use of heapdump/threaddump. Use when instrumenting, monitoring or troubleshooting a Spring Boot service.'
---
# Spring Boot observability
Covers Actuator, Micrometer, the Observation API, tracing, and logging. Details in `references/`. For JDK-level diagnosis (thread dumps, JFR, heap analysis) see the `java-diagnostics` skill; for securing endpoints see `spring-security`.
## Safety rules
- Never read or print secrets (`.env`, credentials, tokens) while inspecting configuration or `/actuator/env`.
- Never expose `heapdump` or `threaddump` over public HTTP. The only exception is a temporary, user-consented window with authentication, TLS and network restriction, removed afterwards (same policy in `java-diagnostics`).
- Never expose `env`, `configprops`, `loggers`, or `shutdown` in production without authentication and network restrictions.
- Pin dependency versions via the Boot BOM; do not add explicit versions for Boot-managed artifacts.
## Detect first
Check the Boot version (3.x or 4.x) and what is already present (`spring-boot-starter-actuator`, `micrometer-registry-*`, tracing/OTel dependencies, `logback-spring.xml`). Boot 4 modularized observability (`spring-boot-micrometer-*`, `spring-boot-opentelemetry`) but starters still bring them in.
## Quick start
```xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
```
```yaml
management:
endpoints:
web:
exposure:
include: health,info,prometheus # allow-list, never "*" in production
endpoint:
health:
probes:
enabled: true # /actuator/health/liveness and /readiness
show-details: when-authorized
```
## Topics
- [Actuator, health groups and probes, endpoint exposure](references/actuator.md)
- [Micrometer metrics and Prometheus/OTLP export](references/metrics.md)
- [Observation API and tracing with OpenTelemetry](references/tracing-observation.md)
- [Structured logging and correlation ids](references/logging.md)
- [Heapdump/threaddump caveats and runtime diagnosis](references/dumps-and-diagnostics.md)
## Checklist
- [ ] Only needed endpoints exposed and secured; separate management port if possible.
- [ ] Liveness/readiness probes configured for the platform (Kubernetes); readiness group includes critical dependencies only.
- [ ] Metrics exported to the chosen backend; common tags (`application`, `env`) set; no high-cardinality tags (user ids, URLs with ids).
- [ ] Tracing sampling probability set deliberately (Boot default 10%).
- [ ] Logs carry trace/span ids; JSON structured logs in production.
- [ ] Custom observations/metrics have tests.
## Local runtime insights (optional)
For a local-only developer console (and an opt-in MCP server) that shows a running Spring Boot or Quarkus app's runtime state, see BootUI: https://github.com/jdubois/boot-ui and https://www.julien-dubois.com/boot-ui/. Its agent skill can be installed with `gh skill install jdubois/boot-ui skills/bootui`.
- Ask the user for consent before adding any dependency.
- Use it only in a dev/local profile (for example a Maven/Gradle profile or `developmentOnly` configuration); never ship it to production.
- Follow BootUI's own documentation for coordinates and setup rather than copying them here.
See also: <https://docs.spring.io/spring-boot/reference/actuator/observability.html> and <https://docs.micrometer.io/micrometer/reference/>.
© github · MIT · github/awesome-copilot