Merge branch 'main' into test/actionable-errors-logging-integration

westarle · web-flow · commit 4773130bf71c · 2026-04-02T17:00:26.000-04:00
diff --git a/.github/workflows/hermetic_library_generation.yaml b/.github/workflows/hermetic_library_generation.yaml
@@ -43,4 +43,5 @@ jobs:
         base_ref: ${{ github.base_ref }}
         head_ref: ${{ github.head_ref }}
         token: ${{ secrets.CLOUD_JAVA_BOT_GITHUB_TOKEN }}
+        force_regenerate_all: ${{ github.event.pull_request.head.ref == 'generate-libraries-main' }}
         image_tag: 2.68.1-SNAPSHOT  # {x-version-update:gapic-generator-java:current}
diff --git a/sdk-platform-java/.github/scripts/action.yaml b/sdk-platform-java/.github/scripts/action.yaml
@@ -36,6 +36,9 @@ inputs:
   token:
     description: Personal Access Token
     required: true
+  force_regenerate_all:
+    description: true if we want to regenerate all libraries
+    required: false
 
 runs:
   using: "composite"
@@ -76,10 +79,12 @@ runs:
         --target_branch "${BASE_REF}" \
         --current_branch "${HEAD_REF}" \
         --showcase_mode "${SHOWCASE_MODE}" \
-        --image_tag "${IMAGE_TAG}"
+        --image_tag "${IMAGE_TAG}" \
+        --force_regenerate_all "${FORCE_REGENERATE_ALL}"
     env:
       BASE_REF: ${{ inputs.base_ref }}
       HEAD_REF: ${{ inputs.head_ref }}
       IMAGE_TAG: ${{ inputs.image_tag }}
       SHOWCASE_MODE: ${{ inputs.showcase_mode }}
       GH_TOKEN: ${{ inputs.token }}
+      FORCE_REGENERATE_ALL: ${{ inputs.force_regenerate_all }}
diff --git a/sdk-platform-java/.github/scripts/hermetic_library_generation.sh b/sdk-platform-java/.github/scripts/hermetic_library_generation.sh
@@ -50,6 +50,10 @@ case "${key}" in
     showcase_mode="$2"
     shift
     ;;
+  --force_regenerate_all)
+    force_regenerate_all="$2"
+    shift
+    ;;
   *)
     echo "Invalid option: [$1]"
     exit 1
@@ -81,6 +85,10 @@ if [ -z "${image_tag}" ]; then
   image_tag=$(grep "gapic_generator_version" "${generation_config}" | cut -d ':' -f 2 | xargs)
 fi
 
+if [ -z "${force_regenerate_all}" ]; then
+  force_regenerate_all="false"
+fi
+
 workspace_name="/workspace"
 baseline_generation_config="baseline_generation_config.yaml"
 message="chore: generate libraries at $(date)"
@@ -109,7 +117,8 @@ fi
 changed_libraries_file="$(mktemp)"
 python hermetic_build/common/cli/get_changed_libraries.py create \
   --baseline-generation-config-path="${baseline_generation_config}" \
-  --current-generation-config-path="${generation_config}" | tee "${changed_libraries_file}"
+  --current-generation-config-path="${generation_config}"\
+  --force-regenerate-all="${force_regenerate_all}" | tee "${changed_libraries_file}"
 changed_libraries="$(cat "${changed_libraries_file}")"
 echo "Changed libraries are: ${changed_libraries:-"No changed library"}."
 
diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsRecorder.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsRecorder.java
@@ -29,12 +29,16 @@
  */
 package com.google.api.gax.tracing;
 
+import com.google.api.gax.rpc.LibraryMetadata;
+import com.google.common.base.Strings;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.metrics.DoubleHistogram;
 import io.opentelemetry.api.metrics.Meter;
+import io.opentelemetry.api.metrics.MeterBuilder;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
+import javax.annotation.Nullable;
 
 /**
  * This class takes an OpenTelemetry object, and creates instruments (meters, histograms etc.) from
@@ -53,8 +57,23 @@ class GoldenSignalsMetricsRecorder {
           900.0, 3600.0);
   final DoubleHistogram clientRequestDurationRecorder;
 
-  GoldenSignalsMetricsRecorder(OpenTelemetry openTelemetry, String libraryName) {
-    Meter meter = openTelemetry.meterBuilder(libraryName).build();
+  @Nullable
+  static GoldenSignalsMetricsRecorder create(
+      OpenTelemetry openTelemetry, LibraryMetadata libraryMetadata) {
+    if (libraryMetadata == null || Strings.isNullOrEmpty(libraryMetadata.artifactName())) {
+      return null;
+    }
+    return new GoldenSignalsMetricsRecorder(openTelemetry, libraryMetadata);
+  }
+
+  private GoldenSignalsMetricsRecorder(
+      OpenTelemetry openTelemetry, LibraryMetadata libraryMetadata) {
+    MeterBuilder meterBuilder = openTelemetry.meterBuilder(libraryMetadata.artifactName());
+    String libraryVersion = libraryMetadata.version();
+    if (!Strings.isNullOrEmpty(libraryVersion)) {
+      meterBuilder.setInstrumentationVersion(libraryVersion);
+    }
+    Meter meter = meterBuilder.build();
 
     this.clientRequestDurationRecorder =
         meter
diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracer.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracer.java
@@ -29,14 +29,12 @@
  */
 package com.google.api.gax.tracing;
 
-import static com.google.api.gax.tracing.ObservabilityAttributes.RPC_RESPONSE_STATUS_ATTRIBUTE;
-
-import com.google.api.gax.rpc.StatusCode;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Stopwatch;
 import com.google.common.base.Ticker;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.CancellationException;
 import java.util.concurrent.TimeUnit;
 
 /**
@@ -77,21 +75,25 @@ class GoldenSignalsMetricsTracer implements ApiTracer {
    */
   @Override
   public void operationSucceeded() {
-    attributes.put(RPC_RESPONSE_STATUS_ATTRIBUTE, StatusCode.Code.OK.toString());
+    ObservabilityUtils.populateStatusAttributes(attributes, null, transport);
     metricsRecorder.recordOperationLatency(
         clientRequestTimer.elapsed(TimeUnit.NANOSECONDS) / 1_000_000_000.0, attributes);
   }
 
   @Override
   public void operationCancelled() {
-    attributes.put(RPC_RESPONSE_STATUS_ATTRIBUTE, StatusCode.Code.CANCELLED.toString());
-    metricsRecorder.recordOperationLatency(
-        clientRequestTimer.elapsed(TimeUnit.NANOSECONDS) / 1_000_000_000.0, attributes);
+    recordError(new CancellationException());
   }
 
   @Override
   public void operationFailed(Throwable error) {
+    recordError(error);
+  }
+
+  private void recordError(Throwable error) {
     ObservabilityUtils.populateStatusAttributes(attributes, error, transport);
+    attributes.put(
+        ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE, ObservabilityUtils.extractErrorType(error));
     metricsRecorder.recordOperationLatency(
         clientRequestTimer.elapsed(TimeUnit.NANOSECONDS) / 1_000_000_000.0, attributes);
   }
diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracerFactory.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracerFactory.java
@@ -29,10 +29,8 @@
  */
 package com.google.api.gax.tracing;
 
-import com.google.api.client.util.Strings;
 import com.google.api.core.BetaApi;
 import com.google.api.core.InternalApi;
-import com.google.api.gax.rpc.LibraryMetadata;
 import io.opentelemetry.api.OpenTelemetry;
 
 /**
@@ -85,14 +83,12 @@ public ApiTracerFactory withContext(ApiTracerContext context) {
     if (context == null) {
       return new BaseApiTracerFactory();
     }
-    LibraryMetadata metadata = context.libraryMetadata();
-    if (metadata == null || metadata.isEmpty() || Strings.isNullOrEmpty(metadata.artifactName())) {
+    this.metricsRecorder =
+        GoldenSignalsMetricsRecorder.create(openTelemetry, context.libraryMetadata());
+    if (this.metricsRecorder == null) {
       return new BaseApiTracerFactory();
     }
     this.clientLevelTracerContext = context;
-    this.metricsRecorder =
-        new GoldenSignalsMetricsRecorder(
-            openTelemetry, clientLevelTracerContext.libraryMetadata().artifactName());
     return this;
   }
 }
diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ObservabilityUtils.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ObservabilityUtils.java
@@ -175,11 +175,10 @@ static void populateStatusAttributes(
       @Nullable Throwable error,
       ApiTracerContext.Transport transport) {
     StatusCode.Code code = extractStatus(error);
+    attributes.put(ObservabilityAttributes.RPC_RESPONSE_STATUS_ATTRIBUTE, code.toString());
     if (transport == ApiTracerContext.Transport.HTTP) {
       attributes.put(
           ObservabilityAttributes.HTTP_RESPONSE_STATUS_ATTRIBUTE, (long) code.getHttpStatusCode());
-    } else {
-      attributes.put(ObservabilityAttributes.RPC_RESPONSE_STATUS_ATTRIBUTE, code.toString());
     }
   }
 
diff --git a/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/GoldenSignalsMetricsRecorderTest.java b/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/GoldenSignalsMetricsRecorderTest.java
@@ -34,6 +34,7 @@
 import static com.google.api.gax.tracing.GoldenSignalsMetricsRecorder.CLIENT_REQUEST_DURATION_METRIC_NAME;
 import static com.google.common.truth.Truth.assertThat;
 
+import com.google.api.gax.rpc.LibraryMetadata;
 import com.google.common.collect.ImmutableMap;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.common.AttributeKey;
@@ -62,7 +63,13 @@ void setUp() {
         SdkMeterProvider.builder().registerMetricReader(metricReader).build();
     OpenTelemetry openTelemetry =
         OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build();
-    recorder = new GoldenSignalsMetricsRecorder(openTelemetry, ARTIFACT_NAME);
+    recorder =
+        GoldenSignalsMetricsRecorder.create(
+            openTelemetry,
+            LibraryMetadata.newBuilder()
+                .setArtifactName(ARTIFACT_NAME)
+                .setVersion("1.2.3")
+                .build());
   }
 
   @Test
@@ -114,4 +121,27 @@ void recordOperationLatency_shouldRecordMetricAttributes() {
     assertThat(metricData.getHistogramData().getPoints().iterator().next().getAttributes())
         .isEqualTo(Attributes.of(AttributeKey.stringKey(ATTRIBUTE_1), VALUE_1));
   }
+
+  @Test
+  void create_shouldReturnNull_whenLibraryMetadataIsNull() {
+    GoldenSignalsMetricsRecorder actual =
+        GoldenSignalsMetricsRecorder.create(OpenTelemetry.noop(), null);
+    assertThat(actual).isNull();
+  }
+
+  @Test
+  void create_shouldReturnNull_whenArtifactNameIsNull() {
+    LibraryMetadata metadata = LibraryMetadata.newBuilder().setVersion("1.0.0").build();
+    GoldenSignalsMetricsRecorder actual =
+        GoldenSignalsMetricsRecorder.create(OpenTelemetry.noop(), metadata);
+    assertThat(actual).isNull();
+  }
+
+  @Test
+  void create_shouldReturnNull_whenArtifactNameIsEmpty() {
+    LibraryMetadata metadata = LibraryMetadata.newBuilder().setArtifactName("").build();
+    GoldenSignalsMetricsRecorder actual =
+        GoldenSignalsMetricsRecorder.create(OpenTelemetry.noop(), metadata);
+    assertThat(actual).isNull();
+  }
 }
diff --git a/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracerTest.java b/sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracerTest.java
@@ -33,6 +33,7 @@
 import static com.google.common.truth.Truth.assertThat;
 
 import com.google.api.gax.rpc.ApiException;
+import com.google.api.gax.rpc.LibraryMetadata;
 import com.google.api.gax.rpc.StatusCode;
 import com.google.api.gax.rpc.testing.FakeStatusCode;
 import com.google.common.testing.FakeTicker;
@@ -68,7 +69,12 @@ void setUp() {
     ticker = new FakeTicker();
     tracer =
         new GoldenSignalsMetricsTracer(
-            new GoldenSignalsMetricsRecorder(openTelemetry, ARTIFACT_NAME),
+            GoldenSignalsMetricsRecorder.create(
+                openTelemetry,
+                LibraryMetadata.newBuilder()
+                    .setArtifactName(ARTIFACT_NAME)
+                    .setVersion("1.2.3")
+                    .build()),
             ApiTracerContext.empty(),
             ticker);
   }
@@ -129,6 +135,8 @@ void operationCancelled_shouldRecordsOKStatus() {
     assertThat(metricData.getHistogramData().getPoints().iterator().next().getAttributes())
         .isEqualTo(
             Attributes.of(
+                AttributeKey.stringKey(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE),
+                "CancellationException",
                 AttributeKey.stringKey(RPC_RESPONSE_STATUS_ATTRIBUTE),
                 StatusCode.Code.CANCELLED.toString()));
   }
@@ -163,7 +171,67 @@ void operationFailed_shouldRecordsOKStatus() {
     assertThat(metricData.getHistogramData().getPoints().iterator().next().getAttributes())
         .isEqualTo(
             Attributes.of(
+                AttributeKey.stringKey(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE),
+                "INTERNAL",
                 AttributeKey.stringKey(RPC_RESPONSE_STATUS_ATTRIBUTE),
                 StatusCode.Code.INTERNAL.toString()));
   }
+
+  @Test
+  void operationFailed_shouldRecordCancellationException() {
+    java.util.concurrent.CancellationException error =
+        new java.util.concurrent.CancellationException("test cancellation");
+    tracer.operationFailed(error);
+
+    Collection<MetricData> metrics = metricReader.collectAllMetrics();
+    assertThat(metrics).hasSize(1);
+    MetricData metricData = metrics.iterator().next();
+
+    assertThat(metricData.getHistogramData().getPoints()).hasSize(1);
+    assertThat(metricData.getHistogramData().getPoints().iterator().next().getAttributes())
+        .isEqualTo(
+            Attributes.of(
+                AttributeKey.stringKey(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE),
+                "CancellationException",
+                AttributeKey.stringKey(RPC_RESPONSE_STATUS_ATTRIBUTE),
+                StatusCode.Code.CANCELLED.toString()));
+  }
+
+  @Test
+  void operationFailed_shouldRecordClientTimeout() {
+    java.net.SocketTimeoutException error = new java.net.SocketTimeoutException("test timeout");
+    tracer.operationFailed(error);
+
+    Collection<MetricData> metrics = metricReader.collectAllMetrics();
+    assertThat(metrics).hasSize(1);
+    MetricData metricData = metrics.iterator().next();
+
+    assertThat(metricData.getHistogramData().getPoints()).hasSize(1);
+    assertThat(metricData.getHistogramData().getPoints().iterator().next().getAttributes())
+        .isEqualTo(
+            Attributes.of(
+                AttributeKey.stringKey(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE),
+                "CLIENT_TIMEOUT",
+                AttributeKey.stringKey(RPC_RESPONSE_STATUS_ATTRIBUTE),
+                StatusCode.Code.UNKNOWN.toString()));
+  }
+
+  @Test
+  void operationFailed_shouldRecordClientRequestError() {
+    IllegalArgumentException error = new IllegalArgumentException("test illegal argument");
+    tracer.operationFailed(error);
+
+    Collection<MetricData> metrics = metricReader.collectAllMetrics();
+    assertThat(metrics).hasSize(1);
+    MetricData metricData = metrics.iterator().next();
+
+    assertThat(metricData.getHistogramData().getPoints()).hasSize(1);
+    assertThat(metricData.getHistogramData().getPoints().iterator().next().getAttributes())
+        .isEqualTo(
+            Attributes.of(
+                AttributeKey.stringKey(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE),
+                "CLIENT_REQUEST_ERROR",
+                AttributeKey.stringKey(RPC_RESPONSE_STATUS_ATTRIBUTE),
+                StatusCode.Code.UNKNOWN.toString()));
+  }
 }
diff --git a/sdk-platform-java/hermetic_build/DEVELOPMENT.md b/sdk-platform-java/hermetic_build/DEVELOPMENT.md
@@ -190,15 +190,21 @@ python hermetic_build/library_generation/cli/entry_point.py generate \
 2. Set the version of gapic-generator-java
 
    ```shell
-   LOCAL_GENERATOR_VERSION=$(mvn \
+   export LOCAL_GENERATOR_VERSION=$(mvn \
      org.apache.maven.plugins:maven-help-plugin:evaluate \
      -Dexpression=project.version \
-     -pl gapic-generator-java \
+     -pl sdk-platform-java/gapic-generator-java \
      -DforceStdout \
      -q)
    ```
 
-3. Run the image
+3. Clone the googleapis repository (API definitions)
+   ```shell
+	 	  cd google-cloud-java
+	    git clone https://github.com/googleapis/googleapis
+	 ```
+
+4. Run the image
 
    ```shell
       # Assume you want to generate the library in the current working directory
@@ -208,13 +214,13 @@ python hermetic_build/library_generation/cli/entry_point.py generate \
         --quiet \
         -u "$(id -u):$(id -g)" \
         -v "$(pwd):/workspace" \
-        -v /path/to/api-definitions:/workspace/apis \
+        -v "$(pwd)/googleapis:/googleapis" \
         -e GENERATOR_VERSION="${LOCAL_GENERATOR_VERSION}" \
         local:image-tag \
-        --generation-config-path=/workspace/generation_config_file \
-        --library-names=apigee-connect,asset \
+        --generation-config-path=/workspace/generation_config.yaml \
+        --library-names=translate \
         --repository-path=/workspace \
-        --api-definitions-path=/workspace/apis
+        --api-definitions-path=/googleapis
    ```
 
 # Debugging tips
diff --git a/sdk-platform-java/hermetic_build/common/cli/get_changed_libraries.py b/sdk-platform-java/hermetic_build/common/cli/get_changed_libraries.py
diff --git a/sdk-platform-java/hermetic_build/common/utils/generation_config_comparator.py b/sdk-platform-java/hermetic_build/common/utils/generation_config_comparator.py
diff --git a/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelGoldenMetrics.java b/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelGoldenMetrics.java
diff --git a/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/util/TestClientInitializer.java b/sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/util/TestClientInitializer.java

Original file line number	Diff line number	Diff line change
`@@ -175,11 +175,10 @@ static void populateStatusAttributes(`
`175`	`175`	`@Nullable Throwable error,`
`176`	`176`	`ApiTracerContext.Transport transport) {`
`177`	`177`	`StatusCode.Code code = extractStatus(error);`
	`178`	`+ attributes.put(ObservabilityAttributes.RPC_RESPONSE_STATUS_ATTRIBUTE, code.toString());`
`178`	`179`	`if (transport == ApiTracerContext.Transport.HTTP) {`
`179`	`180`	`attributes.put(`
`180`	`181`	`ObservabilityAttributes.HTTP_RESPONSE_STATUS_ATTRIBUTE, (long) code.getHttpStatusCode());`
`181`		`- } else {`
`182`		`- attributes.put(ObservabilityAttributes.RPC_RESPONSE_STATUS_ATTRIBUTE, code.toString());`
`183`	`182`	`}`
`184`	`183`	`}`
`185`	`184`