Skip to content

Commit a736fcc

Browse files
committed
feat: Disable the tracing feature and remove public APIs.
1 parent 82feaae commit a736fcc

File tree

8 files changed

+24
-1
lines changed

8 files changed

+24
-1
lines changed

google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreOptions.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ com.google.cloud.firestore.telemetry.TraceUtil getTraceUtil() {
127127
return traceUtil;
128128
}
129129

130+
@InternalApi
130131
@BetaApi
131132
@Nonnull
132133
public FirestoreOpenTelemetryOptions getOpenTelemetryOptions() {
@@ -223,6 +224,7 @@ public Builder setDatabaseId(@Nonnull String databaseId) {
223224
*
224225
* @param openTelemetryOptions The `FirestoreOpenTelemetryOptions` to use.
225226
*/
227+
@InternalApi
226228
@BetaApi
227229
@Nonnull
228230
public Builder setOpenTelemetryOptions(

google-cloud-firestore/src/main/java/com/google/cloud/firestore/telemetry/TraceUtil.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import javax.annotation.Nullable;
2626

2727
public interface TraceUtil {
28+
static final boolean TRACING_FEATURE_ENABLED = false;
2829
String ATTRIBUTE_SERVICE_PREFIX = "gcp.firestore.";
2930
String SPAN_NAME_DOC_REF_CREATE = "DocumentReference.Create";
3031
String SPAN_NAME_DOC_REF_SET = "DocumentReference.Set";
@@ -62,6 +63,11 @@ public interface TraceUtil {
6263
* @return An instance of the TraceUtil class.
6364
*/
6465
static TraceUtil getInstance(@Nonnull FirestoreOptions firestoreOptions) {
66+
// TODO(tracing): Remove this to enable the feature.
67+
if (!TRACING_FEATURE_ENABLED) {
68+
return new DisabledTraceUtil();
69+
}
70+
6571
boolean createEnabledInstance = firestoreOptions.getOpenTelemetryOptions().isTracingEnabled();
6672

6773
// The environment variable can override options to enable/disable telemetry collection.

google-cloud-firestore/src/test/java/com/google/cloud/firestore/OpenTelemetryOptionsTest.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,11 @@
2626
import javax.annotation.Nullable;
2727
import org.junit.After;
2828
import org.junit.Before;
29+
import org.junit.Ignore;
2930
import org.junit.Test;
3031

32+
// TODO(tracing): Re-enable this test when the tracing feature is enabled.
33+
@Ignore
3134
public class OpenTelemetryOptionsTest {
3235
@Nullable private Firestore firestore;
3336

google-cloud-firestore/src/test/java/com/google/cloud/firestore/it/ITE2ETracingTestGlobalOtel.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@
1515
*/
1616
package com.google.cloud.firestore.it;
1717

18+
import org.junit.Ignore;
1819
import org.junit.runner.RunWith;
1920
import org.junit.runners.JUnit4;
2021

2122
@RunWith(JUnit4.class)
23+
@Ignore
2224
public class ITE2ETracingTestGlobalOtel extends ITE2ETracingTest {
2325
@Override
2426
protected boolean isUsingGlobalOpenTelemetrySDK() {

google-cloud-firestore/src/test/java/com/google/cloud/firestore/it/ITE2ETracingTestNonGlobalOtel.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@
1515
*/
1616
package com.google.cloud.firestore.it;
1717

18+
import org.junit.Ignore;
1819
import org.junit.runner.RunWith;
1920
import org.junit.runners.JUnit4;
2021

2122
@RunWith(JUnit4.class)
23+
@Ignore
2224
public class ITE2ETracingTestNonGlobalOtel extends ITE2ETracingTest {
2325
@Override
2426
protected boolean isUsingGlobalOpenTelemetrySDK() {

google-cloud-firestore/src/test/java/com/google/cloud/firestore/it/ITTracingTestGlobalOtel.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@
1515
*/
1616
package com.google.cloud.firestore.it;
1717

18+
import org.junit.Ignore;
1819
import org.junit.runner.RunWith;
1920
import org.junit.runners.JUnit4;
2021

2122
@RunWith(JUnit4.class)
23+
@Ignore
2224
public class ITTracingTestGlobalOtel extends ITTracingTest {
2325
@Override
2426
protected boolean isUsingGlobalOpenTelemetrySDK() {

google-cloud-firestore/src/test/java/com/google/cloud/firestore/it/ITTracingTestNonGlobalOtel.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@
1515
*/
1616
package com.google.cloud.firestore.it;
1717

18+
import org.junit.Ignore;
1819
import org.junit.runner.RunWith;
1920
import org.junit.runners.JUnit4;
2021

2122
@RunWith(JUnit4.class)
23+
@Ignore
2224
public class ITTracingTestNonGlobalOtel extends ITTracingTest {
2325
@Override
2426
protected boolean isUsingGlobalOpenTelemetrySDK() {

google-cloud-firestore/src/test/java/com/google/cloud/firestore/telemetry/TraceUtilTest.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ public void tracingEnabledOptionsUseEnabledTraceUtil() {
5656
.setOpenTelemetryOptions(
5757
FirestoreOpenTelemetryOptions.newBuilder().setTracingEnabled(true).build())
5858
.build());
59-
assertThat(traceUtil instanceof EnabledTraceUtil).isTrue();
59+
60+
// This is currently disabled because the feature is disabled as a whole.
61+
// TODO (tracing): This should be `traceUtil instanceof EnabledTraceUtil
62+
// once the feature is enabled.
63+
assertThat(traceUtil instanceof DisabledTraceUtil).isTrue();
6064
}
6165
}

0 commit comments

Comments
 (0)