Skip to content

Commit ee3eeb9

Browse files
adinauerclaude
andcommitted
ref(android): Align log capture manifest option names
Rename the Timber and Logcat manifest options to describe Sentry's log capture direction consistently with their Android option accessors. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 5bf02ee commit ee3eeb9

7 files changed

Lines changed: 25 additions & 16 deletions

File tree

‎.cursor/rules/options.mdc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Allows setting options via `AndroidManifest.xml` `<meta-data>` tags.
7676
- Add a `static final String` constant for the key
7777
- Read it in `applyMetadata()` using `readBool(metadata, logger, CONSTANT, defaultValue)`
7878
- Apply automatic-source options directly, for example
79-
`options.setLogcatLogCaptureEnabled(...)` for `io.sentry.logcat.logs.enabled`
79+
`options.setLogcatLogCaptureEnabled(...)` for `io.sentry.logcat.log-capture.enabled`
8080
- Do not add or restore `io.sentry.logs.enabled` or `io.sentry.metrics.enabled`; those aggregate
8181
keys are obsolete.
8282

@@ -114,8 +114,8 @@ or breadcrumb paths. Current Logs controls are:
114114
- Log4j2: appender `logsEnabled`
115115
- JUL: handler `logsEnabled`
116116
- Spring Boot Logback: `sentry.logging.logs-enabled`
117-
- Timber: `timberLogCaptureEnabled` / `io.sentry.timber.logs.enabled`
118-
- Logcat: `logcatLogCaptureEnabled` / `io.sentry.logcat.logs.enabled`
117+
- Timber: `timberLogCaptureEnabled` / `io.sentry.timber.log-capture.enabled`
118+
- Logcat: `logcatLogCaptureEnabled` / `io.sentry.logcat.log-capture.enabled`
119119

120120
All source-local options default to `false` and gate only Sentry Logs forwarding.
121121

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
- JUL handler: `io.sentry.jul.SentryHandler.logsEnabled`
2626
- Spring Boot logging auto-configuration: `sentry.logging.logs-enabled`
2727
- Auto-installed Timber integration: `timberLogCaptureEnabled` or
28-
`io.sentry.timber.logs.enabled` manifest metadata
28+
`io.sentry.timber.log-capture.enabled` manifest metadata
2929
- Manually installed Timber integration: `logsEnabled` constructor argument
30-
- Logcat: `logcatLogCaptureEnabled` or `io.sentry.logcat.logs.enabled` manifest metadata
30+
- Logcat: `logcatLogCaptureEnabled` or `io.sentry.logcat.log-capture.enabled` manifest metadata
3131

3232
### Features
3333

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@ final class ManifestMetadataReader {
192192

193193
static final String IN_APP_EXCLUDES = "io.sentry.in-app-excludes";
194194

195-
static final String ENABLE_TIMBER_LOGS = "io.sentry.timber.logs.enabled";
195+
static final String TIMBER_LOG_CAPTURE_ENABLED = "io.sentry.timber.log-capture.enabled";
196196

197-
static final String ENABLE_LOGCAT_LOGS = "io.sentry.logcat.logs.enabled";
197+
static final String LOGCAT_LOG_CAPTURE_ENABLED = "io.sentry.logcat.log-capture.enabled";
198198

199199
static final String ENABLE_AUTO_TRACE_ID_GENERATION =
200200
"io.sentry.traces.enable-auto-id-generation";
@@ -751,10 +751,18 @@ static void applyMetadata(
751751
}
752752

753753
options.setTimberLogCaptureEnabled(
754-
readBool(metadata, logger, ENABLE_TIMBER_LOGS, options.getTimberLogCaptureEnabled()));
754+
readBool(
755+
metadata,
756+
logger,
757+
TIMBER_LOG_CAPTURE_ENABLED,
758+
options.getTimberLogCaptureEnabled()));
755759

756760
options.setLogcatLogCaptureEnabled(
757-
readBool(metadata, logger, ENABLE_LOGCAT_LOGS, options.getLogcatLogCaptureEnabled()));
761+
readBool(
762+
metadata,
763+
logger,
764+
LOGCAT_LOG_CAPTURE_ENABLED,
765+
options.getLogcatLogCaptureEnabled()));
758766

759767
final @NotNull SentryFeedbackOptions feedbackOptions = options.getFeedbackOptions();
760768
feedbackOptions.setNameRequired(

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2186,7 +2186,7 @@ class ManifestMetadataReaderTest {
21862186

21872187
@Test
21882188
fun `applyMetadata reads Timber log capture enabled to options`() {
2189-
val bundle = bundleOf(ManifestMetadataReader.ENABLE_TIMBER_LOGS to true)
2189+
val bundle = bundleOf(ManifestMetadataReader.TIMBER_LOG_CAPTURE_ENABLED to true)
21902190
val context = fixture.getContext(metaData = bundle)
21912191

21922192
ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
@@ -2205,7 +2205,7 @@ class ManifestMetadataReaderTest {
22052205

22062206
@Test
22072207
fun `applyMetadata reads Logcat log capture enabled to options`() {
2208-
val bundle = bundleOf(ManifestMetadataReader.ENABLE_LOGCAT_LOGS to true)
2208+
val bundle = bundleOf(ManifestMetadataReader.LOGCAT_LOG_CAPTURE_ENABLED to true)
22092209
val context = fixture.getContext(metaData = bundle)
22102210

22112211
ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
@@ -2216,7 +2216,7 @@ class ManifestMetadataReaderTest {
22162216
@Test
22172217
fun `applyMetadata reads Logcat log capture disabled to options`() {
22182218
fixture.options.logcatLogCaptureEnabled = true
2219-
val bundle = bundleOf(ManifestMetadataReader.ENABLE_LOGCAT_LOGS to false)
2219+
val bundle = bundleOf(ManifestMetadataReader.LOGCAT_LOG_CAPTURE_ENABLED to false)
22202220
val context = fixture.getContext(metaData = bundle)
22212221

22222222
ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ class SentryAndroidTest {
262262
val metadata =
263263
Bundle().apply {
264264
putString(ManifestMetadataReader.DSN, "https://key@sentry.io/123")
265-
putBoolean(ManifestMetadataReader.ENABLE_TIMBER_LOGS, true)
265+
putBoolean(ManifestMetadataReader.TIMBER_LOG_CAPTURE_ENABLED, true)
266266
}
267267
val mockContext = ContextUtilsTestHelper.mockMetaData(metaData = metadata)
268268
val logs = mutableListOf<SentryLogEvent>()

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ class SentryLogcatAdapterTest {
8686

8787
@Test
8888
fun `Logcat log capture can be enabled through manifest metadata`() {
89-
val metadata = Bundle().apply { putBoolean(ManifestMetadataReader.ENABLE_LOGCAT_LOGS, true) }
89+
val metadata =
90+
Bundle().apply { putBoolean(ManifestMetadataReader.LOGCAT_LOG_CAPTURE_ENABLED, true) }
9091
fixture.initSut(logcatLogCaptureEnabled = null, metadata = metadata)
9192

9293
SentryLogcatAdapter.d(tag, commonMsg)

‎sentry-samples/sentry-samples-android/src/main/AndroidManifest.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,12 @@
149149

150150
<!-- how to enable Sentry Logs capture from Timber-->
151151
<meta-data
152-
android:name="io.sentry.timber.logs.enabled"
152+
android:name="io.sentry.timber.log-capture.enabled"
153153
android:value="true" />
154154

155155
<!-- how to enable Sentry Logs capture from Logcat-->
156156
<meta-data
157-
android:name="io.sentry.logcat.logs.enabled"
157+
android:name="io.sentry.logcat.log-capture.enabled"
158158
android:value="true" />
159159

160160
<!-- how to disable verbose logging of the session replay feature-->

0 commit comments

Comments
 (0)