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

Classes

Class Description
com. google. api. gax. tracing. Api Tracer Context A context object that contains information used to infer attributes that are common for all ApiTracer s.

For internal use only.

com. google. api. gax. tracing. Api Tracer Context. Builder
com. google. api. gax. tracing. Base Api Tracer 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. Base Api Tracer Factory Base factory that will build ApiTracer s that do nothing.

For internal use only.

com. google. api. gax. tracing. Golden Signals Metrics Tracer Factory A ApiTracerFactory to build instances of GoldenSignalsMetricsTracer .

This class is expected to be initialized once during client initialization.

com. google. api. gax. tracing. Method Name A value class to represent the name of the RPC method in an ApiTracer .
com. google. api. gax. tracing. Metrics Tracer 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. Metrics Tracer Factory 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. Observability Attributes Utility class with common attribute names in app-centric observability.

For internal use only.

com. google. api. gax. tracing. Open Telemetry Metrics Recorder 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. Open Telemetry Trace Manager OpenTelemetry implementation of managing traces. This implementation collects the measurements related to the lifecyle of an RPC.
com. google. api. gax. tracing. Opencensus Tracer 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. Opencensus Tracer Factory 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. Span Name A value class to represent the name of the operation in an ApiTracer .
com. google. api. gax. tracing. Span Tracer An implementation of ApiTracer that uses a TraceManager to record traces. This implementation is agnostic to the specific TraceManager in order to allow extensions that interact with other backends.
com. google. api. gax. tracing. Span Tracer Factory A ApiTracerFactory to build instances of SpanTracer .

This class wraps the TraceManager and pass it to SpanTracer . It will be used to record traces in SpanTracer .

com. google. api. gax. tracing. Traced Batching Callable This callable wraps a batching callable chain in a ApiTracer .

For internal use only.

com. google. api. gax. tracing. Traced Bidi Callable A wrapper callable that will wrap a callable chain in a trace.

For internal use only.

com. google. api. gax. tracing. Traced Client Streaming Callable 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. Traced Operation Callable This callable wraps a OperationCallable in a ApiTracer .

For internal use only.

com. google. api. gax. tracing. Traced Operation Initial Callable 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. Traced Server Streaming Callable A wrapper callable that will wrap a callable chain in a trace.

For internal use only.

com. google. api. gax. tracing. Traced Unary Callable This callable wraps a callable chain in a ApiTracer .

For internal use only.

Interfaces

Interface Description
com. google. api. gax. tracing. Api Tracer 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. Api Tracer. 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. Api Tracer Factory A factory to create new instances of ApiTracer s.

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

com. google. api. gax. tracing. Metrics Recorder 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.
com. google. api. gax. tracing. Trace Manager Provides an interface for tracing management. The implementer is expected to use an observability framework, e.g. OpenTelemetry. There should be only one instance of TraceManager per client.
com. google. api. gax. tracing. Trace Manager. Span

Enums

Enum Description
com. google. api. gax. tracing. Api Tracer Context. Transport
com. google. api. gax. tracing. Api Tracer Factory. Operation Type The type of operation the ApiTracer is tracing.
Create a Mobile Website
View Site in Mobile | Classic
Share by: