Skip to content

Commit 9b2d512

Browse files
lizk886lizk886
authored
Merge pull request #1834 from IABTechLab/wzh-UID2-5498-update-metrics-name-standard
Wzh UI d2 5498 update metrics name standard
2 parents 8a21798 + bd727c3 commit 9b2d512

File tree

9 files changed

+31
-31
lines changed

9 files changed

+31
-31
lines changed

‎pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<groupId>com.uid2</groupId>
88
<artifactId>uid2-operator</artifactId>
99
<version>5.55.26</version>
10-
10+
1111
<properties>
1212
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
1313
<vertx.version>4.5.13</vertx.version>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -527,20 +527,20 @@ public DistributionStatisticConfig configure(Meter.Id id, DistributionStatisticC
527527
// retrieve image version (will unify when uid2-common is used)
528528
final String version = Optional.ofNullable(System.getenv("IMAGE_VERSION")).orElse("unknown");
529529
Gauge
530-
.builder("app.status", () -> 1)
530+
.builder("app_status", () -> 1)
531531
.description("application version and status")
532532
.tags("version", version)
533533
.register(globalRegistry);
534534
}
535535

536536
private void createVertxInstancesMetric() {
537-
Gauge.builder("uid2.vertx_service_instances", () -> config.getInteger("service_instances"))
537+
Gauge.builder("uid2_vertx_service_instances", () -> config.getInteger("service_instances"))
538538
.description("gauge for number of vertx service instances requested")
539539
.register(Metrics.globalRegistry);
540540
}
541541

542542
private void createVertxEventLoopsMetric() {
543-
Gauge.builder("uid2.vertx_event_loop_threads", () -> VertxOptions.DEFAULT_EVENT_LOOP_POOL_SIZE)
543+
Gauge.builder("uid2_vertx_event_loop_threads", () -> VertxOptions.DEFAULT_EVENT_LOOP_POOL_SIZE)
544544
.description("gauge for number of vertx event loop threads")
545545
.register(Metrics.globalRegistry);
546546
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,16 @@ public StatsCollectorVerticle(long jsonIntervalMS, int maxInvalidPaths, int maxV
5454
this.maxInvalidPaths = maxInvalidPaths;
5555

5656
logCycleSkipperCounter = Counter
57-
.builder("uid2.api_usage_log_cycle_skipped")
57+
.builder("uid2_api_usage_log_cycle_skipped_total")
5858
.description("counter for how many log cycles are skipped because the thread is still running")
5959
.register(Metrics.globalRegistry);
6060

6161
domainMissedCounter = Counter
62-
.builder("uid2.api_usage_domain_missed")
62+
.builder("uid2_api_usage_domain_missed_total")
6363
.description("counter for how many domains are missed because the dictionary is full")
6464
.register(Metrics.globalRegistry);
6565
queueFullCounter = Counter
66-
.builder("uid2.api_usage_queue_full")
66+
.builder("uid2_api_usage_queue_full_total")
6767
.description("counter for how many usage messages are dropped because the queue is full")
6868
.register(Metrics.globalRegistry);
6969

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ public AdvertisingToken decodeAdvertisingTokenV3orV4(Buffer b, byte[] bytes, Tok
270270
}
271271

272272
private void recordRefreshTokenVersionCount(String siteId, TokenVersion tokenVersion) {
273-
Counter.builder("uid2_refresh_token_served_count")
273+
Counter.builder("uid2_refresh_token_served_count_total")
274274
.description(String.format("Counter for the amount of refresh token %s served", tokenVersion.toString().toLowerCase()))
275275
.tags("site_id", String.valueOf(siteId))
276276
.tags("refresh_token_version", tokenVersion.toString().toLowerCase())

‎src/main/java/com/uid2/operator/store/CloudSyncOptOutStore.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ public Collection<byte[]> getLoadedPartitions() {
306306
public static class OptOutStoreSnapshot {
307307
private static final Logger LOGGER = LoggerFactory.getLogger(OptOutStoreSnapshot.class);
308308

309-
private static final String METRIC_NAME_PREFIX = "uid2.optout.";
309+
private static final String METRIC_NAME_PREFIX = "uid2_optout_";
310310

311311
// Metrics for processing deltas and partitions.
312312
private static final String OPT_OUT_PROCESSING_METRIC_NAME = METRIC_NAME_PREFIX + "processing";

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public void handle(RoutingContext rc) {
5050
CLIENT_VERSION_COUNTERS.computeIfAbsent(
5151
new Tuple.Tuple2<>(apiContact, clientVersion),
5252
tuple -> Counter
53-
.builder("uid2.client_sdk_versions")
53+
.builder("uid2_client_sdk_versions_total")
5454
.description("counter for how many http requests are processed per each client sdk version")
5555
.tags("site_id", "unknown", "api_contact", tuple.getItem1(), "client_version", tuple.getItem2(), "path", path)
5656
.register(Metrics.globalRegistry)

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -898,7 +898,7 @@ private void recordOperatorServedSdkUsage(RoutingContext rc, Integer siteId, Str
898898
CLIENT_VERSION_COUNTERS.computeIfAbsent(
899899
new Tuple.Tuple2<>(Integer.toString(siteId), clientVersion),
900900
tuple -> Counter
901-
.builder("uid2.client_sdk_versions")
901+
.builder("uid2_client_sdk_versions_total")
902902
.description("counter for how many http requests are processed per each operator-served sdk version")
903903
.tags("site_id", tuple.getItem1(), "api_contact", apiContact, "client_version", tuple.getItem2(), "path", path)
904904
.register(Metrics.globalRegistry)
@@ -1807,26 +1807,26 @@ private void recordIdentityMapStats(RoutingContext rc, int inputCount, int inval
18071807
String apiContact = getApiContact(rc);
18081808

18091809
DistributionSummary ds = _identityMapMetricSummaries.computeIfAbsent(apiContact, k -> DistributionSummary
1810-
.builder("uid2.operator.identity.map.inputs")
1810+
.builder("uid2_operator_identity_map_inputs")
18111811
.description("number of emails or email hashes passed to identity map batch endpoint")
18121812
.tags("api_contact", apiContact)
18131813
.register(Metrics.globalRegistry));
18141814
ds.record(inputCount);
18151815

18161816
Tuple.Tuple2<Counter, Counter> ids = _identityMapUnmappedIdentifiers.computeIfAbsent(apiContact, k -> new Tuple.Tuple2<>(
1817-
Counter.builder("uid2.operator.identity.map.unmapped")
1817+
Counter.builder("uid2_operator_identity_map_unmapped_total")
18181818
.description("invalid identifiers")
18191819
.tags("api_contact", apiContact, "reason", "invalid")
18201820
.register(Metrics.globalRegistry),
1821-
Counter.builder("uid2.operator.identity.map.unmapped")
1821+
Counter.builder("uid2_operator_identity_map_unmapped_total")
18221822
.description("optout identifiers")
18231823
.tags("api_contact", apiContact, "reason", "optout")
18241824
.register(Metrics.globalRegistry)));
18251825
if (invalidCount > 0) ids.getItem1().increment(invalidCount);
18261826
if (optoutCount > 0) ids.getItem2().increment(optoutCount);
18271827

18281828
Counter rs = _identityMapRequestWithUnmapped.computeIfAbsent(apiContact, k -> Counter
1829-
.builder("uid2.operator.identity.map.unmapped_requests")
1829+
.builder("uid2_operator_identity_map_unmapped_requests_total")
18301830
.description("number of requests with unmapped identifiers")
18311831
.tags("api_contact", apiContact)
18321832
.register(Metrics.globalRegistry));
@@ -1845,7 +1845,7 @@ private void recordIdentityMapStatsForServiceLinks(RoutingContext rc, String api
18451845
final String serviceName = rc.get(SecureLinkValidatorService.SERVICE_NAME);
18461846
final String metricKey = serviceName + serviceLinkName;
18471847
DistributionSummary ds = _identityMapMetricSummaries.computeIfAbsent(metricKey,
1848-
k -> DistributionSummary.builder("uid2.operator.identity.map.services.inputs")
1848+
k -> DistributionSummary.builder("uid2_operator_identity_map_services_inputs")
18491849
.description("number of emails or phone numbers passed to identity map batch endpoint by services")
18501850
.tags(Arrays.asList(Tag.of("api_contact", apiContact),
18511851
Tag.of("service_name", serviceName),
@@ -1855,14 +1855,14 @@ private void recordIdentityMapStatsForServiceLinks(RoutingContext rc, String api
18551855

18561856
Tuple.Tuple2<Counter, Counter> counterTuple = _identityMapUnmappedIdentifiers.computeIfAbsent(metricKey,
18571857
k -> new Tuple.Tuple2<>(
1858-
Counter.builder("uid2.operator.identity.map.services.unmapped")
1858+
Counter.builder("uid2_operator_identity_map_services_unmapped_total")
18591859
.description("number of invalid identifiers passed to identity map batch endpoint by services")
18601860
.tags(Arrays.asList(Tag.of("api_contact", apiContact),
18611861
Tag.of("reason", "invalid"),
18621862
Tag.of("service_name", serviceName),
18631863
Tag.of("service_link_name", serviceLinkName)))
18641864
.register(Metrics.globalRegistry),
1865-
Counter.builder("uid2.operator.identity.map.services.unmapped")
1865+
Counter.builder("uid2_operator_identity_map_services_unmapped_total")
18661866
.description("number of optout identifiers passed to identity map batch endpoint by services")
18671867
.tags(Arrays.asList(Tag.of("api_contact", apiContact),
18681868
Tag.of("reason", "optout"),
@@ -1928,14 +1928,14 @@ private void handleOptoutStatus(RoutingContext rc) {
19281928
private void recordOptOutStatusEndpointStats(RoutingContext rc, int inputCount, int optOutCount) {
19291929
String apiContact = getApiContact(rc);
19301930
DistributionSummary inputDistSummary = optOutStatusCounters.computeIfAbsent(apiContact, k -> DistributionSummary
1931-
.builder("uid2.operator.optout.status.input_size")
1931+
.builder("uid2_operator_optout_status_input_size")
19321932
.description("number of UIDs received in request")
19331933
.tags("api_contact", apiContact)
19341934
.register(Metrics.globalRegistry));
19351935
inputDistSummary.record(inputCount);
19361936

19371937
DistributionSummary optOutDistSummary = optOutStatusCounters.computeIfAbsent(apiContact, k -> DistributionSummary
1938-
.builder("uid2.operator.optout.status.optout_size")
1938+
.builder("uid2_operator_optout_status_optout_size")
19391939
.description("number of UIDs that have opted out")
19401940
.tags("api_contact", apiContact)
19411941
.register(Metrics.globalRegistry));
@@ -1956,7 +1956,7 @@ public TokenVersion getRefreshTokenVersion(String s) {
19561956
}
19571957

19581958
private void recordRefreshTokenVersionCount(String siteId, TokenVersion tokenVersion) {
1959-
Counter.builder("uid2_refresh_token_received_count")
1959+
Counter.builder("uid2_refresh_token_received_count_total")
19601960
.description(String.format("Counter for the amount of refresh token %s received", tokenVersion.toString().toLowerCase()))
19611961
.tags("site_id", siteId)
19621962
.tags("refresh_token_version", tokenVersion.toString().toLowerCase())
@@ -2017,7 +2017,7 @@ private TokenResponseStatsCollector.PlatformType getPlatformType(RoutingContext
20172017
private void recordRefreshDurationStats(Integer siteId, String apiContact, Duration durationSinceLastRefresh, boolean hasOriginHeader, Duration identityExpiresAfter) {
20182018
DistributionSummary ds = _refreshDurationMetricSummaries.computeIfAbsent(new Tuple.Tuple2<>(apiContact, hasOriginHeader), k ->
20192019
DistributionSummary
2020-
.builder("uid2.token_refresh_duration_seconds")
2020+
.builder("uid2_token_refresh_duration_seconds")
20212021
.description("duration between token refreshes")
20222022
.tag("site_id", String.valueOf(siteId))
20232023
.tag("site_name", getSiteName(siteProvider, siteId))
@@ -2030,7 +2030,7 @@ private void recordRefreshDurationStats(Integer siteId, String apiContact, Durat
20302030
boolean isExpired = durationSinceLastRefresh.compareTo(identityExpiresAfter) > 0;
20312031
Counter c = _advertisingTokenExpiryStatus.computeIfAbsent(new Tuple.Tuple3<>(String.valueOf(siteId), hasOriginHeader, isExpired), k ->
20322032
Counter
2033-
.builder("uid2.advertising_token_expired_on_refresh")
2033+
.builder("uid2_advertising_token_expired_on_refresh_total")
20342034
.description("status of advertiser token expiry")
20352035
.tag("site_id", String.valueOf(siteId))
20362036
.tag("site_name", getSiteName(siteProvider, siteId))
@@ -2163,15 +2163,15 @@ private Tuple.Tuple2<OptoutCheckPolicy, String> readOptoutCheckPolicy(JsonObject
21632163

21642164
private void recordTokenGeneratePolicy(String apiContact, OptoutCheckPolicy policy, String policyParameterKey) {
21652165
_tokenGeneratePolicyCounters.computeIfAbsent(new Tuple.Tuple3<>(apiContact, policy, policyParameterKey), triple -> Counter
2166-
.builder("uid2.token_generate_policy_usage")
2166+
.builder("uid2_token_generate_policy_usage_total")
21672167
.description("Counter for token generate policy usage")
21682168
.tags("api_contact", triple.getItem1(), "policy", String.valueOf(triple.getItem2()), "policy_parameter", triple.getItem3())
21692169
.register(Metrics.globalRegistry)).increment();
21702170
}
21712171

21722172
private void recordTokenGenerateTCFUsage(String apiContact) {
21732173
_tokenGenerateTCFUsage.computeIfAbsent(apiContact, contact -> Counter
2174-
.builder("uid2.token_generate_tcf_usage")
2174+
.builder("uid2_token_generate_tcf_usage_total")
21752175
.description("Counter for token generate tcf usage")
21762176
.tags("api_contact", contact)
21772177
.register(Metrics.globalRegistry)).increment();

‎src/test/java/com/uid2/operator/TokenEncodingTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ public void testRefreshTokenEncoding(TokenVersion tokenVersion) {
8282
assertEquals(Data.RefreshKeySiteId, keyManager.getSiteIdFromKeyId(keyId));
8383

8484
assertNotNull(Metrics.globalRegistry
85-
.get("uid2_refresh_token_served_count")
85+
.get("uid2_refresh_token_served_count_total")
8686
.counter());
8787
}
8888

‎src/test/java/com/uid2/operator/UIDOperatorVerticleTest.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2055,13 +2055,13 @@ void captureDurationsBetweenRefresh(String apiVersion, Vertx vertx, VertxTestCon
20552055
sendTokenRefresh(apiVersion, vertx, testContext, refreshToken, bodyJson.getString("refresh_response_key"), 200, refreshRespJson -> {
20562056
assertEquals("success", refreshRespJson.getString("status"));
20572057
assertEquals(300, Metrics.globalRegistry
2058-
.get("uid2.token_refresh_duration_seconds")
2058+
.get("uid2_token_refresh_duration_seconds")
20592059
.tag("api_contact", "test-contact")
20602060
.tag("site_id", String.valueOf(clientSiteId))
20612061
.summary().mean());
20622062

20632063
assertEquals(1, Metrics.globalRegistry
2064-
.get("uid2.advertising_token_expired_on_refresh")
2064+
.get("uid2_advertising_token_expired_on_refresh_total")
20652065
.tag("site_id", String.valueOf(clientSiteId))
20662066
.tag("is_expired", "false")
20672067
.counter().count());
@@ -2086,7 +2086,7 @@ void captureExpiredAdvertisingTokenStatus(String apiVersion, Vertx vertx, VertxT
20862086
assertEquals("success", refreshRespJson.getString("status"));
20872087

20882088
assertEquals(1, Metrics.globalRegistry
2089-
.get("uid2.advertising_token_expired_on_refresh")
2089+
.get("uid2_advertising_token_expired_on_refresh_total")
20902090
.tag("site_id", String.valueOf(clientSiteId))
20912091
.tag("is_expired", "true")
20922092
.counter().count());
@@ -2110,7 +2110,7 @@ void tokenRefreshExpiredTokenAuthenticated(String apiVersion, Vertx vertx, Vertx
21102110
sendTokenRefresh(apiVersion, vertx, testContext, refreshToken, bodyJson.getString("refresh_response_key"), 400, refreshRespJson -> {
21112111
assertEquals("expired_token", refreshRespJson.getString("status"));
21122112
assertNotNull(Metrics.globalRegistry
2113-
.get("uid2_refresh_token_received_count").counter());
2113+
.get("uid2_refresh_token_received_count_total").counter());
21142114
testContext.completeNow();
21152115
});
21162116
});
@@ -2130,7 +2130,7 @@ void tokenRefreshExpiredTokenUnauthenticated(String apiVersion, Vertx vertx, Ver
21302130
sendTokenRefresh(apiVersion, vertx, testContext, refreshToken, "", 400, refreshRespJson -> {
21312131
assertEquals("error", refreshRespJson.getString("status"));
21322132
assertNotNull(Metrics.globalRegistry
2133-
.get("uid2_refresh_token_received_count").counter());
2133+
.get("uid2_refresh_token_received_count_total").counter());
21342134
testContext.completeNow();
21352135
});
21362136
});

0 commit comments

Comments
 (0)