feat: Add API to retrieve persisted breadcrumbs on Android by romtsn · Pull Request #4977 · getsentry/sentry-dotnet

romtsn · 2026-03-03T23:16:32Z

Summary

Adds SentrySdk.GetPersistedBreadcrumbs() public API that returns breadcrumbs from the previous app session on Android
Reads from the native Android SDK's PersistingScopeObserver during init and caches the result
No internal binding types are exposed — customers get back .NET Breadcrumb objects

Usage

#if __ANDROID__
var breadcrumbs = SentrySdk.GetPersistedBreadcrumbs();
foreach (var breadcrumb in breadcrumbs)
{
    Console.WriteLine($"[{breadcrumb.Timestamp}] {breadcrumb.Category}: {breadcrumb.Message}");
}
#endif

Test plan

Verify breadcrumbs are read correctly on Android after a previous session with breadcrumbs
Verify empty list is returned when no persisted breadcrumbs exist
Verify the API is accessible from a MAUI sample app

🤖 Generated with Claude Code

Reads breadcrumbs from the Android SDK's PersistingScopeObserver during init and exposes them via SentrySdk.GetPersistedBreadcrumbs(). This allows customers to access breadcrumbs from the previous app session without needing access to internal binding types. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

github-actions · 2026-03-03T23:16:49Z

Semver Impact of This PR

⚪ None (no version bump detected)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

Features ✨

feat: Add API to retrieve persisted breadcrumbs on Android by romtsn in #4977

feat: Network calls for Session Replay on Android by jamescrosswell in #4860

Fixes 🐛

fix: Log Warning instead of Error when ratelimited by bitsandfoxes in #4927

Dependencies ⬆️

Deps

chore(deps): update Native SDK to v0.13.1 by github-actions in #4964
chore(deps): update Cocoa SDK to v9.5.0 by github-actions in #4944
chore(deps): update Native SDK to v0.13.0 by github-actions in #4941
chore(deps): update CLI to v3.2.2 by github-actions in #4943
chore(deps): update Java SDK to v8.33.0 by github-actions in #4933
chore(deps): update CLI to v3.2.0 by github-actions in #4805
- NOTE: Sentry CLI v3 removed support for the legacy API key authentication method. Sentry CLI now only supports authenticating with Auth Tokens. If you are using API key authentication via SentryApiKey, you need to generate an Auth Token and use SentryAuthToken, instead.
chore(deps): update Cocoa SDK to v9.4.1 by github-actions in #4928
chore(deps): update Native SDK to v0.12.8 by github-actions in #4929
Apps built using the Sentry SDK for .NET must now target iOS version 15 or higher. Previously only version 13 or higher was required. (#4781) by github-actions in #4781
Bump Cocoa SDK from v8.57.3 to v9.2.0 (#4781) by github-actions in #4781
- changelog
- diff
chore(deps): update Native SDK to v0.12.7 by github-actions in #4920

Other

test(blazor): Add Playwright E2E tests for navigation breadcrumbs by bruno-garcia in #4908
test(android): Use volatile to produce SIGSEGV in native crash test by jpnurmi in #4919

_{🤖 This preview updates automatically when you update the PR.}

github-actions · 2026-03-03T23:17:08Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against e0a2b3e

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

codecov · 2026-03-03T23:36:34Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.87%. Comparing base (e7c25cc) to head (e0a2b3e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4977   +/-   ##
=======================================
  Coverage   73.87%   73.87%           
=======================================
  Files         496      496           
  Lines       17951    17951           
  Branches     3516     3516           
=======================================
+ Hits        13261    13262    +1     
+ Misses       3832     3831    -1     
  Partials      858      858

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

The Java SDK returns an unmodifiable list (Collections$UnmodifiableRandomAccessList) which cannot be cast to ArrayList. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

The scope observer list may be concurrently modified during init, causing a ConcurrentModificationException. Gracefully return null instead of crashing. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

… condition Move breadcrumb reading into the OptionsConfigurationCallback, before SentryAndroid.Init() completes and integrations start writing to the QueueFile. Create a temporary PersistingScopeObserver to read from the previous session's data without concurrent modification. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Flash0ver · 2026-03-18T07:43:40Z

src/Sentry/Platforms/Android/SentrySdk.cs

+        // Create a temporary observer to read breadcrumbs from the previous session's QueueFile.
+        // This must be called before SentryAndroid.Init() completes, to avoid a race condition
+        // with breadcrumb-producing integrations that write to the same QueueFile concurrently.
+        using var observer = new JavaSdk.Cache.PersistingScopeObserver(nativeOptions);


question: could the user code just read the file directly and/or find and read the "breadcrumbs.json" themselves?

We're a bit hesitant of adding an API for a single use case, that is also either pessimizing all other scenarios, or a bit of a "dangerous" API (order of invocations).

nope, not easily -- the file has a special format and QueueFile is excluded from the bindings, plus, some necessary classes are package-private. Though, theoretically, exposing the QueueFile should be enough -- the rest can be achieved with a bit more code on the user's side

Maybe a middle ground, we could expose the ReadPersistedBreadcrumbs method publicly so users can call this themselves (before initialising the Android SDK) and dispose of the breadcrumbs once they're done with them.

We wouldn't then call this automatically and store the results for the lifetime of the application in _persistedBreadcrumbs (even users that don't care about this functionality).

That way the functionality is there for folks that need to use it, but everyone else doesn't pay a feature bloat tax.

yep, that's what I suggested to @Flash0ver internally as well. If y'all are fine with that, we could go that way 👍

changelog: Add entry for GetPersistedBreadcrumbs API

b4462d6

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

romtsn and others added 3 commits March 4, 2026 11:58

fix: Use IList instead of ArrayList for persisted breadcrumbs read

ea41624

The Java SDK returns an unmodifiable list (Collections$UnmodifiableRandomAccessList) which cannot be cast to ArrayList. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

fix: Catch Java exceptions when reading persisted breadcrumbs

43f43d8

The scope observer list may be concurrently modified during init, causing a ConcurrentModificationException. Gracefully return null instead of crashing. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Flash0ver reviewed Mar 18, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add API to retrieve persisted breadcrumbs on Android#4977

feat: Add API to retrieve persisted breadcrumbs on Android#4977
romtsn wants to merge 5 commits intomainfrom
feat/android-persisted-breadcrumbs

romtsn commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026 •

edited

Loading

Features ✨

Fixes 🐛

Dependencies ⬆️

Deps

Other

Uh oh!

github-actions bot commented Mar 3, 2026 •

edited

Loading

Uh oh!

codecov bot commented Mar 3, 2026 •

edited

Loading

Uh oh!

Flash0ver Mar 18, 2026 •

edited

Loading

Uh oh!

romtsn Mar 18, 2026

Uh oh!

jamescrosswell Mar 18, 2026

Uh oh!

romtsn Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

romtsn commented Mar 3, 2026

Summary

Usage

Test plan

Uh oh!

github-actions bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

Features ✨

Fixes 🐛

Dependencies ⬆️

Deps

Other

Uh oh!

github-actions bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Flash0ver Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

romtsn Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

jamescrosswell Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

romtsn Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Mar 3, 2026 •

edited

Loading

github-actions bot commented Mar 3, 2026 •

edited

Loading

codecov bot commented Mar 3, 2026 •

edited

Loading

Flash0ver Mar 18, 2026 •

edited

Loading