Package com.google.api.gax.tracing

Class LoggingTracerFactory

java.lang.Object

com.google.api.gax.tracing.LoggingTracerFactory

All Implemented Interfaces:

ApiTracerFactory

@InternalApi
public class LoggingTracerFactory
extends Object
implements ApiTracerFactory

A ApiTracerFactory that creates instances of LoggingTracer. This class is intended for internal framework use only. Manual instantiation is discouraged; the lifecycle is managed automatically by the system, when LoggingUtils.isLoggingEnabled() returning true.

Nested Class Summary

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

ApiTracerFactory.OperationType

Constructor Summary

Constructors

Constructor	Description
LoggingTracerFactory()

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 context)	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 ApiTracerFactory that will use the provided context to infer attributes for all tracers created by the factory.

Methods inherited from class java.lang.Object

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

Constructor Details

LoggingTracerFactory

public LoggingTracerFactory()

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 context)

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

context - 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)

Description copied from interface: ApiTracerFactory

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

Specified by:

withContext in interface ApiTracerFactory

Parameters:

context - an ApiTracerContext object containing information to construct attributes