Skip to content

profiling(cocoa): add note about stopping launch profiler #13871

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

armcknight
Copy link
Member

DESCRIBE YOUR PR

As noted here: getsentry/sentry-cocoa#3637 (comment)

We have a limitation where we cannot control what happens to a launch profiler if the SDK is never started after a profiled app launch.

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented May 29, 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 May 29, 2025 10:07pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) May 29, 2025 10:07pm
develop-docs ⬜️ Ignored (Inspect) May 29, 2025 10:07pm

@armcknight
Copy link
Member Author

I'm not able to see why vercel failed
image

Copy link

codecov bot commented May 29, 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.22MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.77MB -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%
static/ZUUNnuR-*.js (New) 616 bytes 616 bytes 100.0% 🚀
static/ZUUNnuR-*.js (New) 77 bytes 77 bytes 100.0% 🚀
static/mYHKibJ3638MnhvYaEL_G/_buildManifest.js (Deleted) -616 bytes 0 bytes -100.0% 🗑️
static/mYHKibJ3638MnhvYaEL_G/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Copy link
Contributor

@philprime philprime left a comment

Choose a reason for hiding this comment

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

LGTM, left one comment for potential improvement.

@@ -130,6 +130,10 @@ If configured with trace lifecycle, app start profiles are attached to a special

Every time `SentrySDK.startWithOptions` is called with app start profiling configured, a separate sample decision is generated with `sessionSampleRate` and stored until the next app launch (as well as `tracesSampleRate` if trace profile lifecycle is configured). The same sample decision will apply for the remainder of the profile session following that subsequent launch.

<Alert>
If the SDK does not start on the same launch as a launch profiler is running, the profiler will run for the duration of that user session. Ensure proper configuration if you selectively start the Sentry SDK along with launch profiling.
Copy link
Contributor

Choose a reason for hiding this comment

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

m: Maybe we should explain here what "proper configuration" means.

@@ -130,6 +130,10 @@ If configured with trace lifecycle, app start profiles are attached to a special

Every time `SentrySDK.startWithOptions` is called with app start profiling configured, a separate sample decision is generated with `sessionSampleRate` and stored until the next app launch (as well as `tracesSampleRate` if trace profile lifecycle is configured). The same sample decision will apply for the remainder of the profile session following that subsequent launch.

<Alert>
If the SDK does not start on the same launch as a launch profiler is running, the profiler will run for the duration of that user session. Ensure proper configuration if you selectively start the Sentry SDK along with launch profiling.
Copy link
Contributor

Choose a reason for hiding this comment

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

If the SDK does not start on the same launch as a launch profiler is running, the profiler will run for the duration of that user session. 

I'm having a little bit of trouble parsing this first sentence. Can you clarify a little bit? Would something like "...the same launch as the one where the profiler is running" make sense?

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.

3 participants