From a42d25c72f868fb1564607c3dc29a6e372480172 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Thu, 30 May 2024 17:13:00 -0400 Subject: [PATCH 1/4] fix: Update default Otel Attribute from method_name to method --- gax-java/gax/clirr-ignored-differences.xml | 6 +++++ .../google/api/gax/tracing/MetricsTracer.java | 4 ++-- .../gax/tracing/MetricsTracerFactoryTest.java | 5 ++-- .../api/gax/tracing/MetricsTracerTest.java | 6 ++--- .../showcase/v1beta1/it/ITOtelMetrics.java | 24 +++++++++---------- 5 files changed, 26 insertions(+), 19 deletions(-) diff --git a/gax-java/gax/clirr-ignored-differences.xml b/gax-java/gax/clirr-ignored-differences.xml index b08615ef13..ee9c382bdf 100644 --- a/gax-java/gax/clirr-ignored-differences.xml +++ b/gax-java/gax/clirr-ignored-differences.xml @@ -47,4 +47,10 @@ com/google/api/gax/rpc/StubSettings * getServiceName() + + + 6011 + com/google/api/gax/tracing/MetricsTracer + METHOD_NAME_ATTRIBUTE + diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java index 7938bde82b..586e22c959 100644 --- a/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java +++ b/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java @@ -53,7 +53,7 @@ @BetaApi @InternalApi public class MetricsTracer implements ApiTracer { - public static final String METHOD_NAME_ATTRIBUTE = "method_name"; + public static final String METHOD_ATTRIBUTE = "method"; public static final String LANGUAGE_ATTRIBUTE = "language"; public static final String STATUS_ATTRIBUTE = "status"; public static final String DEFAULT_LANGUAGE = "Java"; @@ -66,7 +66,7 @@ public class MetricsTracer implements ApiTracer { private final AtomicBoolean operationFinished; public MetricsTracer(MethodName methodName, MetricsRecorder metricsRecorder) { - this.attributes.put(METHOD_NAME_ATTRIBUTE, methodName.toString()); + this.attributes.put(METHOD_ATTRIBUTE, methodName.toString()); this.attributes.put(LANGUAGE_ATTRIBUTE, DEFAULT_LANGUAGE); this.metricsRecorder = metricsRecorder; this.operationFinished = new AtomicBoolean(); diff --git a/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerFactoryTest.java b/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerFactoryTest.java index 16e2078bc0..1baf4154bf 100644 --- a/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerFactoryTest.java +++ b/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerFactoryTest.java @@ -66,7 +66,6 @@ void testNewTracer_notNull() { @Test void testNewTracer_HasCorrectParameters() { - // Call the newTracer method ApiTracer apiTracer = metricsTracerFactory.newTracer(parent, spanName, OperationType.Unary); @@ -75,7 +74,9 @@ void testNewTracer_HasCorrectParameters() { Truth.assertThat(apiTracer).isNotNull(); MetricsTracer metricsTracer = (MetricsTracer) apiTracer; - Truth.assertThat(metricsTracer.getAttributes().get("method_name")) + Truth.assertThat(metricsTracer.getAttributes().get(MetricsTracer.METHOD_ATTRIBUTE)) .isEqualTo("testService.testMethod"); + Truth.assertThat(metricsTracer.getAttributes().get(MetricsTracer.LANGUAGE_ATTRIBUTE)) + .isEqualTo(MetricsTracer.DEFAULT_LANGUAGE); } } diff --git a/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerTest.java b/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerTest.java index 5c0945a411..f409d27ec4 100644 --- a/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerTest.java +++ b/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerTest.java @@ -65,11 +65,11 @@ void setUp() { private ImmutableMap getAttributes(Code statusCode) { return ImmutableMap.of( - "status", + MetricsTracer.STATUS_ATTRIBUTE, statusCode.toString(), - "method_name", + MetricsTracer.METHOD_ATTRIBUTE, DEFAULT_METHOD_NAME, - "language", + MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); } diff --git a/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java b/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java index c2ecff034d..58a88a3c1c 100644 --- a/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java +++ b/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java @@ -301,7 +301,7 @@ void testGrpc_operationSucceeded_recordsMetrics() throws InterruptedException { Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "Echo.Echo", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -324,7 +324,7 @@ void testHttpJson_operationSucceeded_recordsMetrics() throws InterruptedExceptio Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "google.showcase.v1beta1.Echo/Echo", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -354,7 +354,7 @@ void testGrpc_operationCancelled_recordsMetrics() throws Exception { Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "Echo.Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -382,7 +382,7 @@ void testHttpJson_operationCancelled_recordsMetrics() throws Exception { Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "google.showcase.v1beta1.Echo/Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -411,7 +411,7 @@ void testGrpc_operationFailed_recordsMetrics() throws InterruptedException { Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "Echo.Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -441,7 +441,7 @@ void testHttpJson_operationFailed_recordsMetrics() throws InterruptedException { Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "google.showcase.v1beta1.Echo/Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -504,7 +504,7 @@ void testGrpc_attemptFailedRetriesExhausted_recordsMetrics() throws Exception { Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "Echo.Echo", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -572,7 +572,7 @@ void testHttpJson_attemptFailedRetriesExhausted_recordsMetrics() throws Exceptio Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "google.showcase.v1beta1.Echo/Echo", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -602,7 +602,7 @@ void testGrpc_attemptPermanentFailure_recordsMetrics() throws InterruptedExcepti Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "Echo.Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -630,7 +630,7 @@ void testHttpJson_attemptPermanentFailure_recordsMetrics() throws InterruptedExc Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "google.showcase.v1beta1.Echo/Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -699,7 +699,7 @@ void testGrpc_multipleFailedAttempts_successfulOperation() throws Exception { Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "Echo.Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); @@ -769,7 +769,7 @@ void testHttpJson_multipleFailedAttempts_successfulOperation() throws Exception Map attributeMapping = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "google.showcase.v1beta1.Echo/Block", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE); From 204ab7bad2e4749de5a7bda4364f579dd6f8d492 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Wed, 5 Jun 2024 23:00:23 -0400 Subject: [PATCH 2/4] chore: Ignore all fields --- gax-java/gax/clirr-ignored-differences.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gax-java/gax/clirr-ignored-differences.xml b/gax-java/gax/clirr-ignored-differences.xml index ee9c382bdf..ef93ba01ca 100644 --- a/gax-java/gax/clirr-ignored-differences.xml +++ b/gax-java/gax/clirr-ignored-differences.xml @@ -51,6 +51,6 @@ 6011 com/google/api/gax/tracing/MetricsTracer - METHOD_NAME_ATTRIBUTE + * From 367bd1177a25958a7cd6f95ec7705c35952eb962 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Wed, 5 Jun 2024 23:01:27 -0400 Subject: [PATCH 3/4] chore: Ignore all fields --- gax-java/gax/clirr-ignored-differences.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gax-java/gax/clirr-ignored-differences.xml b/gax-java/gax/clirr-ignored-differences.xml index ef93ba01ca..b58200572e 100644 --- a/gax-java/gax/clirr-ignored-differences.xml +++ b/gax-java/gax/clirr-ignored-differences.xml @@ -47,7 +47,7 @@ com/google/api/gax/rpc/StubSettings * getServiceName() - + 6011 com/google/api/gax/tracing/MetricsTracer From ded22f8b70898437f06144989776d2e0d296d1ed Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Thu, 6 Jun 2024 10:23:11 -0400 Subject: [PATCH 4/4] chore: Fix showcase tests --- .../test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java b/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java index 6c4d4f74e1..55b07a851b 100644 --- a/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java +++ b/showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java @@ -839,7 +839,7 @@ void recordsCustomAttributes() throws InterruptedException, IOException { List actualMetricDataList = getMetricDataList(inMemoryMetricReader); Map expectedAttributes = ImmutableMap.of( - MetricsTracer.METHOD_NAME_ATTRIBUTE, + MetricsTracer.METHOD_ATTRIBUTE, "Echo.Echo", MetricsTracer.LANGUAGE_ATTRIBUTE, MetricsTracer.DEFAULT_LANGUAGE,