Skip to content

fix: Rename 'enabled' to 'tracingEnabled'. #1639

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

Merged
merged 2 commits into from
Apr 8, 2024
Merged

fix: Rename 'enabled' to 'tracingEnabled'. #1639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1be10df
fix: Rename 'enabled' to 'tracingEnabled'.
ehsannas Apr 3, 2024
98c29aa
address feedback.
ehsannas Apr 4, 2024
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
20 changes: 10 additions & 10 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 @@ -21,16 +21,16 @@
import javax.annotation.Nullable;

public class FirestoreOpenTelemetryOptions {
private final boolean enabled;
private final boolean tracingEnabled;
private final @Nullable OpenTelemetry openTelemetry;

FirestoreOpenTelemetryOptions(Builder builder) {
this.enabled = builder.enabled;
this.tracingEnabled = builder.tracingEnabled;
this.openTelemetry = builder.openTelemetry;
}

public boolean getEnabled() {
return enabled;
public boolean isTracingEnabled() {
return tracingEnabled;
}

public OpenTelemetry getOpenTelemetry() {
Expand All @@ -49,17 +49,17 @@ public static FirestoreOpenTelemetryOptions.Builder newBuilder() {

public static class Builder {

private boolean enabled;
private boolean tracingEnabled;

@Nullable private OpenTelemetry openTelemetry;

private Builder() {
enabled = false;
tracingEnabled = false;
openTelemetry = null;
}

private Builder(FirestoreOpenTelemetryOptions options) {
this.enabled = options.enabled;
this.tracingEnabled = options.tracingEnabled;
this.openTelemetry = options.openTelemetry;
}

Expand All @@ -71,11 +71,11 @@ public FirestoreOpenTelemetryOptions build() {
/**
* Sets whether tracing should be enabled.
*
* @param enable Whether tracing should be enabled.
* @param tracingEnabled Whether tracing should be enabled.
*/
@Nonnull
public FirestoreOpenTelemetryOptions.Builder setTracingEnabled(boolean enable) {
this.enabled = enable;
public FirestoreOpenTelemetryOptions.Builder setTracingEnabled(boolean tracingEnabled) {
this.tracingEnabled = tracingEnabled;
return this;
}

Expand Down
2 changes: 1 addition & 1 deletion google-cloud-firestore/src/main/java/com/google/cloud/firestore/telemetry/TraceUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public interface TraceUtil {
* @return An instance of the TraceUtil class.
*/
static TraceUtil getInstance(@Nonnull FirestoreOptions firestoreOptions) {
boolean createEnabledInstance = firestoreOptions.getOpenTelemetryOptions().getEnabled();
boolean createEnabledInstance = firestoreOptions.getOpenTelemetryOptions().isTracingEnabled();

// The environment variable can override options to enable/disable telemetry collection.
String enableTracingEnvVar = System.getenv(ENABLE_TRACING_ENV_VAR);
Expand Down
10 changes: 5 additions & 5 deletions ...le-cloud-firestore/src/test/java/com/google/cloud/firestore/OpenTelemetryOptionsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ FirestoreOptions.Builder getBaseOptions() {
public void defaultOptionsDisablesTelemetryCollection() {
FirestoreOptions firestoreOptions = getBaseOptions().build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().isTracingEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry()).isNull();
assertThat(firestore.getOptions().getTraceUtil()).isNotNull();
assertThat(firestore.getOptions().getTraceUtil() instanceof DisabledTraceUtil).isTrue();
Expand All @@ -66,7 +66,7 @@ public void canEnableTelemetryCollectionWithoutOpenTelemetryInstance() {
FirestoreOpenTelemetryOptions.newBuilder().setTracingEnabled(true).build())
.build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isTrue();
assertThat(firestore.getOptions().getOpenTelemetryOptions().isTracingEnabled()).isTrue();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry()).isNull();
assertThat(firestore.getOptions().getTraceUtil()).isNotNull();
assertThat(firestore.getOptions().getTraceUtil() instanceof EnabledTraceUtil).isTrue();
Expand All @@ -84,7 +84,7 @@ public void canEnableTelemetryCollectionWithOpenTelemetryInstance() {
.build())
.build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isTrue();
assertThat(firestore.getOptions().getOpenTelemetryOptions().isTracingEnabled()).isTrue();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry())
.isEqualTo(openTelemetry);
assertThat(firestore.getOptions().getTraceUtil()).isNotNull();
Expand All @@ -103,7 +103,7 @@ public void canDisableTelemetryCollectionWhileOpenTelemetryInstanceIsNotNull() {
.build())
.build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().isTracingEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry())
.isEqualTo(openTelemetry);
assertThat(firestore.getOptions().getTraceUtil()).isNotNull();
Expand All @@ -118,7 +118,7 @@ public void existenceOfGlobalOpenTelemetryDoesNotEnableTracing() {
// Make sure Firestore does not use GlobalOpenTelemetry by default.
FirestoreOptions firestoreOptions = getBaseOptions().build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().isTracingEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry()).isNull();
assertThat(firestore.getOptions().getTraceUtil()).isNotNull();
assertThat(firestore.getOptions().getTraceUtil() instanceof DisabledTraceUtil).isTrue();
Expand Down