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

GitHub Repository

Classes

Class Description
com.google.api.gax.tracing.BaseApiTracer A base implementation of ApiTracer that does nothing. With the deprecation of Java 7 support, all the methods in ApiTracer 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.BaseApiTracerFactory Base factory that will build ApiTracers that do nothing.

For internal use only.
com.google.api.gax.tracing.MethodName A value class to represent the name of the RPC method in an ApiTracer.
com.google.api.gax.tracing.MetricsTracer This class computes generic metrics that can be observed in the lifecycle of an RPC operation. The responsibility of recording metrics should delegate to MetricsRecorder, 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.MetricsTracerFactory A ApiTracerFactory to build instances of MetricsTracer.

This class wraps the MetricsRecorder and pass it to MetricsTracer. It will be used to record metrics in MetricsTracer.
com.google.api.gax.tracing.OpenTelemetryMetricsRecorder OpenTelemetry 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.OpencensusTracer Implementation of ApiTracer that uses OpenCensus.

This implementation wraps an OpenCensus Span for every tracer and annotates that Span with various events throughout the lifecycle of the logical operation.
com.google.api.gax.tracing.OpencensusTracerFactory A ApiTracerFactory to build instances of OpencensusTracer.

This class wraps the Tracer provided by Opencensus in Tracing.getTracer(). It will be used to create new spans and wrap them in OpencensusTracer defined in gax.
com.google.api.gax.tracing.SpanName A value class to represent the name of the operation in an ApiTracer.
com.google.api.gax.tracing.TracedBatchingCallable This callable wraps a batching callable chain in a ApiTracer.

For internal use only.
com.google.api.gax.tracing.TracedBidiCallable A wrapper callable that will wrap a callable chain in a trace.

For internal use only.
com.google.api.gax.tracing.TracedClientStreamingCallable A wrapper callable that will wrap a callable chain in a trace.

This can be safely called from multiple threads. However the request ApiStreamObserver can only be used from a single thread.
com.google.api.gax.tracing.TracedOperationCallable This callable wraps a OperationCallable in a ApiTracer.

For internal use only.
com.google.api.gax.tracing.TracedOperationInitialCallable Traces 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 by TracedOperationCallable) the result of the call.
com.google.api.gax.tracing.TracedServerStreamingCallable A wrapper callable that will wrap a callable chain in a trace.

For internal use only.
com.google.api.gax.tracing.TracedUnaryCallable This callable wraps a callable chain in a ApiTracer.

For internal use only.

Interfaces

Interface Description
com.google.api.gax.tracing.ApiTracer Implementations 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.Scope A context class to be used with #inScope() and a try-with-resources block. Closing a Scope removes any context that the underlying implementation might've set in #inScope().
com.google.api.gax.tracing.ApiTracerFactory A factory to create new instances of ApiTracers.

In general a single instance of an ApiTracer will correspond to a single logical operation.
com.google.api.gax.tracing.MetricsRecorder Provides 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

Enum Description
com.google.api.gax.tracing.ApiTracerFactory.OperationType The type of operation the ApiTracer is tracing.