Package com.google.api.gax.tracing

Class OpenTelemetryTracingFactory

java.lang.Object

com.google.api.gax.tracing.OpenTelemetryTracingFactory

All Implemented Interfaces:

ApiTracerFactory

public class OpenTelemetryTracingFactory
extends Object
implements ApiTracerFactory

A ApiTracerFactory to build instances of OpenTelemetryTracingTracer.

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

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.api.gax.tracing.ApiTracerFactory

ApiTracerFactory.OperationType

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryTracingFactory(io.opentelemetry.api.OpenTelemetry openTelemetry)	Warning: Traces may contain sensitive data such as resource names, full URLs, and error messages.

Method Summary

Modifier and Type	Method	Description
boolean	needsContext()	Indicates whether this factory requires an ApiTracerContext to be injected via ApiTracerFactory.withContext(ApiTracerContext) before creating tracers.
ApiTracer	newTracer(ApiTracer parent, ApiTracerContext apiTracerContext)	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.
ApiTracerFactory	withContext(ApiTracerContext context)	Returns a new OpenTelemetryTracingFactory with the provided context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenTelemetryTracingFactory

public OpenTelemetryTracingFactory(io.opentelemetry.api.OpenTelemetry openTelemetry)

Warning: Traces may contain sensitive data such as resource names, full URLs, and error messages.

Before configuring subscribers or exporters for traces, review the contents of the spans and consult the OpenTelemetry documentation to set up filters and formatters to prevent leaking sensitive information, depending on your intended use case.

See also the OpenTelemetry Semantic Conventions.

Method Details

newTracer

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

Description copied from interface: ApiTracerFactory

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

Specified by:

newTracer in interface ApiTracerFactory

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

public ApiTracer newTracer(ApiTracer parent,
 ApiTracerContext apiTracerContext)

Description copied from interface: ApiTracerFactory

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

Specified by:

newTracer in interface ApiTracerFactory

Parameters:

parent - the parent of this tracer

apiTracerContext - the method-definition-specific tracer context

needsContext

public boolean needsContext()

Description copied from interface: ApiTracerFactory

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

Specified by:

needsContext in interface ApiTracerFactory

Returns:

true if an ApiTracerContext should be injected, false otherwise.

withContext

public ApiTracerFactory withContext(ApiTracerContext context)

Returns a new OpenTelemetryTracingFactory with the provided context. The Tracer is re-initialized using the artifact name and version from the library metadata.

Specified by:

withContext in interface ApiTracerFactory

Parameters:

context - an ApiTracerContext object containing information to construct attributes