Package com.google.cloud.datastore.telemetry

Class EnabledTraceUtil

java.lang.Object

com.google.cloud.datastore.telemetry.EnabledTraceUtil

All Implemented Interfaces:

TraceUtil

@InternalApi
public class EnabledTraceUtil
extends Object
implements TraceUtil

Tracing utility implementation, used to stub out tracing instrumentation when tracing is enabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EnabledTraceUtil.OpenTelemetryGrpcChannelConfigurator

Field Summary

Fields inherited from interface com.google.cloud.datastore.telemetry.TraceUtil

ATTRIBUTE_SERVICE_PREFIX, ATTRIBUTES_KEY_DEFERRED, ATTRIBUTES_KEY_DOCUMENT_COUNT, ATTRIBUTES_KEY_MISSING, ATTRIBUTES_KEY_MORE_RESULTS, ATTRIBUTES_KEY_READ_CONSISTENCY, ATTRIBUTES_KEY_RECEIVED, ATTRIBUTES_KEY_TRANSACTION_ID, ATTRIBUTES_KEY_TRANSACTIONAL, ENABLE_TRACING_ENV_VAR, LIBRARY_NAME, SPAN_NAME_ALLOCATE_IDS, SPAN_NAME_BEGIN_TRANSACTION, SPAN_NAME_COMMIT, SPAN_NAME_LOOKUP, SPAN_NAME_RESERVE_IDS, SPAN_NAME_ROLLBACK, SPAN_NAME_RUN_AGGREGATION_QUERY, SPAN_NAME_RUN_QUERY, SPAN_NAME_TRANSACTION_COMMIT, SPAN_NAME_TRANSACTION_LOOKUP, SPAN_NAME_TRANSACTION_RUN, SPAN_NAME_TRANSACTION_RUN_AGGREGATION_QUERY, SPAN_NAME_TRANSACTION_RUN_QUERY

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.api.trace.SpanBuilder	addSettingsAttributesToCurrentSpan(io.opentelemetry.api.trace.SpanBuilder spanBuilder)	Applies the current Datastore instance settings as attributes to the current Span
com.google.api.core.ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder>	getChannelConfigurator()	Returns a channel configurator for gRPC, or null if tracing is disabled.
TraceUtil.Context	getCurrentContext()	Returns the current Context.
TraceUtil.Span	getCurrentSpan()	Returns the current span.
io.opentelemetry.api.OpenTelemetry	getOpenTelemetry()
io.opentelemetry.api.trace.Tracer	getTracer()	Returns the current OpenTelemetry Tracer when OpenTelemetry SDK is provided.
com.google.cloud.datastore.telemetry.EnabledTraceUtil.Span	startSpan(String spanName)	Starts a new span with the given name, sets it as the current span, and returns it.
TraceUtil.Span	startSpan(String spanName, TraceUtil.Span parentSpan)	Starts a new span with the given name and the span represented by the parentSpan as its parent, sets it as the current span and returns it.

Methods inherited from class java.lang.Object

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

Method Details

getOpenTelemetry

public io.opentelemetry.api.OpenTelemetry getOpenTelemetry()

getChannelConfigurator

@Nullable
public com.google.api.core.ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder> getChannelConfigurator()

Description copied from interface: TraceUtil

Returns a channel configurator for gRPC, or null if tracing is disabled.

Specified by:

getChannelConfigurator in interface TraceUtil

addSettingsAttributesToCurrentSpan

public io.opentelemetry.api.trace.SpanBuilder addSettingsAttributesToCurrentSpan(io.opentelemetry.api.trace.SpanBuilder spanBuilder)

Applies the current Datastore instance settings as attributes to the current Span

Specified by:

addSettingsAttributesToCurrentSpan in interface TraceUtil

startSpan

public com.google.cloud.datastore.telemetry.EnabledTraceUtil.Span startSpan(String spanName)

Description copied from interface: TraceUtil

Starts a new span with the given name, sets it as the current span, and returns it.

Specified by:

startSpan in interface TraceUtil

startSpan

public TraceUtil.Span startSpan(String spanName,
 TraceUtil.Span parentSpan)

Description copied from interface: TraceUtil

Starts a new span with the given name and the span represented by the parentSpan as its parent, sets it as the current span and returns it.

Specified by:

startSpan in interface TraceUtil

getCurrentSpan

@Nonnull
public TraceUtil.Span getCurrentSpan()

Description copied from interface: TraceUtil

Returns the current span.

Specified by:

getCurrentSpan in interface TraceUtil

getCurrentContext

@Nonnull
public TraceUtil.Context getCurrentContext()

Description copied from interface: TraceUtil

Returns the current Context.

Specified by:

getCurrentContext in interface TraceUtil

getTracer

public io.opentelemetry.api.trace.Tracer getTracer()

Description copied from interface: TraceUtil

Returns the current OpenTelemetry Tracer when OpenTelemetry SDK is provided.

Specified by:

getTracer in interface TraceUtil