fix(o11y): do not record error.type in successful runs (#12620)

diegomarquezp · web-flow · commit 28eebf0442f8 · 2026-04-02T11:06:09.000-04:00
When `error` is null, return `null` since there is no error, hence no
error type.

Also, added tests in `ITOtelTracing` to confirm that the error attrs are
not recorded.
diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java
@@ -112,14 +112,14 @@ enum ErrorType {
    * </ol>
    *
    * @param error the Throwable from which to extract the error type string.
-   * @return a low-cardinality string representing the specific error type, or {@code
-   *     ErrorType.INTERNAL.toString()} if the provided error is {@code null} or non-determined.
+   * @return a low-cardinality string representing the specific error type, or {@code null} if the
+   *     provided error is {@code null} or non-determined.
    */
   // Requirement source: go/clo:product-requirements-v1
   public static String extractErrorType(@Nullable Throwable error) {
     if (error == null) {
-      // No information about the error; we default to INTERNAL.
-      return ErrorType.INTERNAL.toString();
+      // No information about the error; return null so the attribute is not recorded.
+      return null;
     }
 
     // 1. Unwrap standard wrapper exceptions if present
diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java
@@ -205,9 +205,6 @@ private void recordErrorAndEndAttempt(Throwable error) {
       return;
     }
 
-    attemptSpan.setAttribute(
-        ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE, ObservabilityUtils.extractErrorType(error));
-
     Map<String, Object> statusAttributes = new HashMap<>();
     ObservabilityUtils.populateStatusAttributes(
         statusAttributes, error, this.apiTracerContext.transport());
@@ -220,6 +217,9 @@ private void recordErrorAndEndAttempt(Throwable error) {
       return;
     }
 
+    attemptSpan.setAttribute(
+        ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE, ObservabilityUtils.extractErrorType(error));
+
     attemptSpan.setAttribute(
         ObservabilityAttributes.EXCEPTION_TYPE_ATTRIBUTE, error.getClass().getName());
 
diff --git a/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/ErrorTypeUtilTest.java b/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/ErrorTypeUtilTest.java
@@ -53,8 +53,7 @@ class ErrorTypeUtilTest {
 
   @Test
   void testExtractErrorType_null() {
-    assertThat(ErrorTypeUtil.extractErrorType(null))
-        .isEqualTo(ErrorTypeUtil.ErrorType.INTERNAL.toString());
+    assertThat(ErrorTypeUtil.extractErrorType(null)).isNull();
   }
 
   @Test
diff --git a/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerTest.java b/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerTest.java
@@ -565,10 +565,8 @@ void testAttemptFailed_internalFallback_nullError() {
     // For an anonymous inner class Throwable, getSimpleName() is empty string,
     // which triggers the
     // fallback
-    verify(span)
-        .setAttribute(
-            ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE,
-            ErrorTypeUtil.ErrorType.INTERNAL.toString());
+    verify(span, never())
+        .setAttribute(eq(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE), anyString());
     verify(span).end();
   }
 
diff --git a/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITCompositeTracer.java b/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITCompositeTracer.java
@@ -34,7 +34,6 @@
 
 import com.google.api.gax.tracing.CompositeTracerFactory;
 import com.google.api.gax.tracing.GoldenSignalsMetricsTracerFactory;
-import com.google.api.gax.tracing.LoggingTracerFactory;
 import com.google.api.gax.tracing.ObservabilityAttributes;
 import com.google.api.gax.tracing.SpanTracerFactory;
 import com.google.showcase.v1beta1.EchoClient;
@@ -43,13 +42,13 @@
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.metrics.data.MetricData;
+import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader;
 import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import io.opentelemetry.sdk.trace.data.SpanData;
 import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
-import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader;
-import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
@@ -94,15 +93,16 @@ void tearDown() {
 
   private CompositeTracerFactory createCompositeTracerFactory() {
     SpanTracerFactory spanTracerFactory = new SpanTracerFactory(openTelemetrySdk);
-    GoldenSignalsMetricsTracerFactory metricsTracerFactory = new GoldenSignalsMetricsTracerFactory(openTelemetrySdk);
+    GoldenSignalsMetricsTracerFactory metricsTracerFactory =
+        new GoldenSignalsMetricsTracerFactory(openTelemetrySdk);
 
     return new CompositeTracerFactory(Arrays.asList(spanTracerFactory, metricsTracerFactory));
   }
 
   @Test
   void testCompositeTracer() throws Exception {
     try (EchoClient client =
-                 TestClientInitializer.createGrpcEchoClientOpentelemetry(createCompositeTracerFactory())) {
+        TestClientInitializer.createGrpcEchoClientOpentelemetry(createCompositeTracerFactory())) {
 
       client.echo(EchoRequest.newBuilder().setContent("composite-tracing-test").build());
 
@@ -111,31 +111,37 @@ void testCompositeTracer() throws Exception {
       assertThat(actualSpans).isNotEmpty();
 
       SpanData attemptSpan =
-              actualSpans.stream()
-                      .filter(span -> span.getName().equals("google.showcase.v1beta1.Echo/Echo"))
-                      .findFirst()
-                      .orElseThrow(() -> new AssertionError("Incorrect span name"));
+          actualSpans.stream()
+              .filter(span -> span.getName().equals("google.showcase.v1beta1.Echo/Echo"))
+              .findFirst()
+              .orElseThrow(() -> new AssertionError("Incorrect span name"));
       assertThat(attemptSpan.getInstrumentationScopeInfo().getName()).isEqualTo(SHOWCASE_ARTIFACT);
       assertThat(
               attemptSpan
-                      .getAttributes()
-                      .get(AttributeKey.stringKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE)))
-              .isEqualTo(SHOWCASE_SERVER_ADDRESS);
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE)))
+          .isEqualTo(SHOWCASE_SERVER_ADDRESS);
 
       // Verify metric name and one basic attribute server.address
       Collection<MetricData> actualMetrics = metricReader.collectAllMetrics();
 
       assertThat(actualMetrics).isNotEmpty();
-      MetricData metricData = actualMetrics.stream()
+      MetricData metricData =
+          actualMetrics.stream()
               .filter(metricData1 -> metricData1.getName().equals("gcp.client.request.duration"))
               .findFirst()
               .orElseThrow(() -> new AssertionError("Incorrect metric name"));
       assertThat(metricData.getInstrumentationScopeInfo().getName()).isEqualTo(SHOWCASE_ARTIFACT);
 
-      assertThat(metricData.getHistogramData().getPoints().iterator().next()
-              .getAttributes()
-              .get(AttributeKey.stringKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE)))
-              .isEqualTo(SHOWCASE_SERVER_ADDRESS);
+      assertThat(
+              metricData
+                  .getHistogramData()
+                  .getPoints()
+                  .iterator()
+                  .next()
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE)))
+          .isEqualTo(SHOWCASE_SERVER_ADDRESS);
     }
   }
 }
diff --git a/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracing.java b/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracing.java
@@ -180,6 +180,21 @@ void testTracing_successfulEcho_grpc() throws Exception {
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.URL_DOMAIN_ATTRIBUTE)))
           .isEqualTo("showcase.googleapis.com");
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE)))
+          .isNull();
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.STATUS_MESSAGE_ATTRIBUTE)))
+          .isNull();
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.EXCEPTION_TYPE_ATTRIBUTE)))
+          .isNull();
       assertThat(attemptSpan.getInstrumentationScopeInfo().getName()).isEqualTo(SHOWCASE_ARTIFACT);
     }
   }
@@ -256,6 +271,21 @@ void testTracing_successfulEcho_httpjson() throws Exception {
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.HTTP_URL_FULL_ATTRIBUTE)))
           .isEqualTo(SHOWCASE_USER_URL);
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE)))
+          .isNull();
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.STATUS_MESSAGE_ATTRIBUTE)))
+          .isNull();
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.stringKey(ObservabilityAttributes.EXCEPTION_TYPE_ATTRIBUTE)))
+          .isNull();
       EchoResponse fetchedEcho = EchoResponse.newBuilder().setContent("tracing-test").build();
       long expectedMagnitude = computeExpectedHttpJsonResponseSize(fetchedEcho);
       Long observedMagnitude =
@@ -491,8 +521,9 @@ public void sendMessage(ReqT message) {}
 
       assertThrows(UnavailableException.class, () -> client.echo(echoRequest));
       verifyErrorTypeAttribute("UNAVAILABLE");
-		}
-	}
+    }
+  }
+
   @Test
   void testTracing_statusCodes_grpc() throws Exception {
     SpanTracerFactory tracingFactory = new SpanTracerFactory(openTelemetrySdk);
@@ -626,8 +657,9 @@ public String getHeaderValue(int index) {
 
       assertThrows(UnavailableException.class, () -> client.echo(echoRequest));
       verifyErrorTypeAttribute("503");
-		}
-	}
+    }
+  }
+
   void testTracing_statusCodes_httpjson() throws Exception {
     SpanTracerFactory tracingFactory = new SpanTracerFactory(openTelemetrySdk);
     EchoRequest errorRequest =

Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,7 @@ class ErrorTypeUtilTest {`
`53`	`53`
`54`	`54`	`@Test`
`55`	`55`	`void testExtractErrorType_null() {`
`56`		`- assertThat(ErrorTypeUtil.extractErrorType(null))`
`57`		`- .isEqualTo(ErrorTypeUtil.ErrorType.INTERNAL.toString());`
	`56`	`+ assertThat(ErrorTypeUtil.extractErrorType(null)).isNull();`
`58`	`57`	`}`
`59`	`58`
`60`	`59`	`@Test`