Skip to content
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

feat(profiling): add differential flamegraph docs #8657

Merged
merged 29 commits into from
Jan 18, 2024

Conversation

JonasBa
Copy link
Member

@JonasBa JonasBa commented Dec 6, 2023

New docs on differential flamegraph feature.

@shanamatthews, do we auto optimize these images or should I do this manually?

Please do not merge as the feature isn't actually released yet

@JonasBa JonasBa requested a review from lizokm December 6, 2023 22:50
Copy link

vercel bot commented Dec 6, 2023

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

Name Status Preview Comments Updated (UTC)
sentry-docs 🛑 Canceled (Inspect) Dec 21, 2023 2:19pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
sentry-docs-next ⬜️ Ignored (Inspect) Visit Preview Dec 21, 2023 2:19pm

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

This looks great! I've made some language tweaks, and there's one part I'd like to clarify so I've scheduled a few minutes for us to talk on Monday :)

src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
JonasBa and others added 24 commits December 7, 2023 08:41
Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Looking good! Made just a few more tweaks, but I think it's ready to go.

src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
Comment on lines +33 to +34
If you look closely, you'll notice that the top right corner has a `Before -> After` and `After -> Before` toggle. This is because by default, differential flamegraphs draw the aggregate flamegraph from after a regression has occured as the source of truth. This means that any code that may have been removed, will no longer be drawn (after all, it's not there anymore). This is why negating the view is useful, as it allows us to compare the data from before and peek into the future of how our code will change.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you look closely, you'll notice that the top right corner has a `Before -> After` and `After -> Before` toggle. This is because by default, differential flamegraphs draw the aggregate flamegraph from after a regression has occured as the source of truth. This means that any code that may have been removed, will no longer be drawn (after all, it's not there anymore). This is why negating the view is useful, as it allows us to compare the data from before and peek into the future of how our code will change.
The top left corner has a `Before -> After` and `After -> Before` toggle. This is because it's helpful to be able to view data from **before a regression occurred** and compare it with data after the regression. This is a different view than a differential flamegraph, which shows the aggregate flamegraph drawn right **after a regression has occurred**.

@JonasBa let me know if this makes sense :)

src/docs/product/profiling/differential-flamegraphs.mdx Outdated Show resolved Hide resolved
@getsantry
Copy link
Contributor

getsantry bot commented Jan 12, 2024

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you remove the label Waiting for: Community, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot added the Stale label Jan 12, 2024
@JonasBa JonasBa merged commit 6bcaa4e into master Jan 18, 2024
9 checks passed
@JonasBa JonasBa deleted the jb/feat/differential-flamegraph-docs branch January 18, 2024 14:16
@github-actions github-actions bot locked and limited conversation to collaborators Feb 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants