Package com.google.cloud.firestore.telemetry

Class EnabledTraceUtil

java.lang.Object

com.google.cloud.firestore.telemetry.EnabledTraceUtil

All Implemented Interfaces:

TraceUtil

public class EnabledTraceUtil
extends Object
implements TraceUtil

A utility class that uses OpenTelemetry for trace collection. `FirestoreOpenTelemetryOptions` in `FirestoreOptions` can be used to configure its behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EnabledTraceUtil.OpenTelemetryGrpcChannelConfigurator

Field Summary

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

ATTRIBUTE_KEY_ATTEMPT, ATTRIBUTE_KEY_ATTEMPTS_ALLOWED, ATTRIBUTE_KEY_ATTEMPTS_REMAINING, ATTRIBUTE_KEY_DOC_COUNT, ATTRIBUTE_KEY_IS_RETRY_WITH_CURSOR, ATTRIBUTE_KEY_IS_TRANSACTIONAL, ATTRIBUTE_KEY_NUM_RESPONSES, ATTRIBUTE_KEY_TRANSACTION_TYPE, ATTRIBUTE_SERVICE_PREFIX, ENABLE_TRACING_ENV_VAR, LIBRARY_NAME, SPAN_NAME_AGGREGATION_QUERY_GET, SPAN_NAME_BATCH_COMMIT, SPAN_NAME_BATCH_GET_DOCUMENTS, SPAN_NAME_BULK_WRITER_COMMIT, SPAN_NAME_COL_REF_ADD, SPAN_NAME_COL_REF_LIST_DOCUMENTS, SPAN_NAME_DOC_REF_CREATE, SPAN_NAME_DOC_REF_DELETE, SPAN_NAME_DOC_REF_GET, SPAN_NAME_DOC_REF_LIST_COLLECTIONS, SPAN_NAME_DOC_REF_SET, SPAN_NAME_DOC_REF_UPDATE, SPAN_NAME_PARTITION_QUERY, SPAN_NAME_QUERY_GET, SPAN_NAME_RUN_AGGREGATION_QUERY, SPAN_NAME_RUN_QUERY, SPAN_NAME_TRANSACTION_BEGIN, SPAN_NAME_TRANSACTION_COMMIT, SPAN_NAME_TRANSACTION_GET_AGGREGATION_QUERY, SPAN_NAME_TRANSACTION_GET_DOCUMENT, SPAN_NAME_TRANSACTION_GET_DOCUMENTS, SPAN_NAME_TRANSACTION_GET_QUERY, SPAN_NAME_TRANSACTION_ROLLBACK, SPAN_NAME_TRANSACTION_RUN

Method Summary

Modifier and Type	Method	Description
TraceUtil.Context	currentContext()	Returns the current Context.
TraceUtil.Span	currentSpan()	Returns 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.
io.opentelemetry.api.OpenTelemetry	getOpenTelemetry()
com.google.cloud.firestore.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.Context parent)	Starts a new span with the given name and the given context 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

startSpan

public com.google.cloud.firestore.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.Context parent)

Description copied from interface: TraceUtil

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

Specified by:

startSpan in interface TraceUtil

currentSpan

@Nonnull
public TraceUtil.Span currentSpan()

Description copied from interface: TraceUtil

Returns the current span.

Specified by:

currentSpan in interface TraceUtil

currentContext

@Nonnull
public TraceUtil.Context currentContext()

Description copied from interface: TraceUtil

Returns the current Context.

Specified by:

currentContext in interface TraceUtil