Skip to content

Add close( ) method to Apple drain doc #13492

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sfanahata
Copy link
Contributor

@sfanahata sfanahata commented Apr 23, 2025

DESCRIBE YOUR PR

Updating the Apple drain doc to include the close ( ) method.

Liked to #13468

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Copy link

vercel bot commented Apr 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 23, 2025 11:59pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Apr 23, 2025 11:59pm
develop-docs ⬜️ Ignored (Inspect) Apr 23, 2025 11:59pm

Copy link

codecov bot commented Apr 23, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.14MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.47MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/bZQiQ8v3zAjABghGGEIn2/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/bZQiQ8v3zAjABghGGEIn2/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/u0nHB4m73pcn1W0NWXJDE/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/u0nHB4m73pcn1W0NWXJDE/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Comment on lines +7 to +10
Calling `close()` before exiting the application is critical to avoid data loss.

After closing, the client cannot be used anymore. It's important to only call
`close()` immediately before shutting down the application.
Copy link
Member

Choose a reason for hiding this comment

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

That's not accurate for the mobile SDKs. Mobile SDKs use an offline cache, and you don't have to call close before the app exits. All SDKs ensure that no data is lost when the app is put to the background and / or exits. The close method on mobile SDKs exists so users can manually close the SDK. Close shuts down the SDK and tries to send all data to Sentry. Most of the time users don't have to use this.

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