Skip to content

Commit 8cd97dd

Browse files
mhajasmhajas
authored
Make event metrics supported (#37391)
* Make event metrics supported Closes #37389 Signed-off-by: Michal Hajas <[email protected]> * Address comments from reviews Signed-off-by: Michal Hajas <[email protected]> --------- Signed-off-by: Michal Hajas <[email protected]>
1 parent 4c172d9 commit 8cd97dd

File tree

12 files changed

+60
-61
lines changed

12 files changed

+60
-61
lines changed

‎common/src/main/java/org/keycloak/common/Profile.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public enum Feature {
129129

130130
CACHE_EMBEDDED_REMOTE_STORE("Support for remote-store in embedded Infinispan caches", Type.EXPERIMENTAL),
131131

132-
USER_EVENT_METRICS("Collect metrics based on user events", Type.PREVIEW),
132+
USER_EVENT_METRICS("Collect metrics based on user events", Type.DEFAULT),
133133

134134
IPA_TUURA_FEDERATION("IPA-Tuura user federation provider", Type.EXPERIMENTAL),
135135

‎docs/guides/observability/event-metrics.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
<@tmpl.guide
77
title="Enabling {project_name} Event Metrics"
88
summary="Learn how to enable and use {project_name} Event Metrics"
9-
preview="true"
109
includedOptions="metrics-enabled event-metrics-user-*">
1110
1211
Event metrics can provide admins an overview of the different activities in a {project_name} instance.
@@ -21,11 +20,11 @@ If you have multiple instances running in a cluster, you will need to collect th
2120
2221
== Enable event metrics
2322
24-
To start collecting metrics, enable the feature `user-event-metrics`, enable metrics, and enable the metrics for user events.
23+
To start collecting event metrics, enable metrics and enable the metrics for user events.
2524
2625
The following shows the required startup parameters:
2726
28-
<@kc.start parameters="--features=user-event-metrics --metrics-enabled=true --event-metrics-user-enabled=true ..."/>
27+
<@kc.start parameters="--metrics-enabled=true --event-metrics-user-enabled=true ..."/>
2928
3029
By default, there is a separate metric for each realm.
3130
To break down the metric by client and identity provider, you can add those metrics dimension using the configuration option `event-metrics-user-tags`.

‎quarkus/config-api/src/main/java/org/keycloak/config/EventOptions.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class EventOptions {
2121

2222
public static final Option<List<String>> USER_EVENT_METRICS_EVENTS = OptionBuilder.listOptionBuilder("event-metrics-user-events", String.class)
2323
.category(OptionCategory.EVENTS)
24-
.description("Comma-separated list of events to be collected for user event metrics. Reduce the number of metrics. If empty or not set, all events create a metric.")
24+
.description("Comma-separated list of events to be collected for user event metrics. This option can be used to reduce the number of metrics created as by default all user events create a metric.")
2525
.buildTime(false)
2626
.expectedValues(sortedListOfEvents())
2727
.deprecatedMetadata(DeprecatedMetadata.deprecateValues("Use `remove_credential` instead of `remove_totp`, and `update_credential` instead of `update_totp` and `update_password`.", "remove_totp", "update_totp", "update_password"))

‎quarkus/config-api/src/main/java/org/keycloak/config/OptionCategory.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public enum OptionCategory {
1616
VAULT("Vault", 100, ConfigSupportLevel.SUPPORTED),
1717
LOGGING("Logging", 110, ConfigSupportLevel.SUPPORTED),
1818
TRACING("Tracing", 111, ConfigSupportLevel.SUPPORTED),
19-
EVENTS("Events", 112, ConfigSupportLevel.PREVIEW),
19+
EVENTS("Events", 112, ConfigSupportLevel.SUPPORTED),
2020
TRUSTSTORE("Truststore", 115, ConfigSupportLevel.SUPPORTED),
2121
SECURITY("Security", 120, ConfigSupportLevel.SUPPORTED),
2222
EXPORT("Export", 130, ConfigSupportLevel.SUPPORTED),

‎quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/HelpCommandDistTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ private void assertHelp(CLIResult cliResult) {
190190
// normalize the output to prevent changes around the feature toggles or events to mark the output to differ
191191
String output = cliResult.getOutput()
192192
.replaceAll("((Disables|Enables) a set of one or more features. Possible values are: )[^.]{30,}", "$1<...>")
193-
.replaceAll("(create a metric. Possible values are:)[^.]{30,}.(Available|only|when|user|event|metrics|are|enabled.| )*", "$1<...>");
193+
.replaceAll("(create a metric.\\s+Possible values are:)[^.]{30,}.(Available|only|when|user|event|metrics|are|enabled.| )*", "$1<...>");
194194

195195
String osName = System.getProperty("os.name");
196196
if(osName.toLowerCase(Locale.ROOT).contains("windows")) {

‎quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -266,18 +266,18 @@ Tracing:
266266
the 'tracing-resource-attributes' property. Default: keycloak. Available
267267
only when Tracing is enabled.
268268

269-
Events (Preview):
269+
Events:
270270

271271
--event-metrics-user-enabled <true|false>
272-
Preview: Create metrics based on user events. Default: false. Available only
273-
when metrics are enabled and feature user-event-metrics is enabled.
272+
Create metrics based on user events. Default: false. Available only when
273+
metrics are enabled and feature user-event-metrics is enabled.
274274
--event-metrics-user-events <events>
275-
Preview: Comma-separated list of events to be collected for user event
276-
metrics. Reduce the number of metrics. If empty or not set, all events
277-
create a metric. Possible values are:<...>
275+
Comma-separated list of events to be collected for user event metrics. This
276+
option can be used to reduce the number of metrics created as by default all
277+
user events create a metric. Possible values are:<...>
278278
--event-metrics-user-tags <tags>
279-
Preview: Comma-separated list of tags to be collected for user event metrics.
280-
By default only 'realm' is enabled to avoid a high metrics cardinality.
279+
Comma-separated list of tags to be collected for user event metrics. By
280+
default only 'realm' is enabled to avoid a high metrics cardinality.
281281
Possible values are: realm, idp, clientId. Default: realm. Available only
282282
when user event metrics are enabled.
283283

‎quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -266,18 +266,18 @@ Tracing:
266266
the 'tracing-resource-attributes' property. Default: keycloak. Available
267267
only when Tracing is enabled.
268268

269-
Events (Preview):
269+
Events:
270270

271271
--event-metrics-user-enabled <true|false>
272-
Preview: Create metrics based on user events. Default: false. Available only
273-
when metrics are enabled and feature user-event-metrics is enabled.
272+
Create metrics based on user events. Default: false. Available only when
273+
metrics are enabled and feature user-event-metrics is enabled.
274274
--event-metrics-user-events <events>
275-
Preview: Comma-separated list of events to be collected for user event
276-
metrics. Reduce the number of metrics. If empty or not set, all events
277-
create a metric. Possible values are:<...>
275+
Comma-separated list of events to be collected for user event metrics. This
276+
option can be used to reduce the number of metrics created as by default all
277+
user events create a metric. Possible values are:<...>
278278
--event-metrics-user-tags <tags>
279-
Preview: Comma-separated list of tags to be collected for user event metrics.
280-
By default only 'realm' is enabled to avoid a high metrics cardinality.
279+
Comma-separated list of tags to be collected for user event metrics. By
280+
default only 'realm' is enabled to avoid a high metrics cardinality.
281281
Possible values are: realm, idp, clientId. Default: realm. Available only
282282
when user event metrics are enabled.
283283

‎quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -473,18 +473,18 @@ Tracing:
473473
the 'tracing-resource-attributes' property. Default: keycloak. Available
474474
only when Tracing is enabled.
475475

476-
Events (Preview):
476+
Events:
477477

478478
--event-metrics-user-enabled <true|false>
479-
Preview: Create metrics based on user events. Default: false. Available only
480-
when metrics are enabled and feature user-event-metrics is enabled.
479+
Create metrics based on user events. Default: false. Available only when
480+
metrics are enabled and feature user-event-metrics is enabled.
481481
--event-metrics-user-events <events>
482-
Preview: Comma-separated list of events to be collected for user event
483-
metrics. Reduce the number of metrics. If empty or not set, all events
484-
create a metric. Possible values are:<...>
482+
Comma-separated list of events to be collected for user event metrics. This
483+
option can be used to reduce the number of metrics created as by default all
484+
user events create a metric. Possible values are:<...>
485485
--event-metrics-user-tags <tags>
486-
Preview: Comma-separated list of tags to be collected for user event metrics.
487-
By default only 'realm' is enabled to avoid a high metrics cardinality.
486+
Comma-separated list of tags to be collected for user event metrics. By
487+
default only 'realm' is enabled to avoid a high metrics cardinality.
488488
Possible values are: realm, idp, clientId. Default: realm. Available only
489489
when user event metrics are enabled.
490490

‎quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -474,18 +474,18 @@ Tracing:
474474
the 'tracing-resource-attributes' property. Default: keycloak. Available
475475
only when Tracing is enabled.
476476

477-
Events (Preview):
477+
Events:
478478

479479
--event-metrics-user-enabled <true|false>
480-
Preview: Create metrics based on user events. Default: false. Available only
481-
when metrics are enabled and feature user-event-metrics is enabled.
480+
Create metrics based on user events. Default: false. Available only when
481+
metrics are enabled and feature user-event-metrics is enabled.
482482
--event-metrics-user-events <events>
483-
Preview: Comma-separated list of events to be collected for user event
484-
metrics. Reduce the number of metrics. If empty or not set, all events
485-
create a metric. Possible values are:<...>
483+
Comma-separated list of events to be collected for user event metrics. This
484+
option can be used to reduce the number of metrics created as by default all
485+
user events create a metric. Possible values are:<...>
486486
--event-metrics-user-tags <tags>
487-
Preview: Comma-separated list of tags to be collected for user event metrics.
488-
By default only 'realm' is enabled to avoid a high metrics cardinality.
487+
Comma-separated list of tags to be collected for user event metrics. By
488+
default only 'realm' is enabled to avoid a high metrics cardinality.
489489
Possible values are: realm, idp, clientId. Default: realm. Available only
490490
when user event metrics are enabled.
491491

‎quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -412,15 +412,15 @@ Tracing:
412412
the 'tracing-resource-attributes' property. Default: keycloak. Available
413413
only when Tracing is enabled.
414414

415-
Events (Preview):
415+
Events:
416416

417417
--event-metrics-user-events <events>
418-
Preview: Comma-separated list of events to be collected for user event
419-
metrics. Reduce the number of metrics. If empty or not set, all events
420-
create a metric. Possible values are:<...>
418+
Comma-separated list of events to be collected for user event metrics. This
419+
option can be used to reduce the number of metrics created as by default all
420+
user events create a metric. Possible values are:<...>
421421
--event-metrics-user-tags <tags>
422-
Preview: Comma-separated list of tags to be collected for user event metrics.
423-
By default only 'realm' is enabled to avoid a high metrics cardinality.
422+
Comma-separated list of tags to be collected for user event metrics. By
423+
default only 'realm' is enabled to avoid a high metrics cardinality.
424424
Possible values are: realm, idp, clientId. Default: realm. Available only
425425
when user event metrics are enabled.
426426

0 commit comments

Comments
 (0)