Package com.google.api.gax.tracing

Interface ApiTracerFactory

All Known Implementing Classes:

BaseApiTracerFactory, CompositeTracerFactory, LoggingTracerFactory, MetricsTracerFactory, OpencensusTracerFactory, OpenTelemetryMetricsFactory, OpenTelemetryTracingFactory

@InternalApi
@InternalExtensionOnly
public interface ApiTracerFactory

A factory to create new instances of ApiTracers.

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

For internal use only. google-cloud-java libraries should extend BaseApiTracerFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ApiTracerFactory.OperationType	The type of operation the ApiTracer is tracing.

Method Summary

Modifier and Type	Method	Description
default boolean	needsContext()	Indicates whether this factory requires an ApiTracerContext to be injected via withContext(ApiTracerContext) before creating tracers.
default ApiTracer	newTracer(ApiTracer parent, ApiTracerContext tracerContext)	Create a new ApiTracer that will be a child of the current context.
ApiTracer	newTracer(ApiTracer parent, SpanName spanName, ApiTracerFactory.OperationType operationType)	Create a new ApiTracer that will be a child of the current context.
default ApiTracerFactory	withContext(ApiTracerContext context)	Returns a new ApiTracerFactory that will use the provided context to infer attributes for all tracers created by the factory.

Method Details

newTracer

ApiTracer newTracer(ApiTracer parent,
 SpanName spanName,
 ApiTracerFactory.OperationType operationType)

Create a new ApiTracer that will be a child of the current context.

Parameters:

parent - the parent of this tracer

spanName - the name of the new span

operationType - the type of operation that the tracer will trace

newTracer

default ApiTracer newTracer(ApiTracer parent,
 ApiTracerContext tracerContext)

Create a new ApiTracer that will be a child of the current context.

Parameters:

parent - the parent of this tracer

tracerContext - the method-definition-specific tracer context

needsContext

default boolean needsContext()

Indicates whether this factory requires an ApiTracerContext to be injected via withContext(ApiTracerContext) before creating tracers.

Returns:

true if an ApiTracerContext should be injected, false otherwise.

withContext

default ApiTracerFactory withContext(ApiTracerContext context)

Returns a new ApiTracerFactory that will use the provided context to infer attributes for all tracers created by the factory.

Parameters:

context - an ApiTracerContext object containing information to construct attributes