Skip to content

perf(connectivity): Have only one NetworkCallback active at a time #4562

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.

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

Merged
merged 14 commits into from
Aug 1, 2025

Conversation

romtsn
Copy link
Member

@romtsn romtsn commented Jul 18, 2025

📜 Description

  • Have only single NetworkCallback registered at a time
    • Multi-cast it to the internal child NetworkCallbacks (NetworkBreadcrumbsIntegration)
  • Remove executor in NetworkBreadcrumbsIntegration since we just add a callback to the list now instead of doing any IPC
  • While testing it I noticed replay wasn't always catching network_available breadcrumb due to timing issues, so I special-cased it in this PR too

Event example: https://sentry-sdks.sentry.io/issues/6560149804/events/960094050aa341cca6ac9d0c175f699e/
Replay example: https://sentry-sdks.sentry.io/explore/replays/fff819393dd44cfa9a06b54255664529

💡 Motivation and Context

Less IPC

💚 How did you test it?

Manually + automated

📝 Checklist

  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

scopes, buildInfoProvider, options.getDateProvider());

final boolean registered =
AndroidConnectionStatusProvider.addNetworkCallback(
Copy link
Member Author

Choose a reason for hiding this comment

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

one caveat: This now will not emit AVAILABLE and CAPABILITIES_CHANGED callbacks immediately after registration as opposed to calling ConnectivityManager.registerDefaultNetworkCallback.

But I think it's fine and how it should be - previously any event would always start with NETWORK_AVAILABLE breadcrumb, which could have been misleading, now we're actually adding breadcrumbs whenever there's a change.

if (scopes != null && options != null) {
if (scopes != null
&& options != null
&& status != IConnectionStatusProvider.ConnectionStatus.DISCONNECTED) {
Copy link
Member Author

Choose a reason for hiding this comment

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

kind of unrelated to this PR, but I noticed that we also submit a task even if the status was DISCONNECTED, which was unnecessary since we'd anyway bail out in the submitted task itself.

Copy link
Contributor

github-actions bot commented Jul 18, 2025

Performance metrics 🚀

  Plain With Sentry Diff
Startup time 478.24 ms 525.98 ms 47.74 ms
Size 1.58 MiB 2.09 MiB 521.57 KiB

Previous results on branch: rz/perf/single-network-callback

Startup times

Revision Plain With Sentry Diff
5993034 471.84 ms 493.10 ms 21.26 ms
c2f723e 382.31 ms 432.96 ms 50.65 ms

App size

Revision Plain With Sentry Diff
5993034 1.58 MiB 2.09 MiB 520.98 KiB
c2f723e 1.58 MiB 2.09 MiB 520.98 KiB

Base automatically changed from rz/fix/diff-battery-crumbs to main July 30, 2025 22:16
@romtsn romtsn merged commit 617a292 into main Aug 1, 2025
35 of 36 checks passed
@romtsn romtsn deleted the rz/perf/single-network-callback branch August 1, 2025 13:29
adinauer added a commit that referenced this pull request Aug 8, 2025
* Do not report cached events as lost

* E2E tests for OpenTelemetry based console sample (#4563)

* e2e tests for console app

* fix test failures by waiting for 10s after first try to find envelopes

* add system-test-runner.py script to replace bash scripts for running e2e / system tests

* use py script for ci, cleanup, makefile

* Format code

* remove bash scripts

* install requests module

* api

* fix gh script

* Implement E2E tests for OTel based console sample

* fixes after merge

* Format code

* e2e tests for console app

* Implement E2E tests for OTel based console sample

* fixes after merge

* Format code

* api

* Reduce scope forking when using OpenTelemetry (#4565)

* Reduce scope forking in OpenTelemetry

* Format code

* api

* changelog

---------

Co-authored-by: Sentry Github Bot <[email protected]>

* SDKs send queue is no longer shutdown immediately on re-init (#4564)

* Let queue drain on a restart

* Format code

* Format code

* Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt

* Let queue drain on a restart

* Format code

* Format code

* Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt

* adapt tests

* changelog

---------

Co-authored-by: Sentry Github Bot <[email protected]>

---------

Co-authored-by: Sentry Github Bot <[email protected]>

* release: 8.18.0

* ref(replay): Use main thread to schedule capture (#4542)

* perf(connectivity): Cache network capabilities and status to reduce IPC calls (#4560)

* fix(breadcrumbs): Deduplicate battery breadcrumbs (#4561)

* fix(ci): remove obsolete NDK debug symbols (#4581)

As they don't exist anymore and this is done within sentry-native directly: https://github.com/getsentry/sentry-native/pull/1327/files

* fix(android): Remove unused method (#4585)

* fix(android): Remove unused method

* Update Changelog

* Add rules file for documenting SDK offline behaviour (#4572)

#skip-changelog

## 📜 Description
<!--- Describe your changes in detail -->
Add rules file for documenting SDK offline behaviour

## 💡 Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
Should help speed up AI reasoning about the SDK offline/retry behaviour.

## 💚 How did you test it?


## 📝 Checklist
<!--- Put an `x` in the boxes that apply -->

- [ ] I added tests to verify the changes.
- [ ] No new PII added or SDK only sends newly added PII if `sendDefaultPII` is enabled.
- [ ] I updated the docs if needed.
- [ ] I updated the wizard if needed.
- [ ] Review from the native team if needed.
- [ ] No breaking change or entry added to the changelog.
- [ ] No breaking change for hybrid SDKs or communicated to hybrid SDKs.


## 🔮 Next steps

* perf(connectivity): Have only one NetworkCallback active at a time (#4562)

* fix(scripts): update-gradle script set-version (#4591)

* fix: sentry-android-ndk proguard rule keeps all native class (#4427)

* fix: sentry-androi-ndk proguard rule keeps all native class

* docs: update CHANGELOG

* fix: update CHANGELOG

* Update CHANGELOG.md

* Update CHANGELOG.md

---------

Co-authored-by: Markus Hintersteiner <[email protected]>
Co-authored-by: Markus Hintersteiner <[email protected]>

* refactor(lifecycle): Use single lifecycle observer (#4567)

* perf(connectivity): Cache network capabilities and status to reduce IPC calls

* changelog

* Changelog

* revert

* fix(breadcrumbs): Deduplicate battery breadcrumbs

* ref

* Changelog

* Fix test

* perf(connectivity): Have only one NetworkCallback active at a time

* Changelog

* perf(integrations): Use single lifecycle observer

* Add tests

* Changelog

* Fix tests

* Improve callback handling and test visibility (#4593)

* Null-check lifecycleObserver

---------

Co-authored-by: Markus Hintersteiner <[email protected]>

* fix(sqlite): Fix abstract method error (#4597)

* fix(sqlite): Fix abstract method error

* Update CHANGELOG.md

* Suppress metadata version checks

* perf(integrations): Do not register for SystemEvents and NetworkCallbacks when launched with background importance (#4579)

* fix(android): Ensure frame metrics listeners are registered/unregistered on the main thread (#4582)

* fix(android): Ensure frame metrics listeners are registered/unregistered on the main thread

* Fix race conditions

* Update Changelog

* Update CHANGELOG.md

* Address PR feedback

* perf(executor): Prewarm SentryExecutorService (#4606)

* review feedback

* changelog

* pass through whether cache stored in AndroidEnvelopeCache + test

* Format code

---------

Co-authored-by: Sentry Github Bot <[email protected]>
Co-authored-by: getsentry-bot <[email protected]>
Co-authored-by: Roman Zavarnitsyn <[email protected]>
Co-authored-by: Markus Hintersteiner <[email protected]>
Co-authored-by: Ghasem Shirdel <[email protected]>
Co-authored-by: Markus Hintersteiner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants