Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Add the deprecation notice for tracing enable/disable option. #1866

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

fix: Add the deprecation notice for tracing enable/disable option. #1866

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions ...oud-firestore/src/main/java/com/google/cloud/firestore/FirestoreOpenTelemetryOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ public class FirestoreOpenTelemetryOptions {
this.openTelemetry = builder.openTelemetry;
}

/**
* @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.
*/
@Deprecated
public boolean isTracingEnabled() {
return tracingEnabled;
}
Expand Down Expand Up @@ -78,7 +85,13 @@ public FirestoreOpenTelemetryOptions build() {
* Sets whether tracing should be enabled.
*
* @param tracingEnabled Whether tracing should be enabled.
* @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.
*/
@Deprecated
@Nonnull
public FirestoreOpenTelemetryOptions.Builder setTracingEnabled(boolean tracingEnabled) {
this.tracingEnabled = tracingEnabled;
Expand Down
Loading