Package com.google.api.gax.tracing (2.72.2)

GitHub Repository

Classes

ClassDescription
com.google.api.gax.tracing.BaseApiTracerA base implementation ofApiTracer that does nothing. With the deprecation of Java 7 support, all the methods inApiTracer are now made default, we no longer need a base class that does nothing. This class should be removed once all the references to it are removed in Google Cloud Client Libraries.
com.google.api.gax.tracing.BaseApiTracerFactoryBase factory that will buildApiTracers that do nothing.

For internal use only.

com.google.api.gax.tracing.MethodNameA value class to represent the name of the RPC method in anApiTracer.
com.google.api.gax.tracing.MetricsTracerThis class computes generic metrics that can be observed in the lifecycle of an RPC operation. The responsibility of recording metrics should delegate toMetricsRecorder, hence this class should not have any knowledge about the observability framework used for metrics recording. method_name and language will be autopopulated attributes. Default value of language is 'Java'.
com.google.api.gax.tracing.MetricsTracerFactoryAApiTracerFactory to build instances ofMetricsTracer.

This class wraps theMetricsRecorder and pass it toMetricsTracer. It will be used to record metrics inMetricsTracer.

com.google.api.gax.tracing.OpenTelemetryMetricsRecorderOpenTelemetry implementation of recording metrics. This implementation collections the measurements related to the lifecyle of an RPC.

For the Otel implementation, an attempt is a single RPC invocation and an operation is the

com.google.api.gax.tracing.OpencensusTracerImplementation ofApiTracer that uses OpenCensus.

This implementation wraps an OpenCensusSpan for every tracer and annotates thatSpan with various events throughout the lifecycle of the logical operation.

com.google.api.gax.tracing.OpencensusTracerFactoryAApiTracerFactory to build instances ofOpencensusTracer.

This class wraps theTracer provided by Opencensus inTracing.getTracer(). It will be used to create new spans and wrap them inOpencensusTracer defined in gax.

com.google.api.gax.tracing.SpanNameA value class to represent the name of the operation in anApiTracer.
com.google.api.gax.tracing.TracedBatchingCallableThis callable wraps a batching callable chain in aApiTracer.

For internal use only.

com.google.api.gax.tracing.TracedBidiCallableA wrapper callable that will wrap a callable chain in a trace.

For internal use only.

com.google.api.gax.tracing.TracedClientStreamingCallableA wrapper callable that will wrap a callable chain in a trace.

This can be safely called from multiple threads. However the requestApiStreamObserver can only be used from a single thread.

com.google.api.gax.tracing.TracedOperationCallableThis callable wraps aOperationCallable in aApiTracer.

For internal use only.

com.google.api.gax.tracing.TracedOperationInitialCallableTraces the initial RPC of a long running operation.

It will trace it like a child unary RPC and will also contribute to the parent tracer (created byTracedOperationCallable) the result of the call.

com.google.api.gax.tracing.TracedServerStreamingCallableA wrapper callable that will wrap a callable chain in a trace.

For internal use only.

com.google.api.gax.tracing.TracedUnaryCallableThis callable wraps a callable chain in aApiTracer.

For internal use only.

Interfaces

InterfaceDescription
com.google.api.gax.tracing.ApiTracerImplementations of this class trace the logical flow of a google cloud client.

A single instance of a tracer represents a logical operation that can be annotated throughout its lifecycle. Constructing an instance of a subclass will implicitly signal the start of a new

com.google.api.gax.tracing.ApiTracer.ScopeA context class to be used with#inScope() and a try-with-resources block. Closing aScope removes any context that the underlying implementation might've set in#inScope().
com.google.api.gax.tracing.ApiTracerFactoryA factory to create new instances ofApiTracers.

In general a single instance of anApiTracer will correspond to a single logical operation.

com.google.api.gax.tracing.MetricsRecorderProvides an interface for metrics recording. The implementer is expected to use an observability 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.

Enums

EnumDescription
com.google.api.gax.tracing.ApiTracerFactory.OperationTypeThe type of operation theApiTracer is tracing.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.