Skip to content

Conversation

@armcknight
Copy link
Member

@armcknight armcknight commented Apr 1, 2025

DESCRIBE YOUR PR

Update the Apple profiling docs to explain the new iteration of profiling and the deprecation of all prior versions of the API.

For getsentry/sentry-cocoa#4996

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.): Wednesday, April 9, 2025
  • 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

@vercel
Copy link

vercel bot commented Apr 1, 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 4, 2025 9:53pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Apr 4, 2025 9:53pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Apr 4, 2025 9:53pm

@armcknight armcknight changed the title feat(profiling[cocoa]): update docs for profiling v2 feat(profiling): update docs for profiling v2 Apr 1, 2025
@armcknight armcknight changed the title feat(profiling): update docs for profiling v2 feat: update docs for profiling v2 Apr 1, 2025
@codecov
Copy link

codecov bot commented Apr 1, 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 10.61MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.45MB -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.58MB -0.0%
../instrumentation.js -3 bytes 911.63kB -0.0%
9523.js -3 bytes 887.68kB -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.67kB -0.0%
static/chunks/8931-*.js -3 bytes 397.42kB -0.0%
static/PdXHrvLv4tlPh3CCQxwTm/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/PdXHrvLv4tlPh3CCQxwTm/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/4kktX9LOyah2D8t1bHF6l/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/4kktX9LOyah2D8t1bHF6l/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

@armcknight
Copy link
Member Author

Tracking the release of the associated feature at getsentry/sentry-cocoa#4952

@sfanahata
Copy link
Contributor

@armcknight Looks good overall. I left a few suggestions to make the wording a bit clearer.

Copy link
Contributor

@sfanahata sfanahata left a comment

Choose a reason for hiding this comment

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

Nothing blocking, but some changes I suggested for clarity would be helpful.

armcknight and others added 3 commits April 4, 2025 13:08
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
armcknight and others added 3 commits April 4, 2025 13:21
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
Copy link
Member

@indragiek indragiek left a comment

Choose a reason for hiding this comment

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

looks good!

@kahest kahest merged commit e2f4526 into master Apr 9, 2025
11 checks passed
@kahest kahest deleted the armcknight/profiling/feat/continuous-v2 branch April 9, 2025 16:50
bitsandfoxes pushed a commit that referenced this pull request Apr 24, 2025
* feat(profiling[cocoa]): update docs for profiling v2

* add example of manual profiling

* improve table view example

* Update docs/platforms/apple/common/profiling/index.mdx

Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>

* Update docs/platforms/apple/common/profiling/index.mdx

Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>

* Update docs/platforms/apple/common/profiling/index.mdx

Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>

* Apply suggestions from code review

Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>

* pr feedback

* more feedback

---------

Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
@github-actions github-actions bot locked and limited conversation to collaborators Apr 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants