Skip to content

Commit

Permalink
fix: Rename 'enabled' to 'tracingEnabled'. (#1639)
Browse files Browse the repository at this point in the history
* fix: Rename 'enabled' to 'tracingEnabled'.

In the future, FirestoreOpenTelemetryOptions will support enabling/disabling
Logging and Metrics as well. So we should use a better name for this field.

* address feedback.
  • Loading branch information
ehsannas authored Apr 8, 2024
1 parent 9945414 commit 43d82b1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
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
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
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

0 comments on commit 43d82b1

Please sign in to comment.