update metrics naming standards

Author: lizk886

src/main/java/com/uid2/operator/Main.java

@@ -527,20 +527,20 @@ public DistributionStatisticConfig configure(Meter.Id id, DistributionStatisticC
         // retrieve image version (will unify when uid2-common is used)
         final String version = Optional.ofNullable(System.getenv("IMAGE_VERSION")).orElse("unknown");
         Gauge
-                .builder("app.status", () -> 1)
+                .builder("app_status", () -> 1)
                 .description("application version and status")
                 .tags("version", version)
                 .register(globalRegistry);
     }
 
     private void createVertxInstancesMetric() {
-        Gauge.builder("uid2.vertx_service_instances", () -> config.getInteger("service_instances"))
+        Gauge.builder("uid2_vertx_service_instances", () -> config.getInteger("service_instances"))
                 .description("gauge for number of vertx service instances requested")
                 .register(Metrics.globalRegistry);
     }
 
     private void createVertxEventLoopsMetric() {
-        Gauge.builder("uid2.vertx_event_loop_threads", () -> VertxOptions.DEFAULT_EVENT_LOOP_POOL_SIZE)
+        Gauge.builder("uid2_vertx_event_loop_threads", () -> VertxOptions.DEFAULT_EVENT_LOOP_POOL_SIZE)
                 .description("gauge for number of vertx event loop threads")
                 .register(Metrics.globalRegistry);
     }

src/main/java/com/uid2/operator/monitoring/StatsCollectorVerticle.java

@@ -54,16 +54,16 @@ public StatsCollectorVerticle(long jsonIntervalMS, int maxInvalidPaths, int maxV
         this.maxInvalidPaths = maxInvalidPaths;
 
         logCycleSkipperCounter = Counter
-                .builder("uid2.api_usage_log_cycle_skipped")
+                .builder("uid2_api_usage_log_cycle_skipped_total")
                 .description("counter for how many log cycles are skipped because the thread is still running")
                 .register(Metrics.globalRegistry);
 
         domainMissedCounter = Counter
-                .builder("uid2.api_usage_domain_missed")
+                .builder("uid2_api_usage_domain_missed_total")
                 .description("counter for how many domains are missed because the dictionary is full")
                 .register(Metrics.globalRegistry);
         queueFullCounter = Counter
-                .builder("uid2.api_usage_queue_full")
+                .builder("uid2_api_usage_queue_full_total")
                 .description("counter for how many usage messages are dropped because the queue is full")
                 .register(Metrics.globalRegistry);
 

src/main/java/com/uid2/operator/service/EncryptedTokenEncoder.java

@@ -270,7 +270,7 @@ public AdvertisingToken decodeAdvertisingTokenV3orV4(Buffer b, byte[] bytes, Tok
     }
 
     private void recordRefreshTokenVersionCount(String siteId, TokenVersion tokenVersion) {
-        Counter.builder("uid2_refresh_token_served_count")
+        Counter.builder("uid2_refresh_token_served_count_total")
                 .description(String.format("Counter for the amount of refresh token %s served", tokenVersion.toString().toLowerCase()))
                 .tags("site_id", String.valueOf(siteId))
                 .tags("refresh_token_version", tokenVersion.toString().toLowerCase())

src/main/java/com/uid2/operator/vertx/ClientVersionCapturingHandler.java

@@ -50,7 +50,7 @@ public void handle(RoutingContext rc) {
             CLIENT_VERSION_COUNTERS.computeIfAbsent(
                     new Tuple.Tuple2<>(apiContact, clientVersion),
                     tuple -> Counter
-                            .builder("uid2.client_sdk_versions")
+                            .builder("uid2_client_sdk_versions_total")
                             .description("counter for how many http requests are processed per each client sdk version")
                             .tags("site_id", "unknown", "api_contact", tuple.getItem1(), "client_version", tuple.getItem2(), "path", path)
                             .register(Metrics.globalRegistry)

src/main/java/com/uid2/operator/vertx/UIDOperatorVerticle.java

@@ -898,7 +898,7 @@ private void recordOperatorServedSdkUsage(RoutingContext rc, Integer siteId, Str
             CLIENT_VERSION_COUNTERS.computeIfAbsent(
                     new Tuple.Tuple2<>(Integer.toString(siteId), clientVersion),
                     tuple -> Counter
-                            .builder("uid2.client_sdk_versions")
+                            .builder("uid2_client_sdk_versions_total")
                             .description("counter for how many http requests are processed per each operator-served sdk version")
                             .tags("site_id", tuple.getItem1(), "api_contact", apiContact, "client_version", tuple.getItem2(), "path", path)
                             .register(Metrics.globalRegistry)
@@ -1807,26 +1807,26 @@ private void recordIdentityMapStats(RoutingContext rc, int inputCount, int inval
         String apiContact = getApiContact(rc);
 
         DistributionSummary ds = _identityMapMetricSummaries.computeIfAbsent(apiContact, k -> DistributionSummary
-                .builder("uid2.operator.identity.map.inputs")
+                .builder("uid2_operator_identity_map_inputs")
                 .description("number of emails or email hashes passed to identity map batch endpoint")
                 .tags("api_contact", apiContact)
                 .register(Metrics.globalRegistry));
         ds.record(inputCount);
 
         Tuple.Tuple2<Counter, Counter> ids = _identityMapUnmappedIdentifiers.computeIfAbsent(apiContact, k -> new Tuple.Tuple2<>(
-                Counter.builder("uid2.operator.identity.map.unmapped")
+                Counter.builder("uid2_operator_identity_map_unmapped_total")
                         .description("invalid identifiers")
                         .tags("api_contact", apiContact, "reason", "invalid")
                         .register(Metrics.globalRegistry),
-                Counter.builder("uid2.operator.identity.map.unmapped")
+                Counter.builder("uid2_operator_identity_map_unmapped_total")
                         .description("optout identifiers")
                         .tags("api_contact", apiContact, "reason", "optout")
                         .register(Metrics.globalRegistry)));
         if (invalidCount > 0) ids.getItem1().increment(invalidCount);
         if (optoutCount > 0) ids.getItem2().increment(optoutCount);
 
         Counter rs = _identityMapRequestWithUnmapped.computeIfAbsent(apiContact, k -> Counter
-                .builder("uid2.operator.identity.map.unmapped_requests")
+                .builder("uid2_operator_identity_map_unmapped_requests_total")
                 .description("number of requests with unmapped identifiers")
                 .tags("api_contact", apiContact)
                 .register(Metrics.globalRegistry));
@@ -1845,7 +1845,7 @@ private void recordIdentityMapStatsForServiceLinks(RoutingContext rc, String api
             final String serviceName = rc.get(SecureLinkValidatorService.SERVICE_NAME);
             final String metricKey = serviceName + serviceLinkName;
             DistributionSummary ds = _identityMapMetricSummaries.computeIfAbsent(metricKey,
-                    k -> DistributionSummary.builder("uid2.operator.identity.map.services.inputs")
+                    k -> DistributionSummary.builder("uid2_operator_identity_map_services_inputs")
                             .description("number of emails or phone numbers passed to identity map batch endpoint by services")
                             .tags(Arrays.asList(Tag.of("api_contact", apiContact),
                                     Tag.of("service_name", serviceName),
@@ -1855,14 +1855,14 @@ private void recordIdentityMapStatsForServiceLinks(RoutingContext rc, String api
 
             Tuple.Tuple2<Counter, Counter> counterTuple = _identityMapUnmappedIdentifiers.computeIfAbsent(metricKey,
                     k -> new Tuple.Tuple2<>(
-                            Counter.builder("uid2.operator.identity.map.services.unmapped")
+                            Counter.builder("uid2_operator_identity_map_services_unmapped_total")
                                     .description("number of invalid identifiers passed to identity map batch endpoint by services")
                                     .tags(Arrays.asList(Tag.of("api_contact", apiContact),
                                             Tag.of("reason", "invalid"),
                                             Tag.of("service_name", serviceName),
                                             Tag.of("service_link_name", serviceLinkName)))
                                     .register(Metrics.globalRegistry),
-                            Counter.builder("uid2.operator.identity.map.services.unmapped")
+                            Counter.builder("uid2_operator_identity_map_services_unmapped_total")
                                     .description("number of optout identifiers passed to identity map batch endpoint by services")
                                     .tags(Arrays.asList(Tag.of("api_contact", apiContact),
                                             Tag.of("reason", "optout"),
@@ -1928,14 +1928,14 @@ private void handleOptoutStatus(RoutingContext rc) {
     private void recordOptOutStatusEndpointStats(RoutingContext rc, int inputCount, int optOutCount) {
         String apiContact = getApiContact(rc);
         DistributionSummary inputDistSummary = optOutStatusCounters.computeIfAbsent(apiContact, k -> DistributionSummary
-                .builder("uid2.operator.optout.status.input_size")
+                .builder("uid2_operator_optout_status_input_size")
                 .description("number of UIDs received in request")
                 .tags("api_contact", apiContact)
                 .register(Metrics.globalRegistry));
         inputDistSummary.record(inputCount);
 
         DistributionSummary optOutDistSummary = optOutStatusCounters.computeIfAbsent(apiContact, k -> DistributionSummary
-                .builder("uid2.operator.optout.status.optout_size")
+                .builder("uid2.operator.optout.status.optout_size") //#debug: I cannot find this metrics in grafana
                 .description("number of UIDs that have opted out")
                 .tags("api_contact", apiContact)
                 .register(Metrics.globalRegistry));
@@ -1956,7 +1956,7 @@ public TokenVersion getRefreshTokenVersion(String s) {
     }
 
     private void recordRefreshTokenVersionCount(String siteId, TokenVersion tokenVersion) {
-        Counter.builder("uid2_refresh_token_received_count")
+        Counter.builder("uid2_refresh_token_received_count_total")
                 .description(String.format("Counter for the amount of refresh token %s received", tokenVersion.toString().toLowerCase()))
                 .tags("site_id", siteId)
                 .tags("refresh_token_version", tokenVersion.toString().toLowerCase())
@@ -2017,7 +2017,7 @@ private TokenResponseStatsCollector.PlatformType getPlatformType(RoutingContext
     private void recordRefreshDurationStats(Integer siteId, String apiContact, Duration durationSinceLastRefresh, boolean hasOriginHeader, Duration identityExpiresAfter) {
         DistributionSummary ds = _refreshDurationMetricSummaries.computeIfAbsent(new Tuple.Tuple2<>(apiContact, hasOriginHeader), k ->
                 DistributionSummary
-                        .builder("uid2.token_refresh_duration_seconds")
+                        .builder("uid2_token_refresh_duration_seconds")
                         .description("duration between token refreshes")
                         .tag("site_id", String.valueOf(siteId))
                         .tag("site_name", getSiteName(siteProvider, siteId))
@@ -2030,7 +2030,7 @@ private void recordRefreshDurationStats(Integer siteId, String apiContact, Durat
         boolean isExpired = durationSinceLastRefresh.compareTo(identityExpiresAfter) > 0;
         Counter c = _advertisingTokenExpiryStatus.computeIfAbsent(new Tuple.Tuple3<>(String.valueOf(siteId), hasOriginHeader, isExpired), k ->
                 Counter
-                        .builder("uid2.advertising_token_expired_on_refresh")
+                        .builder("uid2_advertising_token_expired_on_refresh_total")
                         .description("status of advertiser token expiry")
                         .tag("site_id", String.valueOf(siteId))
                         .tag("site_name", getSiteName(siteProvider, siteId))
@@ -2163,15 +2163,15 @@ private Tuple.Tuple2<OptoutCheckPolicy, String> readOptoutCheckPolicy(JsonObject
 
     private void recordTokenGeneratePolicy(String apiContact, OptoutCheckPolicy policy, String policyParameterKey) {
         _tokenGeneratePolicyCounters.computeIfAbsent(new Tuple.Tuple3<>(apiContact, policy, policyParameterKey), triple -> Counter
-                .builder("uid2.token_generate_policy_usage")
+                .builder("uid2_token_generate_policy_usage_total")
                 .description("Counter for token generate policy usage")
                 .tags("api_contact", triple.getItem1(), "policy", String.valueOf(triple.getItem2()), "policy_parameter", triple.getItem3())
                 .register(Metrics.globalRegistry)).increment();
     }
 
     private void recordTokenGenerateTCFUsage(String apiContact) {
         _tokenGenerateTCFUsage.computeIfAbsent(apiContact, contact -> Counter
-                .builder("uid2.token_generate_tcf_usage")
+                .builder("uid2.token_generate_tcf_usage") //debug: cannot search in grafana
                 .description("Counter for token generate tcf usage")
                 .tags("api_contact", contact)
                 .register(Metrics.globalRegistry)).increment();