Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jorgermduarte/prometheus-alerts-test
Simple test project to test the grafana dashboard logs from servlet requests
https://github.com/jorgermduarte/prometheus-alerts-test
alertmanager app docker docker-compose grafana http java node prometheus requests servlet
Last synced: about 22 hours ago
JSON representation
Simple test project to test the grafana dashboard logs from servlet requests
- Host: GitHub
- URL: https://github.com/jorgermduarte/prometheus-alerts-test
- Owner: jorgermduarte
- License: mit
- Created: 2023-09-14T15:15:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-20T22:02:02.000Z (about 1 year ago)
- Last Synced: 2024-05-28T21:19:58.827Z (6 months ago)
- Topics: alertmanager, app, docker, docker-compose, grafana, http, java, node, prometheus, requests, servlet
- Language: Java
- Homepage:
- Size: 141 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Endpoint URI Tagging for Prometheus Metrics in Spring Boot
## Problem Description
When using Spring Boot with Prometheus for monitoring and metrics, you might encounter a situation where Prometheus registers requests with an "UNKNOWN" URI. This happens because, by default, Spring Boot does not provide Prometheus with endpoint information, leading to incomplete monitoring data.
## Solution
To resolve this issue and obtain accurate endpoint information in Prometheus, we can implement a URI tagging filter. This filter will capture incoming requests, extract their URIs, and tag the Prometheus metrics with the corresponding URIs.
## Implementation
In your Spring Boot application, follow these steps:
1. Create a controller that handles a generic route for various URIs:
```java
@RestController
@RequestMapping("/report/odata4")
public class TestController {
@RequestMapping("/**")
@GetMapping
@PostMapping
public void genericRoute(final HttpServletRequest req, final HttpServletResponse resp) throws IOException {
resp.setContentType("text/html");
try (final PrintWriter writer = resp.getWriter()) {
writer.println("");
writer.println("
Hello, Controller
");
writer.println("");
}
}
}
2. Create a configuration class that registers a UriTaggingFilter as a filter bean. This filter will tag Prometheus metrics with the request URI.
```java
@Configuration
public class PrometheusUriFilterConfig {
@Bean
public FilterRegistrationBean uriTaggingFilter(MeterRegistry meterRegistry) {
FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();
registrationBean.setFilter(new UriTaggingFilter(meterRegistry));
registrationBean.addUrlPatterns("/*");
return registrationBean;
}
@WebFilter("/*")
public static class UriTaggingFilter extends OncePerRequestFilter {
private final MeterRegistry meterRegistry;
public UriTaggingFilter(MeterRegistry meterRegistry) {
this.meterRegistry = meterRegistry;
}
@Override
protected void doFilterInternal(
HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain) throws ServletException, IOException {
long startTime = System.currentTimeMillis();
try {
filterChain.doFilter(request, response);
} finally {
long endTime = System.currentTimeMillis();
long requestTime = endTime - startTime;
String uri = request.getRequestURI();
Timer.builder("http.server.requests")
.tags("uri", uri)
.register(meterRegistry)
.record(requestTime, TimeUnit.MILLISECONDS);
}
}
}
}
```
With this configuration, your Prometheus metrics will now include accurate endpoint information.
