Update Profiling index page docs #13198
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will decrease total bundle size by 465 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
| </Alert> | ||
|
|
||
| Sentry's profiling feature builds upon our established [Insights](/product/insights) capabilities to provide precise code-level visibility into application execution in a production environment. Profiling provides context at a deeper level than traditional tracing, enabling you to visualize the precise details of the call stack without the need for custom instrumentation. With Profiling you can quickly identify hot paths in your code and understand potential performance bottlenecks, enabling you to build in [performance as a feature](https://blog.codinghorror.com/performance-is-a-feature/) from day one. | ||
| Sentry’s Profiling products provide precise, code-level visibility into application execution in a production environment. Profiling provides context at a deeper level than traditional [tracing](/concepts/key-terms/tracing/), enabling you to visualize call stacks on every thread without the need for custom instrumentation. With Profiling you can quickly identify hot paths in your code and understand potential performance bottlenecks, enabling you to build in [performance as a feature](https://blog.codinghorror.com/performance-is-a-feature/) from day one. |
There was a problem hiding this comment.
@indragiek - is there an opportunity earlier in this page to more explicitly call out a "When would you use Profiling" so that if someone lands on this page, they immediately know why to dig in? We talk about it throughout the page (especially in that paragraph), and the content is incredibly good - but in other parts of the page it might take some digging.
We hit some of the first sentences of this in the description of the index section, so it might be a good idea to replace some of the directly repetitive with some direct bullets around when to use profiling -
Sentry's profiling products are useful when you...
- Want a deeper view into the individual calls that are causing performance issues
- Want to understand the performance of individual calls within your application code
- Want to visualize the call stack of every thread without custom instrumentation
- Need to identify hot paths in your code and how they create performance bottlenecks
Profiling enables you to build in... etc
Food for though; intention is to get people to immediately connect with why they are here and what they are going to do.
|
This looks great @indragiek! I had one comment on a suggestion to create a more direct call out of "when to use profiling"; but other than that - this is awesome. |
| ### Aggregate Flamegraph Tab | ||
|
|
||
| ## Profiling Summary Page | ||
| The **Aggregate Flamegraph** tab shows a [flame graph](/product/explore/profiling/flame-charts-graphs) with aggregated information on the frequency of code paths within the selected projects. |
There was a problem hiding this comment.
I notice you are using both 'flamegraph' and 'flame graph' here, is there a distinction here or can we keep it to one convention?
There was a problem hiding this comment.
Yeah we've been inconsistent with that in the ast, the one we want to consolidate on is "flame graph" but there are places in the product where we still use the other one (e.g. the Aggregate Flamegraph tab referenced here). I believe this might be the only place in the product remaining that uses the wrong convention. I'll do an audit later and once we fix those in the product I'll open a separate docs PR to change it here and all the other places where it's inconsistent.
Thank you for the attention to detail!
coolguyzone
left a comment
coolguyzone
left a comment
There was a problem hiding this comment.
Added a couple comments, but overall looks good!
Co-authored-by: Alex Krawiec <[email protected]>
codyde
left a comment
codyde
left a comment
There was a problem hiding this comment.
This is great. Love the changes. LGTM!
* Update Profiling index page docs * Consistency fixes * Remove unused asset * Apply suggestions from code review Co-authored-by: Alex Krawiec <[email protected]> * Address Cody's feedback --------- Co-authored-by: Alex Krawiec <[email protected]>
DESCRIBE YOUR PR
Update existing Profiling index page documentation to be consistent with UX updates for the Continuous & UI Profiling update.
These docs need to go live for April 9th, 2025 when Continuous & UI Profiling are GA.
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: