Package com.google.cloud.firestore

Class FirestoreOpenTelemetryOptions

java.lang.Object

com.google.cloud.firestore.FirestoreOpenTelemetryOptions

@BetaApi
public class FirestoreOpenTelemetryOptions
extends Object

Represents the options that are used to configure the use of OpenTelemetry for telemetry collection in the Firestore SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FirestoreOpenTelemetryOptions.Builder

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.api.OpenTelemetry	getOpenTelemetry()
boolean	isTracingEnabled()	Deprecated. This method will be removed in the next minor version update.
static FirestoreOpenTelemetryOptions.Builder	newBuilder()
FirestoreOpenTelemetryOptions.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Method Details

isTracingEnabled

@Deprecated
public boolean isTracingEnabled()

Deprecated.

This method will be removed in the next minor version update. Please use a no-op TracerProvider or set the environment variable `FIRESTORE_ENABLE_TRACING=OFF` to disable tracing. If the GlobalOpenTelemetry or the OpenTelemetry instance passed to Firestore contain a valid TracerProvider, the Firestore client will generate spans by utilizing it.

getOpenTelemetry

public io.opentelemetry.api.OpenTelemetry getOpenTelemetry()

toBuilder

@Nonnull
public FirestoreOpenTelemetryOptions.Builder toBuilder()

newBuilder

@Nonnull
public static FirestoreOpenTelemetryOptions.Builder newBuilder()