Custom actuator metric with request counter (experimental)#836
Merged
Conversation
dennisvang
force-pushed
the
feature/661-metrics
branch
from
b1a58f1 to
e957051
Compare
Contributor
Author
|
Initially I implemented this by extending However, a micrometer dev suggested another approach in this comment from 2018. The latest and greatest approach is probably to override either DefaultServerRequestObservationConvention, or micrometer ObservationFilter, as mentioned in the observability docs. |
dennisvang
force-pushed
the
feature/661-metrics
branch
2 times, most recently
from
eca3a0e to
401221b
Compare
Contributor
Author
|
ran into #839 |
dennisvang
force-pushed
the
feature/661-metrics
branch
from
401221b to
4c69720
Compare
Contributor
Author
|
The current implementation still shows all metrics, so the filter in This can be checked as follows: curl http://localhost:8080/actuator/metrics | jqwhich still returns a long list, instead of just Details
{
"names": [
"application.ready.time",
"application.started.time",
"executor.active",
"executor.completed",
"executor.pool.core",
"executor.pool.max",
"executor.pool.size",
"executor.queue.remaining",
"executor.queued",
"http.client.requests",
"http.client.requests.active",
"http.server.requests",
"http.server.requests.active",
"mongodb.driver.commands",
"mongodb.driver.pool.checkedout",
"mongodb.driver.pool.checkoutfailed",
"mongodb.driver.pool.size",
"mongodb.driver.pool.waitqueuesize",
"spring.data.repository.invocations",
"spring.security.authorizations",
"spring.security.authorizations.active",
"spring.security.filterchains",
"spring.security.filterchains.CORSFilter.after",
"spring.security.filterchains.CORSFilter.before",
"spring.security.filterchains.JwtTokenFilter.after",
"spring.security.filterchains.JwtTokenFilter.before",
"spring.security.filterchains.LoggingFilter.after",
"spring.security.filterchains.LoggingFilter.before",
"spring.security.filterchains.access.exceptions.after",
"spring.security.filterchains.access.exceptions.before",
"spring.security.filterchains.active",
"spring.security.filterchains.authentication.anonymous.after",
"spring.security.filterchains.authentication.anonymous.before",
"spring.security.filterchains.authorization.after",
"spring.security.filterchains.authorization.before",
"spring.security.filterchains.context.async.after",
"spring.security.filterchains.context.async.before",
"spring.security.filterchains.context.holder.after",
"spring.security.filterchains.context.holder.before",
"spring.security.filterchains.context.servlet.after",
"spring.security.filterchains.context.servlet.before",
"spring.security.filterchains.header.after",
"spring.security.filterchains.header.before",
"spring.security.filterchains.logout.after",
"spring.security.filterchains.logout.before",
"spring.security.filterchains.requestcache.after",
"spring.security.filterchains.requestcache.before",
"spring.security.filterchains.session.management.after",
"spring.security.filterchains.session.management.before",
"spring.security.filterchains.session.urlencoding.after",
"spring.security.filterchains.session.urlencoding.before",
"spring.security.http.secured.requests",
"spring.security.http.secured.requests.active",
"tomcat.sessions.active.current",
"tomcat.sessions.active.max",
"tomcat.sessions.alive.max",
"tomcat.sessions.created",
"tomcat.sessions.expired",
"tomcat.sessions.rejected"
]
} |
Creates a custom actuator metric that counts requests to custom endpoints
and use Optional to handle nullable query string
conforming to the existing http.server.requests metric name
…ionFilter implementation following the examples from the spring-boot docs https://docs.spring.io/spring-framework/reference/integration/observability.html#observability.config.conventions
Here we override the DefaultServerRequestObservationConvention instead of subclassing the ObservationFilter Based on advise by micrometer devs.
dennisvang
force-pushed
the
feature/661-metrics
branch
from
9c7fc37 to
cd2e98c
Compare
metrics are a new feature
Contributor
Author
|
Debugging shows that the This is caused by conflicting annotations on the UPDATE: Now fixed by #906 |
Closed
the metrics filter configuration functions as expected now, after the configuration changes from #906
so we can be sure the authentication requirement also applies to sub-paths of /actuator/metrics
for consistency
pulling in changes w.r.t the switch from develop to master, and annotation cleanup
dennisvang
force-pushed
the
feature/661-metrics
branch
from
cf7fe1a to
a792d6b
Compare
dennisvang
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Experimental actuator endpoint that counts requests to individual resources.
Only available for authenticated users.
Can be disabled by changing the following
metricsconfig:FAIRDataPoint/src/main/resources/application.yml
Lines 35 to 40 in 252a976
The default Spring MVC actuator metric http.server.requests does not count requests for individual resources. Instead, and for a good reason, it only shows counts for the path patterns defined for the controllers, such as
FAIRDataPoint/src/main/java/org/fairdatapoint/api/controller/metadata/GenericController.java
Line 150 in f65cd35
To count requests to individual resource URIs, we customized the
DefaultServerRequestObservationConventionto replace the defaulturipath pattern by the full path. Also see spring observability docs.Note
Although it is relatively quick and easy to use Spring actuator metrics for this, I'm not convinced this is the best approach. I think it would make more sense to do this at the deployment level, e.g. based on proxy logs, instead of the app level.
fixes #661
todo
So, figure out why the following lines are ignored by the fdp, whereas they do work in a fresh spring project, and they also work without issue if we apply them to the(fixed via Replace outdated method security configuration #906)developbranch...FAIRDataPoint/src/main/resources/application.yml
Lines 35 to 39 in 4c69720
usage example
To see totals and list available endpoints (they only appear in the list after they have been visited at least once):
curl http://localhost:8080/actuator/metrics/http.server.requests | jq{ "name": "http.server.requests", "baseUnit": "seconds", "measurements": [ { "statistic": "COUNT", "value": 67.0 }, { "statistic": "TOTAL_TIME", "value": 1.3833911090000002 }, { "statistic": "MAX", "value": 0.089165968 } ], "availableTags": [ { "tag": "exception", "values": [ "none" ] }, { "tag": "method", "values": [ "POST", "PUT", "GET" ] }, { "tag": "http.url", "values": [ "/index/admin/trigger", "/configs/bootstrap", "/index/entries", "/index/entries/info", "/index/entries/654b5878-fc8a-44db-bb47-81754617f5a5", "/spec", "/actuator/info", "/actuator/metrics/", "/actuator/metrics/http.server.requests", "/meta", "/" ] }, { "tag": "error", "values": [ "none" ] }, { "tag": "outcome", "values": [ "CLIENT_ERROR", "SUCCESS" ] }, { "tag": "status", "values": [ "404", "200", "204" ] } ] }To see details for a specific endpoint:
{ "name": "http.server.requests", "baseUnit": "seconds", "measurements": [ { "statistic": "COUNT", "value": 3.0 }, { "statistic": "TOTAL_TIME", "value": 0.138951876 }, { "statistic": "MAX", "value": 0.05697992 } ], "availableTags": [ { "tag": "exception", "values": [ "none" ] }, { "tag": "method", "values": [ "PUT", "GET" ] }, { "tag": "error", "values": [ "none" ] }, { "tag": "outcome", "values": [ "SUCCESS" ] }, { "tag": "status", "values": [ "200" ] } ] }