com.google.api.gax.tracing

Class OpencensusTracerFactory

java.lang.Object

com.google.api.gax.tracing.OpencensusTracerFactory

All Implemented Interfaces:

ApiTracerFactory

@InternalApi(value="For google-cloud-java client use only")
public final class OpencensusTracerFactory
extends Object
implements ApiTracerFactory

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.

This class is thread safe.

Constructor Summary

Constructors

Constructor and Description
OpencensusTracerFactory() Instantiates a new instance capturing the Tracer in Tracing.getTracer.
OpencensusTracerFactory(String clientNameOverride) Instantiates a new instance capturing the Tracer in Tracing.getTracer.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
ApiTracer	newRootTracer(SpanName spanName) Create a new ApiTracer that will ignore the current context and start a new toplevel trace.
ApiTracer	newTracer(SpanName spanName) Create a new ApiTracer that will be a child of the current context.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpencensusTracerFactory

public OpencensusTracerFactory()

Instantiates a new instance capturing the Tracer in Tracing.getTracer.

OpencensusTracerFactory

public OpencensusTracerFactory(@Nullable
                               String clientNameOverride)

Instantiates a new instance capturing the Tracer in Tracing.getTracer. It will also override the service name of the grpc stub with a custom client name. This is useful disambiguate spans created outer manual written wrappers and around generated gapic spans.

Parameters:

clientNameOverride - the client name that will override all of the spans' client name.

Method Detail

newTracer

public ApiTracer newTracer(SpanName spanName)

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

Specified by:

newTracer in interface ApiTracerFactory

newRootTracer

public ApiTracer newRootTracer(SpanName spanName)

Description copied from interface: ApiTracerFactory

Create a new ApiTracer that will ignore the current context and start a new toplevel trace.

Specified by:

newRootTracer in interface ApiTracerFactory

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object