Package com.google.api.gax.tracing

Class OpencensusTracerFactory

java.lang.Object

com.google.api.gax.tracing.BaseApiTracerFactory

com.google.api.gax.tracing.OpencensusTracerFactory

All Implemented Interfaces:

ApiTracerFactory

@InternalApi("For google-cloud-java client use only")
public final class OpencensusTracerFactory
extends BaseApiTracerFactory

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.

Nested Class Summary

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

ApiTracerFactory.OperationType

Constructor Summary

Constructors

Constructor	Description
OpencensusTracerFactory()	Instantiates a new instance capturing the Tracer in Tracing.getTracer.
OpencensusTracerFactory(java.util.Map<java.lang.String,java.lang.String> spanAttributes)	Instantiates a new instance capturing the Tracer in Tracing.getTracer.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
int	hashCode()
ApiTracer	newTracer(ApiTracer parent, SpanName spanName, ApiTracerFactory.OperationType operationType)	Create a new ApiTracer that will be a child of the current context.

Methods inherited from class com.google.api.gax.tracing.BaseApiTracerFactory

getInstance

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(java.util.Map<java.lang.String,java.lang.String> spanAttributes)

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:

spanAttributes - the attributes to stamp on every span. Should include things like library version.

Method Detail

newTracer

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

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

Specified by:

newTracer in interface ApiTracerFactory

Overrides:

newTracer in class BaseApiTracerFactory

Parameters:

parent - the parent of this tracer

spanName - the name of the new span

operationType - the type of operation that the tracer will trace

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object