Skip to content

Commit dd174d9

Browse files
adinauerclaude
andcommitted
feat(android): Add Timber Logs opt-in
Require an explicit Timber-local opt-in before forwarding Timber messages as Sentry Logs. Add Android options and manifest configuration for auto-installed integrations while preserving event and breadcrumb capture. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 17f0881 commit dd174d9

12 files changed

Lines changed: 170 additions & 11 deletions

File tree

‎sentry-android-core/api/sentry-android-core.api‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
439439
public fun isEnableStandaloneAppStartTracing ()Z
440440
public fun isEnableSystemEventBreadcrumbs ()Z
441441
public fun isEnableSystemEventBreadcrumbsExtras ()Z
442+
public fun isEnableTimberLogs ()Z
442443
public fun isReportHistoricalAnrs ()Z
443444
public fun isReportHistoricalTombstones ()Z
444445
public fun isTombstoneEnabled ()Z
@@ -472,6 +473,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
472473
public fun setEnableStandaloneAppStartTracing (Z)V
473474
public fun setEnableSystemEventBreadcrumbs (Z)V
474475
public fun setEnableSystemEventBreadcrumbsExtras (Z)V
476+
public fun setEnableTimberLogs (Z)V
475477
public fun setFrameMetricsCollector (Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;)V
476478
public fun setNativeHandlerStrategy (Lio/sentry/android/core/NdkHandlerStrategy;)V
477479
public fun setNativeSdkName (Ljava/lang/String;)V

‎sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ static void installDefaultIntegrations(
473473
}
474474

475475
if (isTimberAvailable) {
476-
options.addIntegration(new SentryTimberIntegration());
476+
options.addIntegration(new SentryTimberIntegration(options.isEnableTimberLogs()));
477477
}
478478
options.addIntegration(new AppComponentsBreadcrumbsIntegration(context));
479479
options.addIntegration(new SystemEventsBreadcrumbsIntegration(context));

‎sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ final class ManifestMetadataReader {
163163

164164
static final String ENABLE_LOGS = "io.sentry.logs.enabled";
165165

166+
static final String ENABLE_TIMBER_LOGS = "io.sentry.timber.logs.enabled";
167+
166168
static final String ENABLE_METRICS = "io.sentry.metrics.enabled";
167169

168170
static final String ENABLE_AUTO_TRACE_ID_GENERATION =
@@ -706,6 +708,9 @@ static void applyMetadata(
706708
.getLogs()
707709
.setEnabled(readBool(metadata, logger, ENABLE_LOGS, options.getLogs().isEnabled()));
708710

711+
options.setEnableTimberLogs(
712+
readBool(metadata, logger, ENABLE_TIMBER_LOGS, options.isEnableTimberLogs()));
713+
709714
options
710715
.getMetrics()
711716
.setEnabled(

‎sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroidOptions.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ public final class SentryAndroidOptions extends SentryOptions {
7171
/** Enable or disable automatic breadcrumbs for Network Events Using NetworkCallback */
7272
private boolean enableNetworkEventBreadcrumbs = true;
7373

74+
/** Enable or disable automatic Sentry Logs capture from Timber. Default is disabled. */
75+
private boolean enableTimberLogs = false;
76+
7477
/**
7578
* Enables the Auto instrumentation for Activity lifecycle tracing.
7679
*
@@ -457,6 +460,14 @@ public void setEnableNetworkEventBreadcrumbs(boolean enableNetworkEventBreadcrum
457460
this.enableNetworkEventBreadcrumbs = enableNetworkEventBreadcrumbs;
458461
}
459462

463+
public boolean isEnableTimberLogs() {
464+
return enableTimberLogs;
465+
}
466+
467+
public void setEnableTimberLogs(boolean enableTimberLogs) {
468+
this.enableTimberLogs = enableTimberLogs;
469+
}
470+
460471
/**
461472
* Enable or disable all the automatic breadcrumbs
462473
*

‎sentry-android-core/src/test/java/io/sentry/android/core/AndroidOptionsInitializerTest.kt‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -679,8 +679,21 @@ class AndroidOptionsInitializerTest {
679679
fun `SentryTimberIntegration added to the integration list if available on classpath`() {
680680
fixture.initSutWithClassLoader(isTimberAvailable = true)
681681

682-
val actual = fixture.sentryOptions.integrations.firstOrNull { it is SentryTimberIntegration }
683-
assertNotNull(actual)
682+
val actual =
683+
fixture.sentryOptions.integrations.firstOrNull { it is SentryTimberIntegration }
684+
as SentryTimberIntegration
685+
assertFalse(actual.enableLogs)
686+
}
687+
688+
@Test
689+
fun `SentryTimberIntegration receives Timber logs option`() {
690+
fixture.sentryOptions.isEnableTimberLogs = true
691+
fixture.initSutWithClassLoader(isTimberAvailable = true)
692+
693+
val actual =
694+
fixture.sentryOptions.integrations.firstOrNull { it is SentryTimberIntegration }
695+
as SentryTimberIntegration
696+
assertTrue(actual.enableLogs)
684697
}
685698

686699
@Test

‎sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1967,6 +1967,25 @@ class ManifestMetadataReaderTest {
19671967
assertTrue(fixture.options.logs.isEnabled)
19681968
}
19691969

1970+
@Test
1971+
fun `applyMetadata keeps Timber logs disabled if not found`() {
1972+
val context = fixture.getContext()
1973+
1974+
ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
1975+
1976+
assertFalse(fixture.options.isEnableTimberLogs)
1977+
}
1978+
1979+
@Test
1980+
fun `applyMetadata reads Timber logs enabled to options`() {
1981+
val bundle = bundleOf(ManifestMetadataReader.ENABLE_TIMBER_LOGS to true)
1982+
val context = fixture.getContext(metaData = bundle)
1983+
1984+
ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
1985+
1986+
assertTrue(fixture.options.isEnableTimberLogs)
1987+
}
1988+
19701989
@Test
19711990
fun `applyMetadata reads metrics enabled and keep default value if not found`() {
19721991
// Arrange

‎sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidOptionsTest.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,21 @@ class SentryAndroidOptionsTest {
9393
assertTrue(sentryOptions.isEnableScopeSync)
9494
}
9595

96+
@Test
97+
fun `Timber logs are disabled by default`() {
98+
val sentryOptions = SentryAndroidOptions()
99+
100+
assertFalse(sentryOptions.isEnableTimberLogs)
101+
}
102+
103+
@Test
104+
fun `Timber logs can be enabled`() {
105+
val sentryOptions = SentryAndroidOptions()
106+
sentryOptions.isEnableTimberLogs = true
107+
108+
assertTrue(sentryOptions.isEnableTimberLogs)
109+
}
110+
96111
@Test
97112
fun `attach screenshots disabled by default for Android`() {
98113
val sentryOptions = SentryAndroidOptions()

‎sentry-android-timber/api/sentry-android-timber.api‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ public final class io/sentry/android/timber/SentryTimberIntegration : io/sentry/
1111
public fun <init> ()V
1212
public fun <init> (Lio/sentry/SentryLevel;Lio/sentry/SentryLevel;Lio/sentry/SentryLogLevel;)V
1313
public synthetic fun <init> (Lio/sentry/SentryLevel;Lio/sentry/SentryLevel;Lio/sentry/SentryLogLevel;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
14+
public fun <init> (Lio/sentry/SentryLevel;Lio/sentry/SentryLevel;Lio/sentry/SentryLogLevel;Z)V
15+
public fun <init> (Z)V
1416
public fun close ()V
17+
public final fun getEnableLogs ()Z
1518
public final fun getMinBreadcrumbLevel ()Lio/sentry/SentryLevel;
1619
public final fun getMinEventLevel ()Lio/sentry/SentryLevel;
1720
public final fun getMinLogsLevel ()Lio/sentry/SentryLogLevel;
@@ -21,6 +24,7 @@ public final class io/sentry/android/timber/SentryTimberIntegration : io/sentry/
2124
public final class io/sentry/android/timber/SentryTimberTree : timber/log/Timber$Tree {
2225
public fun <init> (Lio/sentry/IScopes;Lio/sentry/SentryLevel;Lio/sentry/SentryLevel;Lio/sentry/SentryLogLevel;)V
2326
public synthetic fun <init> (Lio/sentry/IScopes;Lio/sentry/SentryLevel;Lio/sentry/SentryLevel;Lio/sentry/SentryLogLevel;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
27+
public fun <init> (Lio/sentry/IScopes;Lio/sentry/SentryLevel;Lio/sentry/SentryLevel;Lio/sentry/SentryLogLevel;Z)V
2428
public fun d (Ljava/lang/String;[Ljava/lang/Object;)V
2529
public fun d (Ljava/lang/Throwable;)V
2630
public fun d (Ljava/lang/Throwable;Ljava/lang/String;[Ljava/lang/Object;)V

‎sentry-android-timber/src/main/java/io/sentry/android/timber/SentryTimberIntegration.kt‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,22 @@ public class SentryTimberIntegration(
1818
public val minBreadcrumbLevel: SentryLevel = SentryLevel.INFO,
1919
public val minLogsLevel: SentryLogLevel = SentryLogLevel.INFO,
2020
) : Integration, Closeable {
21+
public var enableLogs: Boolean = false
22+
private set
23+
24+
public constructor(enableLogs: Boolean) : this() {
25+
this.enableLogs = enableLogs
26+
}
27+
28+
public constructor(
29+
minEventLevel: SentryLevel,
30+
minBreadcrumbLevel: SentryLevel,
31+
minLogsLevel: SentryLogLevel,
32+
enableLogs: Boolean,
33+
) : this(minEventLevel, minBreadcrumbLevel, minLogsLevel) {
34+
this.enableLogs = enableLogs
35+
}
36+
2137
private lateinit var tree: SentryTimberTree
2238
private lateinit var logger: ILogger
2339

@@ -31,7 +47,7 @@ public class SentryTimberIntegration(
3147
override fun register(scopes: IScopes, options: SentryOptions) {
3248
logger = options.logger
3349

34-
tree = SentryTimberTree(scopes, minEventLevel, minBreadcrumbLevel, minLogsLevel)
50+
tree = SentryTimberTree(scopes, minEventLevel, minBreadcrumbLevel, minLogsLevel, enableLogs)
3551
Timber.plant(tree)
3652

3753
logger.log(SentryLevel.DEBUG, "SentryTimberIntegration installed.")

‎sentry-android-timber/src/main/java/io/sentry/android/timber/SentryTimberTree.kt‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@ public class SentryTimberTree(
2020
private val minBreadcrumbLevel: SentryLevel,
2121
private val minLogLevel: SentryLogLevel = SentryLogLevel.INFO,
2222
) : Timber.Tree() {
23+
private var enableLogs: Boolean = false
24+
25+
public constructor(
26+
scopes: IScopes,
27+
minEventLevel: SentryLevel,
28+
minBreadcrumbLevel: SentryLevel,
29+
minLogLevel: SentryLogLevel,
30+
enableLogs: Boolean,
31+
) : this(scopes, minEventLevel, minBreadcrumbLevel, minLogLevel) {
32+
this.enableLogs = enableLogs
33+
}
34+
2335
private val pendingTag = ThreadLocal<String?>()
2436

2537
private fun retrieveTag(): String? {
@@ -185,7 +197,9 @@ public class SentryTimberTree(
185197

186198
captureEvent(level, tag, sentryMessage, throwable)
187199
addBreadcrumb(level, sentryMessage, throwable)
188-
addLog(logLevel, message, tag, throwable, *args)
200+
if (enableLogs) {
201+
addLog(logLevel, message, tag, throwable, *args)
202+
}
189203
}
190204

191205
/** do not log if it's lower than min. required level. */

0 commit comments

Comments
 (0)