MGDSTRM-3724 Add the status code to the keycloak_request_duration_bucket metric

[CathalOConnorRH]

Motivation

https://issues.redhat.com/browse/MGDSTRM-3724 https://issues.redhat.com/browse/MGDSTRM-4318

What

Add status code and uri to the keycloak_request_duration_bucket metric

Why

This will allow filtering on specific statuses Currently no status are returned in the metric keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="50.0",} 0.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="100.0",} 0.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="250.0",} 0.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="500.0",} 0.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="1000.0",} 1.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="2000.0",} 1.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="10000.0",} 1.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="30000.0",} 1.0 keycloak_request_duration_bucket{method="POST",resource="realms,realms/master/protocol/openid-connect",le="+Inf",} 1.0 keycloak_request_duration_count{method="POST",resource="realms,realms/master/protocol/openid-connect",} 1.0 keycloak_request_duration_sum{method="POST",resource="realms,realms/master/protocol/openid-connect",} 625.0

How

added status code and uri to the to the bucket output.

Verification Steps

Option 1

1. Build the code
2. Copy the artifact into $KC/standalone/deployments
3. Make sure the metrics logger is turned on
4. Play with Keycloak a bit
5. Look at the following url: "$KC/auth/realms/master/metrics"

Option 2

update keycloak cr to use the jar built and released from my fork https://github.com/CathalOConnorRH/keycloak-metrics-spi/releases/tag/v2.4.1-beta

Metrics should look similar to keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="50.0",} 0.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="100.0",} 0.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="250.0",} 1.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="500.0",} 1.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="1000.0",} 1.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="2000.0",} 1.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="10000.0",} 1.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="30000.0",} 1.0 keycloak_request_duration_bucket{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",le="+Inf",} 1.0 keycloak_request_duration_count{code="200",method="POST",resource="realms,realms/master/protocol/openid-connect",uri="realms/master/protocol/openid-connect/token",} 1.0

Checklist:

• [x] Code has been tested locally by PR requester
• [ ] Changes have been successfully verified by another team member

Progress

• [x] Finished task
• [ ] TODO

Additional Notes

PS.: Add images and/or .gifs to illustrate what was changed if this pull request modifies the appearance/output of something presented to the users.

[Rajagopalan-Ranganathan]

/lgtm

[akoserwal]

@pb82 Would like to take a look as well?

[akoserwal]

LGTM

[pb82]

@CathalOConnorRH if it is absolutely required to add those labels to the histogram, can we make that opt-in behind a flag?

[CathalOConnorRH]

@pb82 I've updated the ResourceExtractor to include a URI_METRICS_ENABLED boolean and a check for /token URI. an example of the metrics output is attached

Let me know what you think

KeycloakMetrics.txt

[CathalOConnorRH]

Hey @pb82 Have you had any thoughts on the above changes ?

[pb82]

thanks @CathalOConnorRH I'll give it a final try and then merge

[Rajagopalan-Ranganathan]

@pb82 did you find time to try it out? Just curious about the status. Thanks!

[CathalOConnorRH]

@pb82 I've implemented the detailed output and removed the uri when it's not enabled. Some sample output of each of the three scenarios are attached. Let me know what you think
URIEnabledURIDetailed.txt URIDisabled.txt URIEnabled.txt

[Rajagopalan-Ranganathan]

@pb82 We need this change in MAS SSO soon, to build some metrics - dashboards and also to investigate and get precise information regarding our load (which end points are used most). Can you take a look and close this at the earliest?