Update Java docs.

googleapis · Jan 22, 2024 · 0483500 · 0483500
1 parent 9e32b79
commit 0483500
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsRecorder.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsRecorder.java
@@ -36,7 +36,9 @@
 
 /**
  * Provides an interface for metrics recording. The implementer is expected to use an observability
- * framework, e.g. OpenTelemetry
+ * framework, e.g. OpenTelemetry. There should be only one instance of MetricsRecorder per client,
+ * all the methods in this class are expected to be called from multiple threads, hence the
+ * implementation must be thread safe.
  */
 @BetaApi
 @InternalApi

diff --git a/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracerFactory.java b/gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracerFactory.java
@@ -38,7 +38,7 @@
  * <p>This class wraps the {@link MetricsRecorder} and pass it to {@link MetricsTracer}. It will be
  * used to record metrics in {@link MetricsTracer}.
  *
- * <p>This class is thread safe.
+ * <p>This class is expected to be initialized once during client initialization.
  */
 @BetaApi
 @InternalApi