Renaming the CLI options

Signed-off-by: Alexander Schwartz <[email protected]>
bohmber · Oct 28, 2024 · 6603968 · 6603968
1 parent be45f82
commit 6603968
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 55 deletions.
diff --git a/docs/guides/server/event-metrics.adoc b/docs/guides/server/event-metrics.adoc
@@ -7,7 +7,7 @@
 title="Enabling {project_name} Event Metrics"
 summary="Learn how to enable and use {project_name} Event Metrics"
 preview="true"
-includedOptions="metrics-enabled events-metrics-user-*">
+includedOptions="metrics-enabled event-metrics-user-*">
 
 Event metrics can provide admins an overview of the different activities in a {project_name} instance.
 For now, only metrics for user events are captured.
@@ -25,22 +25,22 @@ To start collecting metrics, enable the feature `user-event-metrics`, enable met
 
 The following shows the required startup parameters:
 
-<@kc.start parameters="--features=user-event-metrics --metrics-enabled=true --events-metrics-user-enabled=true ..."/>
+<@kc.start parameters="--features=user-event-metrics --metrics-enabled=true --event-metrics-user-enabled=true ..."/>
 
 By default, there is a separate metric for each realm.
-To break down the metric by client and identity provider, you can add those metrics dimension using the configuration option `events-metrics-user-tags`.
+To break down the metric by client and identity provider, you can add those metrics dimension using the configuration option `event-metrics-user-tags`.
 This can be useful on installations with a small number of clients and IDPs.
 This is not recommended for installations with a large number of clients or IDPs as it will increase the memory usage of {project_name} and as it will increase the load on your monitoring system.
 
 The following shows how to configure {project_name} to break down the metrics by all three metrics dimensions:
 
-<@kc.start parameters="... --events-metrics-user-tags=realm,idp,clientId ..."/>
+<@kc.start parameters="... --event-metrics-user-tags=realm,idp,clientId ..."/>
 
 You can limit the events for which {project_name} will expose metrics.
 
 The following example limits the events collected to `LOGIN` and `LOGOUT` events:
 
-<@kc.start parameters="... --events-metrics-user-events=login,logout ..."/>
+<@kc.start parameters="... --event-metrics-user-events=login,logout ..."/>
 
 All error events will be collected with the primary event type and will have the `error` tag filled with the error code.
 

diff --git a/quarkus/config-api/src/main/java/org/keycloak/config/EventOptions.java b/quarkus/config-api/src/main/java/org/keycloak/config/EventOptions.java
@@ -4,24 +4,24 @@
 
 public class EventOptions {
 
-    public static final Option<Boolean> USER_EVENT_METRICS_ENABLED = new OptionBuilder<>("events-metrics-user-metrics-enabled", Boolean.class)
+    public static final Option<Boolean> USER_EVENT_METRICS_ENABLED = new OptionBuilder<>("event-metrics-user-enabled", Boolean.class)
             .category(OptionCategory.EVENTS)
             .description("Create metrics based on user events.")
             .buildTime(true)
             .defaultValue(Boolean.FALSE)
             .build();
 
-    public static final Option<List<String>> USER_EVENT_METRICS_TAGS = OptionBuilder.listOptionBuilder("events-metrics-user-metrics-tags", String.class)
+    public static final Option<List<String>> USER_EVENT_METRICS_TAGS = OptionBuilder.listOptionBuilder("event-metrics-user-tags", String.class)
             .category(OptionCategory.EVENTS)
-            .description("Comma-separated list of tags to be collected for event metrics. By default only 'realm' is enabled to avoid a high metrics cardinality.")
+            .description("Comma-separated list of tags to be collected for user event metrics. By default only 'realm' is enabled to avoid a high metrics cardinality.")
             .buildTime(false)
             .expectedValues(List.of("realm", "idp", "clientId"))
             .defaultValue(List.of("realm"))
             .build();
 
-    public static final Option<List<String>> USER_EVENT_METRICS_EVENTS = OptionBuilder.listOptionBuilder("events-metrics-user-metrics-events", String.class)
+    public static final Option<List<String>> USER_EVENT_METRICS_EVENTS = OptionBuilder.listOptionBuilder("event-metrics-user-events", String.class)
             .category(OptionCategory.EVENTS)
-            .description("Comma-separated list of events to be collected for event metrics. Reduce the number of metrics. If empty or not set, all events create a metric.")
+            .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.")
             .buildTime(false)
             .build();
 

diff --git a/quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/MetricsDistTest.java b/quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/MetricsDistTest.java
@@ -82,7 +82,7 @@ void testMetricsEndpointWithCacheMetricsHistograms() {
     }
 
     @Test
-    @Launch({ "start-dev", "--metrics-enabled=true", "--features=user-event-metrics", "--events-metrics-user-enabled=true" })
+    @Launch({ "start-dev", "--metrics-enabled=true", "--features=user-event-metrics", "--event-metrics-user-enabled=true" })
     void testMetricsEndpointWithUserEventMetrics(KeycloakDistribution distribution) {
         runClientCredentialGrantWithUnknownClientId(distribution);
 
@@ -94,7 +94,7 @@ void testMetricsEndpointWithUserEventMetrics(KeycloakDistribution distribution)
     }
 
     @Test
-    @Launch({ "start-dev", "--metrics-enabled=true", "--features=user-event-metrics", "--events-metrics-user-enabled=false" })
+    @Launch({ "start-dev", "--metrics-enabled=true", "--features=user-event-metrics", "--event-metrics-user-enabled=false" })
     void testMetricsEndpointWithoutUserEventMetrics(KeycloakDistribution distribution) {
         runClientCredentialGrantWithUnknownClientId(distribution);
 

diff --git a/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt b/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt
@@ -243,16 +243,16 @@ Tracing (Preview):
 
 Events (Preview):
 
---events-metrics-user-metrics-enabled <true|false>
+--event-metrics-user-enabled <true|false>
                      Preview: Create metrics based on user events. Default: false. Available only
                        when metrics are enabled and feature user-event-metrics is enabled.
---events-metrics-user-metrics-events <events>
-                     Preview: Comma-separated list of events to be collected for event metrics.
-                       Reduce the number of metrics. If empty or not set, all events create a
-                       metric. Available only when user event metrics are enabled.
---events-metrics-user-metrics-tags <tags>
-                     Preview: Comma-separated list of tags to be collected for event metrics. By
-                       default only 'realm' is enabled to avoid a high metrics cardinality.
+--event-metrics-user-events <events>
+                     Preview: 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. Available only when user event metrics are enabled.
+--event-metrics-user-tags <tags>
+                     Preview: Comma-separated list of tags to be collected for user event metrics.
+                       By default only 'realm' is enabled to avoid a high metrics cardinality.
                        Possible values are: realm, idp, clientId. Default: realm. Available only
                        when user event metrics are enabled.
 

diff --git a/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt b/...eycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt
@@ -243,16 +243,16 @@ Tracing (Preview):
 
 Events (Preview):
 
---events-metrics-user-metrics-enabled <true|false>
+--event-metrics-user-enabled <true|false>
                      Preview: Create metrics based on user events. Default: false. Available only
                        when metrics are enabled and feature user-event-metrics is enabled.
---events-metrics-user-metrics-events <events>
-                     Preview: Comma-separated list of events to be collected for event metrics.
-                       Reduce the number of metrics. If empty or not set, all events create a
-                       metric. Available only when user event metrics are enabled.
---events-metrics-user-metrics-tags <tags>
-                     Preview: Comma-separated list of tags to be collected for event metrics. By
-                       default only 'realm' is enabled to avoid a high metrics cardinality.
+--event-metrics-user-events <events>
+                     Preview: 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. Available only when user event metrics are enabled.
+--event-metrics-user-tags <tags>
+                     Preview: Comma-separated list of tags to be collected for user event metrics.
+                       By default only 'realm' is enabled to avoid a high metrics cardinality.
                        Possible values are: realm, idp, clientId. Default: realm. Available only
                        when user event metrics are enabled.
 

diff --git a/...cloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt b/...cloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt
@@ -449,16 +449,16 @@ Tracing (Preview):
 
 Events (Preview):
 
---events-metrics-user-metrics-enabled <true|false>
+--event-metrics-user-enabled <true|false>
                      Preview: Create metrics based on user events. Default: false. Available only
                        when metrics are enabled and feature user-event-metrics is enabled.
---events-metrics-user-metrics-events <events>
-                     Preview: Comma-separated list of events to be collected for event metrics.
-                       Reduce the number of metrics. If empty or not set, all events create a
-                       metric. Available only when user event metrics are enabled.
---events-metrics-user-metrics-tags <tags>
-                     Preview: Comma-separated list of tags to be collected for event metrics. By
-                       default only 'realm' is enabled to avoid a high metrics cardinality.
+--event-metrics-user-events <events>
+                     Preview: 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. Available only when user event metrics are enabled.
+--event-metrics-user-tags <tags>
+                     Preview: Comma-separated list of tags to be collected for user event metrics.
+                       By default only 'realm' is enabled to avoid a high metrics cardinality.
                        Possible values are: realm, idp, clientId. Default: realm. Available only
                        when user event metrics are enabled.
 

diff --git a/...keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt b/...keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt
@@ -450,16 +450,16 @@ Tracing (Preview):
 
 Events (Preview):
 
---events-metrics-user-metrics-enabled <true|false>
+--event-metrics-user-enabled <true|false>
                      Preview: Create metrics based on user events. Default: false. Available only
                        when metrics are enabled and feature user-event-metrics is enabled.
---events-metrics-user-metrics-events <events>
-                     Preview: Comma-separated list of events to be collected for event metrics.
-                       Reduce the number of metrics. If empty or not set, all events create a
-                       metric. Available only when user event metrics are enabled.
---events-metrics-user-metrics-tags <tags>
-                     Preview: Comma-separated list of tags to be collected for event metrics. By
-                       default only 'realm' is enabled to avoid a high metrics cardinality.
+--event-metrics-user-events <events>
+                     Preview: 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. Available only when user event metrics are enabled.
+--event-metrics-user-tags <tags>
+                     Preview: Comma-separated list of tags to be collected for user event metrics.
+                       By default only 'realm' is enabled to avoid a high metrics cardinality.
                        Possible values are: realm, idp, clientId. Default: realm. Available only
                        when user event metrics are enabled.
 

diff --git a/...it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt b/...it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt
@@ -390,13 +390,13 @@ Tracing (Preview):
 
 Events (Preview):
 
---events-metrics-user-metrics-events <events>
-                     Preview: Comma-separated list of events to be collected for event metrics.
-                       Reduce the number of metrics. If empty or not set, all events create a
-                       metric. Available only when user event metrics are enabled.
---events-metrics-user-metrics-tags <tags>
-                     Preview: Comma-separated list of tags to be collected for event metrics. By
-                       default only 'realm' is enabled to avoid a high metrics cardinality.
+--event-metrics-user-events <events>
+                     Preview: 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. Available only when user event metrics are enabled.
+--event-metrics-user-tags <tags>
+                     Preview: Comma-separated list of tags to be collected for user event metrics.
+                       By default only 'realm' is enabled to avoid a high metrics cardinality.
                        Possible values are: realm, idp, clientId. Default: realm. Available only
                        when user event metrics are enabled.
 

diff --git a/...lian/tests/base/src/test/java/org/keycloak/testsuite/events/EventMetricsProviderTest.java b/...lian/tests/base/src/test/java/org/keycloak/testsuite/events/EventMetricsProviderTest.java
@@ -60,19 +60,19 @@ private void enableEventMetricsOptions(String tags, String events) {
             List<String> args = new ArrayList<>();
             args.add("--features=user-event-metrics");
             args.add("--metrics-enabled=true");
-            args.add("--events-metrics-user-metrics-enabled=true");
+            args.add("--event-metrics-user-enabled=true");
             if (tags != null) {
-                args.add("--events-metrics-user-metrics-tags=" + tags);
+                args.add("--event-metrics-user-tags=" + tags);
             }
             if (events != null) {
-                args.add("--events-metrics-user-metrics-events=" + events);
+                args.add("--event-metrics-user-events=" + events);
             }
             container.setAdditionalBuildArgs(args);
         }
         else {
             setConfigProperty("keycloak.features", "user-event-metrics");
             setConfigProperty("keycloak.metrics-enabled", "true");
-            setConfigProperty("keycloak.events-metrics-user-metrics-enabled", "true");
+            setConfigProperty("keycloak.event-metrics-user-enabled", "true");
         }
     }