feat: Add more attributes to metrics.

Author: blakeli0

gax-java/gax/src/main/java/com/google/api/gax/rpc/LibraryMetadata.java

@@ -51,6 +51,9 @@ public abstract class LibraryMetadata {
   @Nullable
   public abstract String artifactName();
 
+  @Nullable
+  public abstract String version();
+
   public static LibraryMetadata empty() {
     return newBuilder().build();
   }
@@ -65,6 +68,8 @@ public abstract static class Builder {
 
     public abstract Builder setArtifactName(@Nullable String artifactName);
 
+    public abstract Builder setVersion(@Nullable String version);
+
     public abstract LibraryMetadata build();
   }
 }

gax-java/gax/src/main/java/com/google/api/gax/tracing/ApiTracerContext.java

@@ -33,9 +33,22 @@
 import com.google.api.core.InternalApi;
 import com.google.api.gax.rpc.LibraryMetadata;
 import com.google.auto.value.AutoValue;
+import org.apache.http.protocol.HTTP;
+
 import java.util.HashMap;
 import java.util.Map;
 import javax.annotation.Nullable;
+//gcp.client.service [consistent across T4 spans]
+//gcp.client.version [consistent across T4 spans]
+//        rpc.system.name (e.g., grpc, http) [consistent across T4 spans]
+//        rpc.response.status_code (for gRPC and HTTP) [from last T4 span]
+//        rpc.method (for gRPC and HTTP) [from the last T4 span]
+//url.domain [consistent across T4 spans]
+//        url.template (for HTTP) [from the first T4 span]
+//        http.response.status_code (for HTTP) [from the last T4 span]
+//server.address [from the last T4 span]
+//server.port [from the last T4 span]
+//        error.type (if the overall T3 operation failed)
 
 /**
  * A context object that contains information used to infer attributes that are common for all
@@ -51,6 +64,15 @@ public abstract class ApiTracerContext {
 
   public abstract LibraryMetadata libraryMetadata();
 
+  @Nullable
+  public abstract String serviceName();
+
+  @Nullable
+  public abstract String urlDomain();
+
+  @Nullable
+  public abstract String urlTemplate();
+
   /**
    * @return a map of attributes to be included in attempt-level spans
    */
@@ -68,6 +90,25 @@ public Map<String, String> getAttemptAttributes() {
     return attributes;
   }
 
+  Map<String, String> getMetricsAttributes() {
+    Map<String, String> attributes = new HashMap<>();
+    if (serverAddress() != null) {
+      attributes.put(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE, serverAddress());
+    }
+    if (serviceName() != null) {
+      attributes.put("gcp.client.service", serviceName());
+    }
+    if (transport() == HTTP) {
+      if (urlDomain() != null) {
+        attributes.put("url.domain", serviceName());
+      }
+      if (serviceName() != null) {
+        attributes.put("url.template", serviceName());
+      }
+    }
+    return attributes;
+  }
+
   public static ApiTracerContext empty() {
     return newBuilder().setLibraryMetadata(LibraryMetadata.empty()).build();
   }

gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalMetricsTracer.java

@@ -47,6 +47,7 @@ class GoldenSignalMetricsTracer implements ApiTracer {
   private final Stopwatch clientRequestTimer = Stopwatch.createStarted();
   private final GoldenSignalsMetricsRecorder metricsRecorder;
   private final Map<String, String> attributes = new HashMap<>();
+  private final ApiTracerContext apiTracerContext;
 
   /**
    * Creates the following instruments for the following metrics:
@@ -55,29 +56,34 @@ class GoldenSignalMetricsTracer implements ApiTracer {
    *   <li>Client Request Duration: Histogram
    * </ul>
    *
-   * @param metricsRecorder OpenTelemetry
+   * @param metricsRecorder  OpenTelemetry
+   * @param apiTracerContext
    */
-  GoldenSignalMetricsTracer(GoldenSignalsMetricsRecorder metricsRecorder) {
+  GoldenSignalMetricsTracer(GoldenSignalsMetricsRecorder metricsRecorder, ApiTracerContext apiTracerContext) {
     this.metricsRecorder = metricsRecorder;
+    this.apiTracerContext = apiTracerContext;
   }
 
   @Override
   public void operationSucceeded() {
     attributes.put(RPC_RESPONSE_STATUS_ATTRIBUTE, StatusCode.Code.OK.toString());
+    attributes.putAll(apiTracerContext.getMetricsAttributes());
     metricsRecorder.recordOperationLatency(
         clientRequestTimer.elapsed(TimeUnit.SECONDS), attributes);
   }
 
   @Override
   public void operationCancelled() {
     attributes.put(RPC_RESPONSE_STATUS_ATTRIBUTE, StatusCode.Code.CANCELLED.toString());
+    attributes.putAll(apiTracerContext.getMetricsAttributes());
     metricsRecorder.recordOperationLatency(
         clientRequestTimer.elapsed(TimeUnit.SECONDS), attributes);
   }
 
   @Override
   public void operationFailed(Throwable error) {
     attributes.put(RPC_RESPONSE_STATUS_ATTRIBUTE, ObservabilityUtils.extractStatus(error));
+    attributes.putAll(apiTracerContext.getMetricsAttributes());
     metricsRecorder.recordOperationLatency(
         clientRequestTimer.elapsed(TimeUnit.SECONDS), attributes);
   }

gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalMetricsTracerFactory.java

@@ -57,7 +57,7 @@ public ApiTracer newTracer(ApiTracer parent, SpanName spanName, OperationType op
       // regular requests.
       return new BaseApiTracer();
     }
-    return new GoldenSignalMetricsTracer(metricsRecorder);
+    return new GoldenSignalMetricsTracer(metricsRecorder, apiTracerContext);
   }
 
   @Override

gax-java/gax/src/test/java/com/google/api/gax/tracing/GoldenSignalMetricsTracerTest.java

@@ -63,7 +63,7 @@ void setUp() {
         OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build();
     tracer =
         new GoldenSignalMetricsTracer(
-            new GoldenSignalsMetricsRecorder(openTelemetry, ARTIFACT_NAME));
+            new GoldenSignalsMetricsRecorder(openTelemetry, ARTIFACT_NAME), ApiTracerContext.empty());
   }
 
   @Test