chore: tracing implementation in GAPICs POC #4094

diegomarquezp · 2026-01-30T21:44:10Z

I decided to enforce this input.

diegomarquezp · 2026-01-29T19:51:31Z

This logic would likely be better in the tracer factory constructor.

blakeli0 · 2026-02-04T19:27:57Z

It would be great if we can get these without exposing new public methods, but we can think about it later.

-Original file line number
+Diff line change
@@ Expand Up / @@ -30,7 +30,7 @@ RUN cat /java-formatter-version @@
     RUN V=$(cat /java-formatter-version) && curl -o "/google-java-format.jar" "https://maven-central.storage-download.googleapis.com/maven2/com/google/googlejavaformat/google-java-format/${V}/google-java-format-${V}-all-deps.jar"
     # Compile and install packages
-    RUN mvn install -B -ntp -DskipTests -Dclirr.skip -Dcheckstyle.skip
+    RUN mvn install -B -ntp -T 1.5C -DskipTests -Dcheckstyle.skip -Dclirr.skip -Denforcer.skip -Dfmt.skip
     RUN cp "/root/.m2/repository/com/google/api/gapic-generator-java/${DOCKER_GAPIC_GENERATOR_VERSION}/gapic-generator-java-${DOCKER_GAPIC_GENERATOR_VERSION}.jar" \
       "./gapic-generator-java.jar"
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -95,11 +95,14 @@ static GapicMetadata defaultGapicMetadata() { @@
       public abstract Transport transport();
+      public abstract Optional<String> repo();
       public static Builder builder() {
         return new AutoValue_GapicContext.Builder()
             .setMixinServices(Collections.emptyList())
             .setGapicMetadataEnabled(false)
-            .setRestNumericEnumsEnabled(false);
+            .setRestNumericEnumsEnabled(false)
+            .setRepo(Optional.empty());
       }
       @AutoValue.Builder
@@ Expand Down Expand Up @@
         public abstract Builder setTransport(Transport transport);
+        public abstract Builder setRepo(Optional<String> repo);
         abstract ImmutableMap<String, ResourceName> resourceNames();
         abstract ImmutableMap<String, ResourceName> helperResourceNames();
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up @@
         Optional<GapicLanguageSettings> languageSettingsOpt =
             GapicLanguageSettingsParser.parse(gapicYamlConfigPathOpt);
         Optional<String> transportOpt = PluginArgumentParser.parseTransport(request);
+        Optional<String> repo = PluginArgumentParser.parseRepo(request);
         boolean willGenerateMetadata = PluginArgumentParser.hasMetadataFlag(request);
         boolean willGenerateNumericEnum = PluginArgumentParser.hasNumericEnumFlag(request);
@@ Expand Down Expand Up @@
             .setServiceYamlProto(serviceYamlProtoOpt.orElse(null))
             .setTransport(transport)
             .setRestNumericEnumsEnabled(willGenerateNumericEnum)
+            .setRepo(repo)
             .build();
       }
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -32,6 +32,7 @@ public class PluginArgumentParser { @@
       @VisibleForTesting static final String KEY_NUMERIC_ENUM = "rest-numeric-enums";
       @VisibleForTesting static final String KEY_SERVICE_YAML_CONFIG = "api-service-config";
       @VisibleForTesting static final String KEY_TRANSPORT = "transport";
+      @VisibleForTesting static final String KEY_REPO = "repo";
       private static final String JSON_FILE_ENDING = "grpc_service_config.json";
       private static final String GAPIC_YAML_FILE_ENDING = "gapic.yaml";
@@ Expand All @@
         return parseConfigArgument(request.getParameter(), KEY_TRANSPORT);
       }
+      static Optional<String> parseRepo(CodeGeneratorRequest request) {
+        return parseConfigArgument(request.getParameter(), KEY_REPO);
+      }
       static boolean hasMetadataFlag(CodeGeneratorRequest request) {
         return hasFlag(request.getParameter(), KEY_METADATA);
       }
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -71,6 +71,7 @@ protected static CodeGeneratorResponse write( @@
         writeMetadataFile(context, writePackageInfo(gapicPackageInfo, codeWriter, jos), jos);
         writeReflectConfigFile(gapicPackageInfo.packageInfo().pakkage(), reflectConfigInfo, jos);
+        writeGapicPropertiesFile(context, jos);
         jos.finish();
         jos.flush();
@@ Expand Down Expand Up @@
         }
       }
+      @VisibleForTesting
+      static void writeGapicPropertiesFile(GapicContext context, JarOutputStream jos) {
+        context
+            .repo()
+            .ifPresent(
+                repo -> {
+                  JarEntry jarEntry = new JarEntry("src/main/resources/gapic.properties");
+                  try {
+                    jos.putNextEntry(jarEntry);
+                    jos.write(String.format("repo=%s\n", repo).getBytes(StandardCharsets.UTF_8));
+                  } catch (IOException e) {
+                    throw new GapicWriterException("Could not write repo file", e);
+                  }
+                });
+      }
       private static String getPath(String pakkage, String className) {
         String path = pakkage.replaceAll("\\.", "/");
         if (className.startsWith("Mock") || className.endsWith("Test")) {
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: tracing implementation in GAPICs POC #4094

Uh oh!

Diff view

Diff view

There are no files selected for viewing

diegomarquezp Jan 30, 2026

Uh oh!

diegomarquezp Jan 29, 2026

Uh oh!

blakeli0 Feb 4, 2026

Uh oh!

Uh oh!

Uh oh!

-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ @@
     import static com.google.api.generator.gapic.protoparser.PluginArgumentParser.KEY_METADATA;
     import static com.google.api.generator.gapic.protoparser.PluginArgumentParser.KEY_NUMERIC_ENUM;
+    import static com.google.api.generator.gapic.protoparser.PluginArgumentParser.KEY_REPO;
     import static org.junit.Assert.assertEquals;
     import static org.junit.Assert.assertFalse;
     import static org.junit.Assert.assertTrue;
@@ Expand Down Expand Up / @@ -269,6 +270,21 @@ void hasFlag_flagFound() { @@
         assertTrue(PluginArgumentParser.hasFlag(rawArgument, KEY_METADATA));
       }
+      @Test
+      void parseRepo_onlyOnePresent() {
+        String repo = "googleapis/sdk-platform-java";
+        CodeGeneratorRequest request =
+            CodeGeneratorRequest.newBuilder().setParameter(createRepo(repo)).build();
+        assertEquals(repo, PluginArgumentParser.parseRepo(request).get());
+      }
+      @Test
+      void parseRepo_noneFound() {
+        CodeGeneratorRequest request =
+            CodeGeneratorRequest.newBuilder().setParameter("metadata").build();
+        assertFalse(PluginArgumentParser.parseRepo(request).isPresent());
+      }
       private static String createGrpcServiceConfig(String path) {
         return String.format("%s=%s", PluginArgumentParser.KEY_GRPC_SERVICE_CONFIG, path);
       }
@@ Expand All / @@ -280,4 +296,8 @@ private static String createGapicConfig(String path) { @@
       private static String createServiceConfig(String path) {
         return String.format("%s=%s", PluginArgumentParser.KEY_SERVICE_YAML_CONFIG, path);
       }
+      private static String createRepo(String repo) {
+        return String.format("%s=%s", KEY_REPO, repo);
+      }
     }

-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ @@
     import com.google.gson.Gson;
     import com.google.protobuf.ByteString;
     import com.google.protobuf.compiler.PluginProtos.CodeGeneratorResponse;
+    import java.io.BufferedReader;
     import java.io.File;
     import java.io.IOException;
     import java.io.InputStreamReader;
@@ Expand All / @@ -25,6 +26,7 @@ @@
     import java.util.Collections;
     import java.util.Enumeration;
     import java.util.List;
+    import java.util.Optional;
     import java.util.jar.JarEntry;
     import java.util.jar.JarFile;
     import java.util.jar.JarOutputStream;
@@ Expand Down Expand Up @@
                 "temp-codegen.srcjar");
         assertNull(result);
       }
+      @Test
+      void writeRepoFile_isWritten() throws IOException {
+        String repo = "googleapis/sdk-platform-java";
+        GapicContext context = GapicContext.EMPTY.toBuilder().setRepo(Optional.of(repo)).build();
+        Writer.writeGapicPropertiesFile(context, jarOutputStream);
+        closeJarOutputStream();
+        try (JarFile jarFile = new JarFile(file)) {
+          Enumeration<JarEntry> entries = jarFile.entries();
+          assertThat(entries.hasMoreElements()).isTrue();
+          JarEntry entry = entries.nextElement();
+          assertThat(entries.hasMoreElements()).isFalse();
+          assertEquals("src/main/resources/gapic.properties", entry.getName());
+          try (BufferedReader reader =
+              new BufferedReader(new InputStreamReader(jarFile.getInputStream(entry)))) {
+            String line = reader.readLine();
+            assertEquals("repo=" + repo, line);
+          }
+        }
+      }
     }

-Original file line number
+Diff line change
@@ Expand Up @@
     maven.com_google_auth_google_auth_library_oauth2_http=com.google.auth:google-auth-library-oauth2-http:1.42.1
     maven.com_google_auth_google_auth_library_credentials=com.google.auth:google-auth-library-credentials:1.42.1
     maven.io_opentelemetry_opentelemetry_api=io.opentelemetry:opentelemetry-api:1.47.0
+    maven.io_opentelemetry_opentelemetry_context=io.opentelemetry:opentelemetry-context:1.47.0
     maven.io_opencensus_opencensus_api=io.opencensus:opencensus-api:0.31.1
     maven.io_opencensus_opencensus_contrib_grpc_metrics=io.opencensus:opencensus-contrib-grpc-metrics:0.31.1
     maven.io_opencensus_opencensus_contrib_http_util=io.opencensus:opencensus-contrib-http-util:0.31.1
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -19,6 +19,7 @@ _COMPILE_DEPS = [ @@
         "@com_google_errorprone_error_prone_annotations//jar",
         "@com_google_guava_guava//jar",
         "@io_opentelemetry_opentelemetry_api//jar",
+        "@io_opentelemetry_opentelemetry_context//jar",
         "@io_opencensus_opencensus_api//jar",
         "@io_opencensus_opencensus_contrib_http_util//jar",
         "@io_grpc_grpc_java//context:context",
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -43,6 +43,7 @@ @@
     import com.google.api.gax.rpc.internal.QuotaProjectIdHidingCredentials;
     import com.google.api.gax.tracing.ApiTracerFactory;
     import com.google.api.gax.tracing.BaseApiTracerFactory;
+    import com.google.api.gax.tracing.OpenTelemetryTracingTracer;
     import com.google.auth.ApiKeyCredentials;
     import com.google.auth.CredentialTypeForMetrics;
     import com.google.auth.Credentials;
@@ Expand Down Expand Up @@
           backgroundResources.add(watchdog);
         }
+        ApiTracerFactory tracerFactory = settings.getTracerFactory();
+        if (tracerFactory != null) {
+          String rpcSystem = "";
+          if ("grpc".equals(transportChannel.getTransportName())) {
+            rpcSystem = "grpc";
+          } else if ("httpjson".equals(transportChannel.getTransportName())) {
+            rpcSystem = "http";
+          }
+          tracerFactory =
+              tracerFactory.withAttributes(
+                  ImmutableMap.of(),
+                  ImmutableMap.of(
+                      OpenTelemetryTracingTracer.SERVER_ADDRESS_ATTRIBUTE, settings.getServerAddress(),
+                      OpenTelemetryTracingTracer.SERVICE_NAME_ATTRIBUTE, settings.getServiceName(),
+                      OpenTelemetryTracingTracer.PORT_ATTRIBUTE, String.valueOf(settings.getPort()),
+                      OpenTelemetryTracingTracer.RPC_SYSTEM_ATTRIBUTE, rpcSystem));
+        }
         return newBuilder()
             .setBackgroundResources(backgroundResources.build())
             .setExecutor(backgroundExecutor)
@@ Expand All @@
             .setQuotaProjectId(settings.getQuotaProjectId())
             .setStreamWatchdog(watchdog)
             .setStreamWatchdogCheckIntervalDuration(settings.getStreamWatchdogCheckIntervalDuration())
-            .setTracerFactory(settings.getTracerFactory())
+            .setTracerFactory(tracerFactory)
             .setEndpointContext(endpointContext)
             .build();
       }
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -105,6 +105,13 @@ public final String getEndpoint() { @@
         return stubSettings.getEndpoint();
       }
+      /**
+       * @return the fully resolved port used by the client
+       */
+      public final int getPort() {
+        return stubSettings.getPort();
+      }
       public final String getQuotaProjectId() {
         return stubSettings.getQuotaProjectId();
       }
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -133,6 +133,10 @@ public static EndpointContext getDefaultInstance() { @@
       public abstract String resolvedEndpoint();
+      public abstract int resolvedPort();
+      public abstract String resolvedServerAddress();
       public abstract Builder toBuilder();
       public static Builder newBuilder() {
@@ Expand Down Expand Up / @@ -228,6 +232,10 @@ public abstract static class Builder { @@
         public abstract Builder setResolvedEndpoint(String resolvedEndpoint);
+        public abstract Builder setResolvedPort(int resolvedPort);
+        public abstract Builder setResolvedServerAddress(String resolvedServerAddress);
         public abstract Builder setResolvedUniverseDomain(String resolvedUniverseDomain);
         abstract Builder setUseS2A(boolean useS2A);
@@ Expand Down Expand Up / @@ -413,10 +421,37 @@ String mtlsEndpointResolver( @@
           return endpoint;
         }
+        private String parseServerAddress(String endpoint) {
+          int colonPortIndex = endpoint.lastIndexOf(':');
+          int doubleSlashIndex = endpoint.lastIndexOf("//");
+          if (colonPortIndex == -1) {
+            return endpoint;
+          }
+          if (doubleSlashIndex != -1 && doubleSlashIndex < colonPortIndex) {
+            return endpoint.substring(doubleSlashIndex + 2, colonPortIndex);
+          }
+          return endpoint.substring(0, colonPortIndex);
+        }
+        private int parsePort(String endpoint) {
+          int colonIndex = endpoint.lastIndexOf(':');
+          if (colonIndex != -1) {
+            try {
+              return Integer.parseInt(endpoint.substring(colonIndex + 1));
+            } catch (NumberFormatException e) {
+              // Fallback to default if parsing fails
+            }
+          }
+          return 443;
+        }
         public EndpointContext build() throws IOException {
           // The Universe Domain is used to resolve the Endpoint. It should be resolved first
           setResolvedUniverseDomain(determineUniverseDomain());
-          setResolvedEndpoint(determineEndpoint());
+          String endpoint = determineEndpoint();
+          setResolvedEndpoint(endpoint);
+          setResolvedServerAddress(parseServerAddress(endpoint));
+          setResolvedPort(parsePort(endpoint));
           setUseS2A(shouldUseS2A());
           return autoBuild();
         }
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -190,6 +190,20 @@ public String getEndpoint() { @@
         return endpointContext.resolvedEndpoint();
       }
+      /**
+       * @return the fully resolved port used by the client
+       */
+      public final int getPort() {
+        return endpointContext.resolvedPort();
+      }
+      /**
+       * @return the fully resolved server address used by the client
+       */
+      public final String getServerAddress() {
+        return endpointContext.resolvedServerAddress();
+      }
       /**
        * @return the newly created EndpointContext
        */
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -31,6 +31,7 @@ @@
     import com.google.api.core.InternalApi;
     import com.google.api.core.InternalExtensionOnly;
+    import java.util.Map;
     /**
      * A factory to create new instances of {@link ApiTracer}s.
@@ Expand Down Expand Up / @@ -61,4 +62,16 @@ enum OperationType { @@
        * @param operationType the type of operation that the tracer will trace
        */
       ApiTracer newTracer(ApiTracer parent, SpanName spanName, OperationType operationType);
+      /**
+       * Returns a new {@link ApiTracerFactory} that will add the given attributes to all tracers
+       * created by the factory.
+       *
+       * @param operationAttributes the operation attributes to add to all tracers
+       * @param attemptAttributes the attempt attributes to add to all tracers
+       */
+      default ApiTracerFactory withAttributes(
+          Map<String, String> operationAttributes, Map<String, String> attemptAttributes) {
+        return this;
+      }
     }

chore: tracing implementation in GAPICs POC #4094

Are you sure you want to change the base?

Uh oh!

chore: tracing implementation in GAPICs POC #4094

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

diegomarquezp Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

diegomarquezp Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

blakeli0 Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!