Skip to content

perf(android): Use build-time manifest metadata #5963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
romtsn wants to merge 2 commits into from
+132 −22
Closed

perf(android): Use build-time manifest metadata #5963

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed4b35d
perf(android): Use build-time manifest metadata
romtsn Aug 13, 2026
a1698ab
docs(changelog): Add build-time metadata optimization
romtsn Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## Unreleased

### Performance

- Use Android manifest metadata resolved by the Sentry Android Gradle plugin at build time, avoiding `PackageManager` and `Bundle` parsing and reducing median SDK initialization time by 6.5% in a cold-start benchmark ([#5963](https://github.com/getsentry/sentry-java/pull/5963))

## 8.53.0

### Features
Expand Down
99 changes: 77 additions & 22 deletions sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,18 @@
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/** Class responsible for reading values from manifest and setting them to the options */
final class ManifestMetadataReader {

// Populated by the Sentry Android Gradle plugin with manifest metadata resolved at build time.
// When set, it is authoritative: the manifest is not read at runtime.
static @Nullable Map<String, Object> buildTimeMetadata;

static final String DSN = "io.sentry.dsn";
static final String DEBUG = "io.sentry.debug";
static final String DEBUG_LEVEL = "io.sentry.debug.level";
Expand Down Expand Up @@ -217,7 +222,7 @@ static void applyMetadata(
Objects.requireNonNull(options, "The options object is required.");

try {
final Bundle metadata = getMetadata(context, options.getLogger(), buildInfoProvider);
final Object metadata = getMetadata(context, options.getLogger(), buildInfoProvider);
final ILogger logger = options.getLogger();

if (metadata != null) {
Expand Down Expand Up @@ -491,7 +496,7 @@ static void applyMetadata(
List<String> tracePropagationTargets =
readList(metadata, logger, TRACE_PROPAGATION_TARGETS);

if (metadata.containsKey(TRACE_PROPAGATION_TARGETS) && tracePropagationTargets == null) {
if (containsKey(metadata, TRACE_PROPAGATION_TARGETS) && tracePropagationTargets == null) {
options.setTracePropagationTargets(Collections.emptyList());
} else if (tracePropagationTargets != null) {
options.setTracePropagationTargets(tracePropagationTargets);
Expand Down Expand Up @@ -779,44 +784,68 @@ static void applyMetadata(
}

private static boolean readBool(
final @NotNull Bundle metadata,
final @NotNull Object metadata,
final @NotNull ILogger logger,
final @NotNull String key,
final boolean defaultValue) {
final boolean value = metadata.getBoolean(key, defaultValue);
final boolean value;
if (metadata instanceof Bundle) {
value = ((Bundle) metadata).getBoolean(key, defaultValue);
} else {
final Object raw = ((Map<?, ?>) metadata).get(key);
value = raw instanceof Boolean ? (Boolean) raw : defaultValue;
}
if (logger.isEnabled(SentryLevel.DEBUG)) {
logger.log(SentryLevel.DEBUG, key + " read: " + value);
}
return value;
}

private static @Nullable String readString(
final @NotNull Bundle metadata,
final @NotNull Object metadata,
final @NotNull ILogger logger,
final @NotNull String key,
final @Nullable String defaultValue) {
final String value = metadata.getString(key, defaultValue);
final String value;
if (metadata instanceof Bundle) {
value = ((Bundle) metadata).getString(key, defaultValue);
} else {
final Object raw = ((Map<?, ?>) metadata).get(key);
value = raw instanceof String ? (String) raw : defaultValue;
}
if (logger.isEnabled(SentryLevel.DEBUG)) {
logger.log(SentryLevel.DEBUG, key + " read: " + value);
}
return value;
}

private static @NotNull String readStringNotNull(
final @NotNull Bundle metadata,
final @NotNull Object metadata,
final @NotNull ILogger logger,
final @NotNull String key,
final @NotNull String defaultValue) {
final String value = metadata.getString(key, defaultValue);
final String value;
if (metadata instanceof Bundle) {
value = ((Bundle) metadata).getString(key, defaultValue);
} else {
final Object raw = ((Map<?, ?>) metadata).get(key);
value = raw instanceof String ? (String) raw : defaultValue;
}
if (logger.isEnabled(SentryLevel.DEBUG)) {
logger.log(SentryLevel.DEBUG, key + " read: " + value);
}
return value;
}

private static @Nullable List<String> readList(
final @NotNull Bundle metadata, final @NotNull ILogger logger, final @NotNull String key) {
final String value = metadata.getString(key);
final @NotNull Object metadata, final @NotNull ILogger logger, final @NotNull String key) {
final String value;
if (metadata instanceof Bundle) {
value = ((Bundle) metadata).getString(key);
} else {
final Object raw = ((Map<?, ?>) metadata).get(key);
value = raw instanceof String ? (String) raw : null;
}
if (logger.isEnabled(SentryLevel.DEBUG)) {
logger.log(SentryLevel.DEBUG, key + " read: " + value);
}
Expand All @@ -828,11 +857,21 @@ private static boolean readBool(
}

private static double readDouble(
final @NotNull Bundle metadata, final @NotNull ILogger logger, final @NotNull String key) {
// manifest meta-data only reads float
double value = ((Float) metadata.getFloat(key, -1)).doubleValue();
if (value == -1) {
value = ((Integer) metadata.getInt(key, -1)).doubleValue();
final @NotNull Object metadata, final @NotNull ILogger logger, final @NotNull String key) {
final double value;
if (metadata instanceof Bundle) {
// manifest meta-data only reads float
double bundleValue = ((Float) ((Bundle) metadata).getFloat(key, -1)).doubleValue();
if (bundleValue == -1) {
bundleValue = ((Integer) ((Bundle) metadata).getInt(key, -1)).doubleValue();
}
value = bundleValue;
} else {
final Object raw = ((Map<?, ?>) metadata).get(key);
value =
raw instanceof Float
? ((Float) raw).doubleValue()
: raw instanceof Integer ? ((Integer) raw).doubleValue() : -1;
Comment on lines +872 to +874

@sentry sentry Bot Aug 13, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The readDouble method doesn't handle Double types from the build-time metadata map. Sample rates from the Gradle plugin will be silently ignored as they default to Double.
Severity: MEDIUM

Suggested Fix

Update the readDouble method to handle Double instances from the build-time metadata map. Add a check for raw instanceof Double and cast the value to double before returning it, similar to how Float and Integer are currently handled.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location:
sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java#L872-L874

Potential issue: The `readDouble` method, when reading from the build-time metadata Map,
only handles `Float` and `Integer` types. It does not handle `Double` types. In Kotlin,
which the Sentry Gradle plugin uses, decimal literals like `0.5` are inferred as
`Double`. If the Gradle plugin is used to configure a sample rate (e.g.,
`tracesSampleRate = 0.5`), it will be passed as a `Double`. The `readDouble` method will
then silently return `-1`, causing the sample rate configuration to be ignored and
sampling to be disabled or fall back to a default value.

Did we get this right? 👍 / 👎 to inform future reviews.

@romtsn romtsn Aug 13, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plugin does not pass Kotlin decimal literals into this field. ManifestMetadataParser.inferType explicitly uses toFloatOrNull(), so 0.5 becomes a Float; ManifestMetadataClassVisitor then boxes it with Float.valueOf. The parser test also asserts 0.5f, and this intentionally mirrors the Float type returned by Android manifest metadata. A Double therefore cannot be produced by the build-time injection path.

}
if (logger.isEnabled(SentryLevel.DEBUG)) {
logger.log(SentryLevel.DEBUG, key + " read: " + value);
Expand All @@ -841,12 +880,18 @@ private static double readDouble(
}

private static long readLong(
final @NotNull Bundle metadata,
final @NotNull Object metadata,
final @NotNull ILogger logger,
final @NotNull String key,
final long defaultValue) {
// manifest meta-data only reads int if the value is not big enough
final long value = metadata.getInt(key, (int) defaultValue);
final long value;
if (metadata instanceof Bundle) {
// manifest meta-data only reads int if the value is not big enough
value = ((Bundle) metadata).getInt(key, (int) defaultValue);
} else {
final Object raw = ((Map<?, ?>) metadata).get(key);
value = raw instanceof Integer ? (Integer) raw : defaultValue;
}
if (logger.isEnabled(SentryLevel.DEBUG)) {
logger.log(SentryLevel.DEBUG, key + " read: " + value);
}
Expand All @@ -865,7 +910,7 @@ static boolean isAutoInit(final @NotNull Context context, final @NotNull ILogger

boolean autoInit = true;
try {
final Bundle metadata = getMetadata(context, logger, null);
final Object metadata = getMetadata(context, logger, null);
if (metadata != null) {
autoInit = readBool(metadata, logger, AUTO_INIT, true);
}
Expand All @@ -876,18 +921,28 @@ static boolean isAutoInit(final @NotNull Context context, final @NotNull ILogger
}

/**
* Returns the Bundle attached from the given Context
* Returns build-time metadata when available, otherwise metadata attached to the given Context.
*
* @param context the application context
* @return the Bundle attached to the PackageManager
* @return metadata as a Map or PackageManager Bundle
*/
private static @Nullable Bundle getMetadata(
private static @Nullable Object getMetadata(
final @NotNull Context context,
final @NotNull ILogger logger,
final @Nullable BuildInfoProvider buildInfoProvider) {
final @Nullable Map<String, Object> injected = buildTimeMetadata;
if (injected != null) {
return injected;
}
final ApplicationInfo app =
ContextUtils.getApplicationInfo(
context, buildInfoProvider != null ? buildInfoProvider : new BuildInfoProvider(logger));
return app != null ? app.metaData : null;
}

private static boolean containsKey(final @NotNull Object metadata, final @NotNull String key) {
return metadata instanceof Bundle
? ((Bundle) metadata).containsKey(key)
: ((Map<?, ?>) metadata).containsKey(key);
}
}
49 changes: 49 additions & 0 deletions sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ import android.content.Context
import android.os.Bundle
import androidx.core.os.bundleOf
import androidx.test.ext.junit.runners.AndroidJUnit4
import com.google.common.truth.Truth.assertThat
import io.sentry.FilterString
import io.sentry.ILogger
import io.sentry.ProfileLifecycle
import io.sentry.SentryLevel
import io.sentry.SentryReplayOptions
import io.sentry.TransactionOptions
import kotlin.test.AfterTest
import kotlin.test.BeforeTest
import kotlin.test.Test
import kotlin.test.assertEquals
Expand All @@ -23,6 +25,7 @@ import org.mockito.kotlin.eq
import org.mockito.kotlin.mock
import org.mockito.kotlin.never
import org.mockito.kotlin.verify
import org.mockito.kotlin.verifyNoInteractions

@RunWith(AndroidJUnit4::class)
class ManifestMetadataReaderTest {
Expand All @@ -42,6 +45,52 @@ class ManifestMetadataReaderTest {
ContextUtils.resetInstance()
}

@AfterTest
fun `tear down`() {
ManifestMetadataReader.buildTimeMetadata = null
}

@Test
fun `applyMetadata reads typed build-time metadata without querying context`() {
val context = mock<Context>()
ManifestMetadataReader.buildTimeMetadata =
mapOf(
ManifestMetadataReader.DEBUG to true,
ManifestMetadataReader.DIST to "dist",
ManifestMetadataReader.SAMPLE_RATE to 0.5f,
ManifestMetadataReader.MAX_BREADCRUMBS to 42,
)

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

assertThat(fixture.options.isDebug).isTrue()
assertThat(fixture.options.dist).isEqualTo("dist")
assertThat(fixture.options.sampleRate).isEqualTo(0.5)
assertThat(fixture.options.maxBreadcrumbs).isEqualTo(42)
verifyNoInteractions(context)
}

@Test
fun `build-time metadata is authoritative when a key is absent`() {
val context = mock<Context>()
fixture.options.dist = "configured"
ManifestMetadataReader.buildTimeMetadata = emptyMap()

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

assertThat(fixture.options.dist).isEqualTo("configured")
verifyNoInteractions(context)
}

@Test
fun `isAutoInit reads build-time metadata without querying context`() {
val context = mock<Context>()
ManifestMetadataReader.buildTimeMetadata = mapOf(ManifestMetadataReader.AUTO_INIT to false)

assertThat(ManifestMetadataReader.isAutoInit(context, fixture.logger)).isFalse()
verifyNoInteractions(context)
}

@Test
fun `isAutoInit won't throw exception and is enabled by default`() {
fixture.options.setDebug(true)
Expand Down
Loading