spring-projects / spring-projects/spring-boot

Make Actuator endpoint metrics distinguishable

Open
#13,435 2 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: blocked theme: observability type: enhancement
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

When querying metrics, I would like to be able to query metrics related to endpoints (http.server.requests) such that I can filter out non-user facing endpoints like the Actuator endpoints. When monitoring, I want to look at things like request rate, error rate, and latency on user-facing endpoints, without access to the Actuator endpoints affecting those metrics.

If such filtering were possible, it could be used in excluding Actuator endpoints from alerts and graphs and ad hoc queries, when desired.

Some metrics backends may allow querying with wildcards/regex to approximate this. For example, in PromQL, the 5m request rate excluding Actuator endpoints might be written like this:

rate(http_server_requests_seconds_count{uri !~ "/actuator.*"}[5m])

But for a query like above to work, it would require all applications use the same management context-path. Having a simpler, more robust way to filter via a tag would be helpful.

/CC @jkschneider

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue centers on http.server.requests and Actuator endpoints; start by tracing how Spring Boot exposes and tags these metrics and how the management context path is represented. Compare the requested tag-based filtering with the PromQL example; done means users can exclude Actuator traffic without relying on a shared context path.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, prometheus, spring-boot
Domain
backend, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.