Feat: client side metrics testing

google-cloud-firestore/clirr-ignored-differences.xml

@@ -331,7 +331,7 @@
     <differenceType>7009</differenceType>
     <method>void internalStream(*)</method>
   </difference>
-  
+
   <!-- Relocate constants in TraceUtil -->
   <difference>
     <differenceType>6011</differenceType>
@@ -346,4 +346,38 @@
     <method>void internalStream(*)</method>
     <to>*</to>
   </difference>
+
+    <!-- Update TelemetryConstants -->
+  <difference>
+    <differenceType>6011</differenceType>
+    <className>com/google/cloud/firestore/telemetry/TelemetryConstants</className>
+    <field>*</field>
+  </difference>
+
+    <difference>
+    <differenceType>6001</differenceType>
+    <className>com/google/cloud/firestore/telemetry/TelemetryConstants</className>
+    <field>*</field>
+  </difference>
+
+  <difference>
+    <differenceType>6004</differenceType>
+    <className>com/google/cloud/firestore/telemetry/TelemetryConstants</className>
+    <field>METRIC_ATTRIBUTE_KEY_*</field>
+    <from>io.opentelemetry.api.common.AttributeKey</from>
+    <to>java.lang.String</to>
+  </difference>
+
+  <difference>
+    <differenceType>6001</differenceType>
+    <className>com/google/cloud/firestore/telemetry/TelemetryConstants$MetricType</className>
+    <field>END_TO_END_LATENCY</field>
+  </difference>
+
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/firestore/telemetry/MetricsUtil</className>
+    <method>void shutdown()</method>
+  </difference>
+
 </differences>

google-cloud-firestore/pom.xml

@@ -18,6 +18,18 @@
     <site.installationModule>google-cloud-firestore</site.installationModule>
     <opentelemetry.version>1.49.0</opentelemetry.version>
   </properties>
+
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>io.opentelemetry</groupId>
+        <artifactId>opentelemetry-bom</artifactId>
+        <version>1.49.0</version> <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
   <dependencies>
     <dependency>
       <groupId>${project.groupId}</groupId>
@@ -137,6 +149,14 @@
         </exclusion>
       </exclusions>
     </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-common</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.google.cloud.opentelemetry</groupId>
+      <artifactId>detector-resources-support</artifactId>
+    </dependency>
     <!-- END OpenTelemetry -->
 
     <!-- Test dependencies -->
@@ -156,6 +176,12 @@
       <version>4.11.0</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.github.stefanbirkner</groupId>
+      <artifactId>system-lambda</artifactId>
+      <scope>test</scope>
+      <version>1.2.1</version>
+    </dependency>
     <!-- Need testing utility classes for generated gRPC clients tests -->
     <dependency>
       <groupId>com.google.api</groupId>
@@ -211,12 +237,6 @@
       <version>${opentelemetry.version}</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>io.opentelemetry</groupId>
-      <artifactId>opentelemetry-sdk-common</artifactId>
-      <version>${opentelemetry.version}</version>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>com.google.cloud.opentelemetry</groupId>
       <artifactId>exporter-trace</artifactId>
@@ -237,6 +257,18 @@
       <version>2.62.0</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.google.api.grpc</groupId>
+      <artifactId>proto-google-cloud-monitoring-v3</artifactId>
+      <version>3.55.0</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-monitoring</artifactId>
+      <version>3.55.0</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>com.google.http-client</groupId>
       <artifactId>google-http-client</artifactId>
@@ -317,6 +349,18 @@
           <artifactId>javax.annotation-api</artifactId>
         </dependency>
       </dependencies>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <version>3.1.2</version>
+            <configuration>
+              <argLine>--add-opens java.base/java.util=ALL-UNNAMED</argLine>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
     </profile>
     <profile>
       <!-- JDK17 set up for tests in src/test-jdk17 -->

google-cloud-firestore/src/main/java/com/google/cloud/firestore/AggregateQuery.java

@@ -16,7 +16,6 @@
 
 package com.google.cloud.firestore;
 
-import static com.google.cloud.firestore.telemetry.TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY;
 import static com.google.cloud.firestore.telemetry.TraceUtil.ATTRIBUTE_KEY_ATTEMPT;
 
 import com.google.api.core.ApiFuture;
@@ -29,7 +28,6 @@
 import com.google.cloud.Timestamp;
 import com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext;
 import com.google.cloud.firestore.telemetry.TelemetryConstants;
-import com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType;
 import com.google.cloud.firestore.telemetry.TraceUtil;
 import com.google.cloud.firestore.telemetry.TraceUtil.Scope;
 import com.google.cloud.firestore.v1.FirestoreSettings;
@@ -108,7 +106,7 @@ public ApiFuture<ExplainResults<AggregateQuerySnapshot>> explain(ExplainOptions
         getTraceUtil().startSpan(TelemetryConstants.METHOD_NAME_AGGREGATION_QUERY_GET);
 
     MetricsContext metricsContext =
-        createMetricsContext(TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY_EXPLAIN);
+        createMetricsContext(TelemetryConstants.METHOD_NAME_AGGREGATION_QUERY_EXPLAIN);
 
     try (Scope ignored = span.makeCurrent()) {
       AggregateQueryExplainResponseDeliverer responseDeliverer =
@@ -141,8 +139,8 @@ ApiFuture<AggregateQuerySnapshot> get(
     MetricsContext metricsContext =
         createMetricsContext(
             transactionId == null
-                ? TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY_GET
-                : TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY_TRANSACTIONAL);
+                ? TelemetryConstants.METHOD_NAME_AGGREGATION_QUERY_GET
+                : TelemetryConstants.METHOD_NAME_TRANSACTION_GET_AGGREGATION_QUERY);
 
     try (Scope ignored = span.makeCurrent()) {
       AggregateQueryResponseDeliverer responseDeliverer =
@@ -224,12 +222,11 @@ ApiFuture<T> getFuture() {
     }
 
     void deliverFirstResponse() {
-      metricsContext.recordLatency(MetricType.FIRST_RESPONSE_LATENCY);
+      metricsContext.recordLatency(TelemetryConstants.MetricType.FIRST_RESPONSE_LATENCY);
     }
 
     void deliverError(Throwable throwable) {
       future.setException(throwable);
-      metricsContext.recordLatency(MetricType.END_TO_END_LATENCY, throwable);
     }
 
     void deliverResult(
@@ -239,7 +236,6 @@ void deliverResult(
       try {
         T result = processResult(serverData, readTime, metrics);
         future.set(result);
-        metricsContext.recordLatency(MetricType.END_TO_END_LATENCY);
       } catch (Exception error) {
         deliverError(error);
       }
@@ -341,7 +337,9 @@ private boolean isExplainQuery() {
     public void onStart(StreamController streamController) {
       getTraceUtil()
           .currentSpan()
-          .addEvent(METHOD_NAME_RUN_AGGREGATION_QUERY + " Stream started.", getAttemptAttributes());
+          .addEvent(
+              TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY + " Stream started.",
+              getAttemptAttributes());
     }
 
     @Override
@@ -354,7 +352,8 @@ public void onResponse(RunAggregationQueryResponse response) {
       getTraceUtil()
           .currentSpan()
           .addEvent(
-              METHOD_NAME_RUN_AGGREGATION_QUERY + " Response Received.", getAttemptAttributes());
+              TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY + " Response Received.",
+              getAttemptAttributes());
       if (response.hasReadTime()) {
         readTime = Timestamp.fromProto(response.getReadTime());
       }
@@ -383,15 +382,15 @@ public void onError(Throwable throwable) {
         getTraceUtil()
             .currentSpan()
             .addEvent(
-                METHOD_NAME_RUN_AGGREGATION_QUERY + ": Retryable Error",
+                TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY + ": Retryable Error",
                 Collections.singletonMap("error.message", throwable.toString()));
 
         runQuery(responseDeliverer, attempt + 1);
       } else {
         getTraceUtil()
             .currentSpan()
             .addEvent(
-                METHOD_NAME_RUN_AGGREGATION_QUERY + ": Error",
+                TelemetryConstants.METHOD_NAME_RUN_AGGREGATION_QUERY + ": Error",
                 Collections.singletonMap("error.message", throwable.toString()));
         responseDeliverer.deliverError(throwable);
       }

google-cloud-firestore/src/main/java/com/google/cloud/firestore/BulkWriter.java

@@ -26,9 +26,7 @@
 import com.google.api.core.SettableApiFuture;
 import com.google.api.gax.rpc.ApiException;
 import com.google.api.gax.rpc.StatusCode.Code;
-import com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext;
 import com.google.cloud.firestore.telemetry.TelemetryConstants;
-import com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType;
 import com.google.cloud.firestore.telemetry.TraceUtil;
 import com.google.cloud.firestore.telemetry.TraceUtil.Context;
 import com.google.cloud.firestore.telemetry.TraceUtil.Scope;
@@ -919,12 +917,6 @@ private void sendBatchLocked(final BulkCommitBatch batch) {
               .startSpan(TelemetryConstants.METHOD_NAME_BULK_WRITER_COMMIT, traceContext)
               .setAttribute(ATTRIBUTE_KEY_DOC_COUNT, batch.getMutationsSize());
 
-      MetricsContext metricsContext =
-          firestore
-              .getOptions()
-              .getMetricsUtil()
-              .createMetricsContext(TelemetryConstants.METHOD_NAME_BULK_WRITER_COMMIT);
-
       try (Scope ignored = span.makeCurrent()) {
         ApiFuture<Void> result = batch.bulkCommit();
         if (!lastFlushOperation.isDone()) {
@@ -939,10 +931,8 @@ private void sendBatchLocked(final BulkCommitBatch batch) {
               bulkWriterExecutor);
         }
         span.endAtFuture(result);
-        metricsContext.recordLatencyAtFuture(MetricType.END_TO_END_LATENCY, result);
       } catch (Exception error) {
         span.end(error);
-        metricsContext.recordLatency(MetricType.END_TO_END_LATENCY, error);
         throw error;
       }
     } else {

google-cloud-firestore/src/main/java/com/google/cloud/firestore/CollectionGroup.java

@@ -21,9 +21,7 @@
 import com.google.api.gax.rpc.ApiException;
 import com.google.api.gax.rpc.ApiExceptions;
 import com.google.api.gax.rpc.ApiStreamObserver;
-import com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext;
 import com.google.cloud.firestore.telemetry.TelemetryConstants;
-import com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType;
 import com.google.cloud.firestore.telemetry.TraceUtil;
 import com.google.cloud.firestore.telemetry.TraceUtil.Scope;
 import com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryPagedResponse;
@@ -114,13 +112,6 @@ public ApiFuture<List<QueryPartition>> getPartitions(long desiredPartitionCount)
               .getTraceUtil()
               .startSpan(TelemetryConstants.METHOD_NAME_PARTITION_QUERY);
 
-      MetricsContext metricsContext =
-          rpcContext
-              .getFirestore()
-              .getOptions()
-              .getMetricsUtil()
-              .createMetricsContext(TelemetryConstants.METHOD_NAME_PARTITION_QUERY);
-
       try (Scope ignored = span.makeCurrent()) {
         ApiFuture<List<QueryPartition>> result =
             ApiFutures.transform(
@@ -138,15 +129,12 @@ public ApiFuture<List<QueryPartition>> getPartitions(long desiredPartitionCount)
                 },
                 MoreExecutors.directExecutor());
         span.endAtFuture(result);
-        metricsContext.recordLatencyAtFuture(MetricType.END_TO_END_LATENCY, result);
         return result;
       } catch (ApiException exception) {
         span.end(exception);
-        metricsContext.recordLatency(MetricType.END_TO_END_LATENCY, exception);
         throw FirestoreException.forApiException(exception);
       } catch (Throwable throwable) {
         span.end(throwable);
-        metricsContext.recordLatency(MetricType.END_TO_END_LATENCY, throwable);
         throw throwable;
       }
     }

google-cloud-firestore/src/main/java/com/google/cloud/firestore/CollectionReference.java

@@ -24,9 +24,7 @@
 import com.google.api.gax.rpc.UnaryCallable;
 import com.google.cloud.firestore.encoding.CustomClassMapper;
 import com.google.cloud.firestore.spi.v1.FirestoreRpc;
-import com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext;
 import com.google.cloud.firestore.telemetry.TelemetryConstants;
-import com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType;
 import com.google.cloud.firestore.telemetry.TraceUtil;
 import com.google.cloud.firestore.telemetry.TraceUtil.Scope;
 import com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPagedResponse;
@@ -139,13 +137,6 @@ public Iterable<DocumentReference> listDocuments() {
             .getTraceUtil()
             .startSpan(TelemetryConstants.METHOD_NAME_COL_REF_LIST_DOCUMENTS);
 
-    MetricsContext metricsContext =
-        rpcContext
-            .getFirestore()
-            .getOptions()
-            .getMetricsUtil()
-            .createMetricsContext(TelemetryConstants.METHOD_NAME_COL_REF_LIST_DOCUMENTS);
-
     try (Scope ignored = span.makeCurrent()) {
       ListDocumentsRequest.Builder request = ListDocumentsRequest.newBuilder();
       request.setParent(options.getParentPath().toString());
@@ -185,15 +176,12 @@ public void remove() {
             }
           };
       span.end();
-      metricsContext.recordLatency(MetricType.END_TO_END_LATENCY);
       return result;
     } catch (ApiException exception) {
       span.end(exception);
-      metricsContext.recordLatency(MetricType.END_TO_END_LATENCY, exception);
       throw FirestoreException.forApiException(exception);
     } catch (Throwable throwable) {
       span.end(throwable);
-      metricsContext.recordLatency(MetricType.END_TO_END_LATENCY, throwable);
       throw throwable;
     }
   }
@@ -216,25 +204,16 @@ public ApiFuture<DocumentReference> add(@Nonnull final Map<String, Object> field
             .getTraceUtil()
             .startSpan(TelemetryConstants.METHOD_NAME_COL_REF_ADD);
 
-    MetricsContext metricsContext =
-        rpcContext
-            .getFirestore()
-            .getOptions()
-            .getMetricsUtil()
-            .createMetricsContext(TelemetryConstants.METHOD_NAME_COL_REF_ADD);
-
     try (Scope ignored = span.makeCurrent()) {
       final DocumentReference documentReference = document();
       ApiFuture<WriteResult> createFuture = documentReference.create(fields);
       ApiFuture<DocumentReference> result =
           ApiFutures.transform(
               createFuture, writeResult -> documentReference, MoreExecutors.directExecutor());
       span.endAtFuture(result);
-      metricsContext.recordLatencyAtFuture(MetricType.END_TO_END_LATENCY, result);
       return result;
     } catch (Exception error) {
       span.end(error);
-      metricsContext.recordLatency(MetricType.END_TO_END_LATENCY, error);
       throw error;
     }
   }