Skip to content

Don't wait on main thread when SDK restarts - #3200

Merged
stefanosiano merged 12 commits into
mainfrom
enh/dont-wait-restart
Feb 16, 2024
Merged

Don't wait on main thread when SDK restarts#3200
stefanosiano merged 12 commits into
mainfrom
enh/dont-wait-restart

Conversation

@stefanosiano

@stefanosiano stefanosiano commented Feb 8, 2024

Copy link
Copy Markdown
Contributor

📜 Description

added new methods to close instances with isRestarting flag:

  • IHub.close(Boolean)
  • ISentryClient.close(Boolean)
  • ITransport.close(Boolean)

when the SDK restarts

  • the executor service is now closed in the background
  • current network connections are dropped. This is not a problem, as data will be sent anyway after the SDK restarts

We still wait for any processing that is happening, as that's more complex, but the biggest slowdown when restarting the SDK is waiting for the network to send data.

💡 Motivation and Context

When the SDK is initialized multiple times, it closes the old instance, waiting for any task to be completed.
This PR aims to reduce the wait time by dropping network connections and let any job scheduled to the executor to be finished in the background.
Relates to #3162

💚 How did you test it?

Unit tests
Added Ui test to check it waits for network to timeout on Sentry.close and doesn't wait on multiple Sentry.init()

📝 Checklist

  • I reviewed the submitted code.
  • 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.
  • 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

@stefanosiano
added new methods to close instances with isRestarting flag:
c70066f 
- IHub.close(Boolean)
- ISentryClient.close(Boolean)
- ITransport.close(Boolean)

when the SDK restarts, the executor service is now closed in the background, and current network connections are dropped
@stefanosiano
updated changelog
be25954
@stefanosiano
stefanosiano marked this pull request as ready for review February 8, 2024 11:45
@github-actions

github-actions Bot commented Feb 8, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Performance metrics 🚀

  Plain With Sentry Diff
Startup time 439.57 ms 518.85 ms 79.28 ms
Size 1.70 MiB 2.27 MiB 585.11 KiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
93a76ca 377.96 ms 447.52 ms 69.56 ms
baaf637 462.32 ms 579.22 ms 116.90 ms
2465853 411.39 ms 461.10 ms 49.72 ms
c3f503e 360.41 ms 434.67 ms 74.27 ms
93a76ca 381.08 ms 459.22 ms 78.14 ms
c7e2fbc 393.98 ms 478.24 ms 84.27 ms
2465853 422.61 ms 491.20 ms 68.58 ms
5e04ee8 302.68 ms 343.36 ms 40.68 ms
283d83e 416.81 ms 497.22 ms 80.41 ms
d6d2b2e 413.20 ms 486.76 ms 73.56 ms

App size

Revision Plain With Sentry Diff
93a76ca 1.72 MiB 2.29 MiB 576.75 KiB
baaf637 1.72 MiB 2.27 MiB 558.42 KiB
2465853 1.70 MiB 2.27 MiB 583.82 KiB
c3f503e 1.72 MiB 2.29 MiB 577.04 KiB
93a76ca 1.72 MiB 2.29 MiB 576.75 KiB
c7e2fbc 1.72 MiB 2.29 MiB 576.40 KiB
2465853 1.70 MiB 2.27 MiB 583.82 KiB
5e04ee8 1.70 MiB 2.27 MiB 584.64 KiB
283d83e 1.72 MiB 2.29 MiB 577.69 KiB
d6d2b2e 1.72 MiB 2.27 MiB 555.05 KiB

Previous results on branch: enh/dont-wait-restart

Startup times

Revision Plain With Sentry Diff
588e62b 318.55 ms 360.32 ms 41.77 ms
0807309 368.15 ms 456.16 ms 88.02 ms
866a6af 614.82 ms 743.69 ms 128.87 ms
0d43908 410.02 ms 483.90 ms 73.88 ms
0e03bb0 367.81 ms 440.85 ms 73.05 ms
4dc1651 376.40 ms 456.41 ms 80.01 ms

App size

Revision Plain With Sentry Diff
588e62b 1.70 MiB 2.27 MiB 584.99 KiB
0807309 1.70 MiB 2.27 MiB 585.11 KiB
866a6af 1.70 MiB 2.27 MiB 585.11 KiB
0d43908 1.70 MiB 2.27 MiB 585.00 KiB
0e03bb0 1.70 MiB 2.27 MiB 584.98 KiB
4dc1651 1.70 MiB 2.27 MiB 585.11 KiB

@stefanosiano
stefanosiano marked this pull request as draft February 8, 2024 15:01
@stefanosiano

stefanosiano commented Feb 9, 2024

Copy link
Copy Markdown
Contributor Author

I added a small timeout to AsyncHttpTransport when restarting, so that we have time to eventually write any rejected envelope to disk.
I don't really like it, so I'm trying to find a way to improve it

@stefanosiano
AsyncHttpTransport.close will now run executing runnables through rej…
54f4151 
…ectedExecutionHandler, to save the envelope to disk
@stefanosiano

stefanosiano commented Feb 9, 2024

Copy link
Copy Markdown
Contributor Author

I added a small timeout to AsyncHttpTransport when restarting, so that we have time to eventually write any rejected envelope to disk. I don't really like it, so I'm trying to find a way to improve it

Ok, I removed that small timeout. Now, when AsyncHttpTransport closes and calls executor.shutdownNow(), all the current runnables go throught the rejectedExecutionHandler, that store the envelope to disk

@stefanosiano
stefanosiano marked this pull request as ready for review February 9, 2024 11:35
markushi
markushi requested changes Feb 13, 2024
View reviewed changes

@markushi markushi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looking good, I left 2 comments for clarification!

Comment thread ...on-tests/sentry-uitest-android/src/androidTest/java/io/sentry/uitest/android/SdkInitTests.kt Outdated
Comment thread sentry/src/main/java/io/sentry/transport/AsyncHttpTransport.java Outdated
markushi
markushi reviewed Feb 16, 2024
View reviewed changes
Comment thread sentry/src/test/java/io/sentry/transport/AsyncHttpTransportTest.kt
}

@Test
fun `close shuts down the executor and runs executing runnable through rejectedExecutionHandler`() {

@markushi markushi Feb 16, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍

markushi
markushi approved these changes Feb 16, 2024
View reviewed changes

@markushi markushi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@stefanosiano
stefanosiano merged commit f33a11d into main Feb 16, 2024
@stefanosiano
stefanosiano deleted the enh/dont-wait-restart branch February 16, 2024 10:48
@stefanosiano stefanosiano mentioned this pull request May 22, 2024
Closed
@romtsn romtsn mentioned this pull request Jun 3, 2024
Closed
@buenaflor buenaflor mentioned this pull request Jun 17, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markushi markushi markushi approved these changes
@adinauer adinauer Awaiting requested review from adinauer adinauer is a code owner
@romtsn romtsn Awaiting requested review from romtsn romtsn is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@stefanosiano @markushi @getsentry-bot