Package com.google.cloud.firestore

Class FirestoreOpenTelemetryOptions.Builder

java.lang.Object

com.google.cloud.firestore.FirestoreOpenTelemetryOptions.Builder

Enclosing class:

FirestoreOpenTelemetryOptions

public static class FirestoreOpenTelemetryOptions.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
FirestoreOpenTelemetryOptions	build()
FirestoreOpenTelemetryOptions.Builder	setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)	Sets the OpenTelemetry to use with this Firestore instance.
FirestoreOpenTelemetryOptions.Builder	setTracingEnabled(boolean tracingEnabled)	Deprecated. This method will be removed in the next minor version update.

Methods inherited from class java.lang.Object

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

Method Details

build

@Nonnull
public FirestoreOpenTelemetryOptions build()

setTracingEnabled

@Deprecated
@Nonnull
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.

Parameters:

tracingEnabled - Whether tracing should be enabled.

setOpenTelemetry

@Nonnull
public FirestoreOpenTelemetryOptions.Builder setOpenTelemetry(@Nonnull
 io.opentelemetry.api.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`.

Parameters:

openTelemetry - The OpenTelemetry that should be used by this Firestore instance.