Deprecate enableTracing in v7 (#3777)

* deprecate enableTracing * changelog
getsentry · Oct 10, 2024 · f79c9c1 · f79c9c1
1 parent fe8ba2c
commit f79c9c1
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- Deprecate `enableTracing` option ([#3777](https://github.com/getsentry/sentry-java/pull/3777))
+
 ## 7.15.0
 
 ### Features

diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java b/sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java
@@ -56,7 +56,7 @@ final class ManifestMetadataReader {
   static final String UNCAUGHT_EXCEPTION_HANDLER_ENABLE =
       "io.sentry.uncaught-exception-handler.enable";
 
-  static final String TRACING_ENABLE = "io.sentry.traces.enable";
+  @Deprecated static final String TRACING_ENABLE = "io.sentry.traces.enable";
   static final String TRACES_SAMPLE_RATE = "io.sentry.traces.sample-rate";
   static final String TRACES_ACTIVITY_ENABLE = "io.sentry.traces.activity.enable";
   static final String TRACES_ACTIVITY_AUTO_FINISH_ENABLE =

diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -913,14 +913,21 @@ public void setSampleRate(Double sampleRate) {
    * <p>NOTE: There is also {@link SentryOptions#isTracingEnabled()} which checks other options as
    * well.
    *
+   * @deprecated We're removing enableTracing in 8.0
    * @return true if enabled, false if disabled, null can mean enabled if {@link
    *     SentryOptions#getTracesSampleRate()} or {@link SentryOptions#getTracesSampler()} are set.
    */
+  @Deprecated
   public @Nullable Boolean getEnableTracing() {
     return enableTracing;
   }
 
-  /** Enables generation of transactions and propagation of trace data. */
+  /**
+   * Enables generation of transactions and propagation of trace data.
+   *
+   * @deprecated We're removing enableTracing in 8.0
+   */
+  @Deprecated
   public void setEnableTracing(@Nullable Boolean enableTracing) {
     this.enableTracing = enableTracing;
   }

diff --git a/sentry/src/main/java/io/sentry/TracesSampler.java b/sentry/src/main/java/io/sentry/TracesSampler.java
@@ -22,6 +22,7 @@ public TracesSampler(final @NotNull SentryOptions options) {
     this.random = random;
   }
 
+  @SuppressWarnings("deprecation")
   @NotNull
   TracesSamplingDecision sample(final @NotNull SamplingContext samplingContext) {
     final TracesSamplingDecision samplingContextSamplingDecision =