Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added feature: UUID obfuscation in URI label with URI_METRICS_DETAILED enabled #123

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Added feature: UUID obfuscation in URI label with URI_METRICS_DETAILED enabled #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
eac21fd
Added feature: UUID obfuscation in URI label with URI_METRICS_DETAILE…
Dec 15, 2021
8ad187c
Fix variable name
comemaryvallee Dec 16, 2021
95514e3
Fix variable name
comemaryvallee Dec 16, 2021
6ef1e4d
Fix variable name
comemaryvallee Dec 16, 2021
c63ead7
Modified UUID obfuscation code to hide every occurence via regex
Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,25 @@ keycloak_request_duration_count{code="200",method="GET",resource="admin,admin/se
keycloak_request_duration_sum{code="200",method="GET",resource="admin,admin/serverinfo",uri="",} 19.0
```

To replace `users` or `clients` UUID values by a generic `{id}` with ```URI_METRICS_DETAILED``` enabled,
set ```URI_METRICS_UUID_HIDDEN``` to `true`

```c
# HELP keycloak_request_duration Request duration
# TYPE keycloak_request_duration histogram
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="50.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="100.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="250.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="500.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="1000.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="2000.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="10000.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="30000.0",} 6.0
keycloak_request_duration_bucket{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",le="+Inf",} 6.0
keycloak_request_duration_count{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",} 6.0
keycloak_request_duration_sum{code="200",method="GET",resource="admin,admin/realms",uri="admin/realms/master/users/{id}",} 41.0
```

## External Access

To disable metrics being externally accessible to a cluster. Set the environment variable 'DISABLE_EXTERNAL_ACCESS'. Once set enable the header 'X-Forwarded-Host' on your proxy. This is enabled by default on HA Proxy on Openshift.
Expand Down
10 changes: 8 additions & 2 deletions src/main/java/org/jboss/aerogear/keycloak/metrics/ResourceExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ class ResourceExtractor {
private static final boolean URI_METRICS_ENABLED = Boolean.parseBoolean(System.getenv("URI_METRICS_ENABLED"));
private static final boolean URI_METRICS_DETAILED = Boolean.parseBoolean(System.getenv("URI_METRICS_DETAILED"));
private static final String URI_METRICS_FILTER = System.getenv("URI_METRICS_FILTER");
private static final boolean URI_METRICS_UUID_HIDDEN = Boolean.parseBoolean(System.getenv("URI_METRICS_UUID_HIDDEN"));

private ResourceExtractor() {
}
Expand Down Expand Up @@ -89,13 +90,18 @@ private static StringBuilder getURIDetailed(StringBuilder sb, List<String> match
String uri = matchedURIs.get(0);

if (URI_METRICS_DETAILED) {
sb.append(uri);
if (URI_METRICS_UUID_HIDDEN) {
uri = uri.replaceAll("\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}", "{id}");
sb.append(uri);
} else {
sb.append(uri);
}
} else {
String[] realm = uri.split("/");
if (realm.length != 1) {
if (uri.startsWith("admin/realms/")) {
uri = uri.replace(realm[2], "{realm}");
if (realm.length > 4 && realm[3].equals("clients")) {
if (realm.length > 4 && (realm[3].equals("clients") || realm[3].equals("users"))) {
uri = uri.replace(realm[4], "{id}");
}
}
Expand Down