feat: Metrics tracer addAttribute map overload (#3202)

surbhigarg92 · blakeli0 · web-flow · commit 1a988df22f7e · 2024-09-16T15:59:10.000-04:00
This PR adds an overload for adding multiple attributes at once. 

Earlier the client had to call the `addAttributes` method in a loop to
add each attributes. Below overload takes a map and add all the
attributes at once

```
public void addAttributes(Map&lt;String, String&gt; attributes) {
    this.attributes.putAll(attributes);
  };
 ```

---------

Co-authored-by: Blake Li &lt;blakeli@google.com&gt;
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java
@@ -245,6 +245,15 @@ public void addAttributes(String key, String value) {
     attributes.put(key, value);
   };
 
+  /**
+   * Add attributes that will be attached to all metrics. This is expected to be called by
+   * handwritten client teams to add additional attributes that are not supposed be collected by
+   * Gax.
+   */
+  public void addAttributes(Map<String, String> attributes) {
+    this.attributes.putAll(attributes);
+  };
+
   @VisibleForTesting
   Map<String, String> getAttributes() {
     return attributes;
diff --git a/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerTest.java b/gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerTest.java
@@ -43,6 +43,7 @@
 import com.google.api.gax.rpc.StatusCode.Code;
 import com.google.api.gax.rpc.testing.FakeStatusCode;
 import com.google.common.collect.ImmutableMap;
+import java.util.HashMap;
 import java.util.Map;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -228,6 +229,16 @@ void testAddAttributes_recordsAttributes() {
     assertThat(metricsTracer.getAttributes().get("FakeTableId")).isEqualTo("12345");
   }
 
+  @Test
+  void testAddAttributes_recordsAttributesWithMap() {
+    Map<String, String> attributes = new HashMap<>();
+    attributes.put("FakeTableId", "12345");
+    attributes.put("FakeInstanceId", "67890");
+    metricsTracer.addAttributes(attributes);
+    assertThat(metricsTracer.getAttributes().get("FakeTableId")).isEqualTo("12345");
+    assertThat(metricsTracer.getAttributes().get("FakeInstanceId")).isEqualTo("67890");
+  }
+
   @Test
   void testExtractStatus_errorConversion_apiExceptions() {
     ApiException error =
