Class FirestoreOpenTelemetryOptions.Builder (3.28.0)

public static class FirestoreOpenTelemetryOptions.Builder

Inheritance

java.lang.Object > FirestoreOpenTelemetryOptions.Builder

Methods

build()

public FirestoreOpenTelemetryOptions build()
Returns
Type Description
FirestoreOpenTelemetryOptions

setOpenTelemetry(OpenTelemetry openTelemetry)

public FirestoreOpenTelemetryOptions.Builder setOpenTelemetry(OpenTelemetry openTelemetry)

Sets the OpenTelemetry to use with this Firestore instance. If telemetry collection is enabled, but an OpenTelemetry is not provided, the Firestore SDK will attempt to use the GlobalOpenTelemetry.

Parameter
Name Description
openTelemetry io.opentelemetry.api.OpenTelemetry

The OpenTelemetry that should be used by this Firestore instance.

Returns
Type Description
FirestoreOpenTelemetryOptions.Builder

setTracingEnabled(boolean tracingEnabled) (deprecated)

public FirestoreOpenTelemetryOptions.Builder setTracingEnabled(boolean tracingEnabled)

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 contains a valid TracerProvider, the Firestore client will generate spans by utilizing it.

Sets whether tracing should be enabled.

Parameter
Name Description
tracingEnabled boolean

Whether tracing should be enabled.

Returns
Type Description
FirestoreOpenTelemetryOptions.Builder