feat(o11y): introduce server.port attribute

diegomarquezp · diegomarquezp · commit 9e08c8f6e85d · 2026-03-02T17:21:00.000-05:00
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java b/gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java
@@ -273,6 +273,7 @@ public static ClientContext create(StubSettings settings) throws IOException {
     ApiTracerContext apiTracerContext =
         ApiTracerContext.newBuilder()
             .setServerAddress(endpointContext.resolvedServerAddress())
+            .setServerPort(endpointContext.resolvedServerPort())
             .build();
     ApiTracerFactory apiTracerFactory = settings.getTracerFactory().withContext(apiTracerContext);
 
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java b/gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java
@@ -136,6 +136,9 @@ public static EndpointContext getDefaultInstance() {
 
   public abstract String resolvedServerAddress();
 
+  @Nullable
+  public abstract Integer resolvedServerPort();
+
   public abstract Builder toBuilder();
 
   public static Builder newBuilder() {
@@ -233,6 +236,8 @@ public abstract static class Builder {
 
     public abstract Builder setResolvedServerAddress(String serverAddress);
 
+    public abstract Builder setResolvedServerPort(Integer serverPort);
+
     public abstract Builder setResolvedUniverseDomain(String resolvedUniverseDomain);
 
     abstract Builder setUseS2A(boolean useS2A);
@@ -404,6 +409,27 @@ private String parseServerAddress(String endpoint) {
       }
     }
 
+    private Integer parseServerPort(String endpoint) {
+      if (Strings.isNullOrEmpty(endpoint)) {
+        return null;
+      }
+      String hostPort = endpoint;
+      if (hostPort.contains("://")) {
+        // Strip the scheme if present. HostAndPort doesn't support schemes.
+        hostPort = hostPort.substring(hostPort.indexOf("://") + 3);
+      }
+      try {
+        HostAndPort parsedHostPort = HostAndPort.fromString(hostPort);
+        if (parsedHostPort.hasPort()) {
+          return parsedHostPort.getPort();
+        }
+        return null;
+      } catch (IllegalArgumentException e) {
+        // Fallback for cases HostAndPort can't handle.
+        return null;
+      }
+    }
+
     // Default to port 443 for HTTPS. Using HTTP requires explicitly setting the endpoint
     private String buildEndpointTemplate(String serviceName, String resolvedUniverseDomain) {
       return serviceName + "." + resolvedUniverseDomain + ":443";
@@ -441,6 +467,7 @@ public EndpointContext build() throws IOException {
       String endpoint = determineEndpoint();
       setResolvedEndpoint(endpoint);
       setResolvedServerAddress(parseServerAddress(endpoint));
+      setResolvedServerPort(parseServerPort(endpoint));
       setUseS2A(shouldUseS2A());
       return autoBuild();
     }
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/ApiTracerContext.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/ApiTracerContext.java
@@ -49,17 +49,23 @@ public abstract class ApiTracerContext {
   /**
    * @return a map of attributes to be included in attempt-level spans
    */
-  public Map<String, String> getAttemptAttributes() {
-    Map<String, String> attributes = new HashMap<>();
+  public Map<String, Object> getAttemptAttributes() {
+    Map<String, Object> attributes = new HashMap<>();
     if (getServerAddress() != null) {
       attributes.put(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE, getServerAddress());
     }
+    if (getServerPort() != null) {
+      attributes.put(ObservabilityAttributes.SERVER_PORT_ATTRIBUTE, getServerPort());
+    }
     return attributes;
   }
 
   @Nullable
   public abstract String getServerAddress();
 
+  @Nullable
+  public abstract Integer getServerPort();
+
   public static Builder newBuilder() {
     return new AutoValue_ApiTracerContext.Builder();
   }
@@ -68,6 +74,8 @@ public static Builder newBuilder() {
   public abstract static class Builder {
     public abstract Builder setServerAddress(String serverAddress);
 
+    public abstract Builder setServerPort(Integer serverPort);
+
     public abstract ApiTracerContext build();
   }
 }
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/ObservabilityAttributes.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/ObservabilityAttributes.java
@@ -43,4 +43,7 @@
 public class ObservabilityAttributes {
   /** The address of the server being called (e.g., "pubsub.googleapis.com"). */
   public static final String SERVER_ADDRESS_ATTRIBUTE = "server.address";
+
+  /** The port of the server being called (e.g., 443). */
+  public static final String SERVER_PORT_ATTRIBUTE = "server.port";
 }
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryTraceManager.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryTraceManager.java
@@ -51,14 +51,21 @@ public OpenTelemetryTraceManager(OpenTelemetry openTelemetry) {
   }
 
   @Override
-  public Span createSpan(String name, Map<String, String> attributes) {
+  public Span createSpan(String name, Map<String, Object> attributes) {
     SpanBuilder spanBuilder = tracer.spanBuilder(name);
 
     // Attempt spans are of the CLIENT kind
     spanBuilder.setSpanKind(SpanKind.CLIENT);
 
     if (attributes != null) {
-      attributes.forEach((k, v) -> spanBuilder.setAttribute(k, v));
+      attributes.forEach(
+          (k, v) -> {
+            if (v instanceof String) {
+              spanBuilder.setAttribute(k, (String) v);
+            } else if (v instanceof Integer) {
+              spanBuilder.setAttribute(k, (long) (Integer) v);
+            }
+          });
     }
 
     io.opentelemetry.api.trace.Span span = spanBuilder.startSpan();
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java
@@ -48,7 +48,7 @@ public class SpanTracer implements ApiTracer {
   public static final String DEFAULT_LANGUAGE = "Java";
 
   private final TraceManager traceManager;
-  private final Map<String, String> attemptAttributes;
+  private final Map<String, Object> attemptAttributes;
   private final String attemptSpanName;
   private final ApiTracerContext apiTracerContext;
   private TraceManager.Span attemptHandle;
@@ -75,7 +75,7 @@ private void buildAttributes() {
 
   @Override
   public void attemptStarted(Object request, int attemptNumber) {
-    Map<String, String> attemptAttributes = new HashMap<>(this.attemptAttributes);
+    Map<String, Object> attemptAttributes = new HashMap<>(this.attemptAttributes);
     // Start the specific attempt span with the operation span as parent
     this.attemptHandle = traceManager.createSpan(attemptSpanName, attemptAttributes);
   }
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/TraceManager.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/TraceManager.java
@@ -42,7 +42,7 @@
 @InternalApi
 public interface TraceManager {
   /** Starts a span and returns a handle to manage its lifecycle. */
-  Span createSpan(String name, Map<String, String> attributes);
+  Span createSpan(String name, Map<String, Object> attributes);
 
   interface Span {
     void end();
diff --git a/gax-java/gax/src/test/java/com/google/api/gax/rpc/EndpointContextTest.java b/gax-java/gax/src/test/java/com/google/api/gax/rpc/EndpointContextTest.java
@@ -603,6 +603,7 @@ void endpointContextBuild_resolvesPortAndServerAddress() throws IOException {
             .setTransportChannelProviderEndpoint(null)
             .build();
     Truth.assertThat(endpointContext.resolvedServerAddress()).isEqualTo("localhost");
+    Truth.assertThat(endpointContext.resolvedServerPort()).isEqualTo(7469);
 
     endpoint = "localhost:7469";
     endpointContext =
@@ -611,6 +612,7 @@ void endpointContextBuild_resolvesPortAndServerAddress() throws IOException {
             .setTransportChannelProviderEndpoint(null)
             .build();
     Truth.assertThat(endpointContext.resolvedServerAddress()).isEqualTo("localhost");
+    Truth.assertThat(endpointContext.resolvedServerPort()).isEqualTo(7469);
 
     endpoint = "test.googleapis.com:443";
     endpointContext =
@@ -619,6 +621,7 @@ void endpointContextBuild_resolvesPortAndServerAddress() throws IOException {
             .setTransportChannelProviderEndpoint(null)
             .build();
     Truth.assertThat(endpointContext.resolvedServerAddress()).isEqualTo("test.googleapis.com");
+    Truth.assertThat(endpointContext.resolvedServerPort()).isEqualTo(443);
 
     // IPv6 literal with port
     endpoint = "[2001:db8::1]:443";
@@ -628,6 +631,7 @@ void endpointContextBuild_resolvesPortAndServerAddress() throws IOException {
             .setTransportChannelProviderEndpoint(null)
             .build();
     Truth.assertThat(endpointContext.resolvedServerAddress()).isEqualTo("2001:db8::1");
+    Truth.assertThat(endpointContext.resolvedServerPort()).isEqualTo(443);
 
     // Bare IPv6 literal (no port)
     endpoint = "2001:db8::1";
@@ -637,5 +641,6 @@ void endpointContextBuild_resolvesPortAndServerAddress() throws IOException {
             .setTransportChannelProviderEndpoint(null)
             .build();
     Truth.assertThat(endpointContext.resolvedServerAddress()).isEqualTo("2001:db8::1");
+    Truth.assertThat(endpointContext.resolvedServerPort()).isNull();
   }
 }
diff --git a/gax-java/gax/src/test/java/com/google/api/gax/tracing/OpenTelemetryTraceManagerTest.java b/gax-java/gax/src/test/java/com/google/api/gax/tracing/OpenTelemetryTraceManagerTest.java
@@ -90,7 +90,7 @@ void testCreateSpan_attempt_isClient() {
   @Test
   void testCreateSpan_recordsSpan() {
     String spanName = "test-span";
-    Map<String, String> attributes = ImmutableMap.of("key1", "value1");
+    Map<String, Object> attributes = ImmutableMap.of("key1", "value1");
 
     when(tracer.spanBuilder(spanName)).thenReturn(spanBuilder);
     when(spanBuilder.setSpanKind(SpanKind.CLIENT)).thenReturn(spanBuilder);
diff --git a/gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerFactoryTest.java b/gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerFactoryTest.java
@@ -72,10 +72,10 @@ void testNewTracer_addsAttributes() {
 
     tracer.attemptStarted(null, 1);
 
-    ArgumentCaptor<Map<String, String>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
+    ArgumentCaptor<Map<String, Object>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
     verify(recorder, atLeastOnce()).createSpan(anyString(), attributesCaptor.capture());
 
-    Map<String, String> attemptAttributes = attributesCaptor.getValue();
+    Map<String, Object> attemptAttributes = attributesCaptor.getValue();
     assertThat(attemptAttributes).containsEntry("server.address", "test-address");
   }
 
@@ -97,10 +97,10 @@ void testWithContext_addsInferredAttributes() {
 
     tracer.attemptStarted(null, 1);
 
-    ArgumentCaptor<Map<String, String>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
+    ArgumentCaptor<Map<String, Object>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
     verify(recorder, atLeastOnce()).createSpan(anyString(), attributesCaptor.capture());
 
-    Map<String, String> attemptAttributes = attributesCaptor.getValue();
+    Map<String, Object> attemptAttributes = attributesCaptor.getValue();
     assertThat(attemptAttributes)
         .containsEntry(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE, "example.com");
   }
@@ -122,10 +122,10 @@ void testWithContext_noEndpointContext_doesNotAddAttributes() {
 
     tracer.attemptStarted(null, 1);
 
-    ArgumentCaptor<Map<String, String>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
+    ArgumentCaptor<Map<String, Object>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
     verify(recorder, atLeastOnce()).createSpan(anyString(), attributesCaptor.capture());
 
-    Map<String, String> attemptAttributes = attributesCaptor.getValue();
+    Map<String, Object> attemptAttributes = attributesCaptor.getValue();
     assertThat(attemptAttributes)
         .doesNotContainKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE);
   }
diff --git a/gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerTest.java b/gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerTest.java
@@ -70,7 +70,7 @@ void testAttemptStarted_includesLanguageAttribute() {
 
     tracer.attemptStarted(new Object(), 1);
 
-    ArgumentCaptor<Map<String, String>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
+    ArgumentCaptor<Map<String, Object>> attributesCaptor = ArgumentCaptor.forClass(Map.class);
     verify(recorder).createSpan(eq(ATTEMPT_SPAN_NAME), attributesCaptor.capture());
 
     assertThat(attributesCaptor.getValue())
diff --git a/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracing.java b/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracing.java
@@ -54,6 +54,7 @@
 
 class ITOtelTracing {
   private static final String SHOWCASE_SERVER_ADDRESS = "localhost";
+  private static final long SHOWCASE_SERVER_PORT = 7469;
 
   private InMemorySpanExporter spanExporter;
   private OpenTelemetrySdk openTelemetrySdk;
@@ -108,6 +109,11 @@ void testTracing_successfulEcho_grpc() throws Exception {
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE)))
           .isEqualTo(SHOWCASE_SERVER_ADDRESS);
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.longKey(ObservabilityAttributes.SERVER_PORT_ATTRIBUTE)))
+          .isEqualTo(SHOWCASE_SERVER_PORT);
     }
   }
 
@@ -140,6 +146,11 @@ void testTracing_successfulEcho_httpjson() throws Exception {
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE)))
           .isEqualTo(SHOWCASE_SERVER_ADDRESS);
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(AttributeKey.longKey(ObservabilityAttributes.SERVER_PORT_ATTRIBUTE)))
+          .isEqualTo(SHOWCASE_SERVER_PORT);
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,7 @@`
`43`	`43`	`public class ObservabilityAttributes {`
`44`	`44`	`/** The address of the server being called (e.g., "pubsub.googleapis.com"). */`
`45`	`45`	`public static final String SERVER_ADDRESS_ATTRIBUTE = "server.address";`
	`46`	`+`
	`47`	`+ /** The port of the server being called (e.g., 443). */`
	`48`	`+ public static final String SERVER_PORT_ATTRIBUTE = "server.port";`
`46`	`49`	`}`