Skip to content

Commit

Permalink
docs(profiling): Update profiling landing docs with function widgets (#…
Browse files Browse the repository at this point in the history
…7588)

* docs(profiling): Update profiling landing docs with function widgets

The profiling page got some new functions level widgets, update the docs to
reflect this change.

* style(lint): Auto commit lint changes

* update wording

* Update src/docs/product/profiling/index.mdx

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>

* Update index.mdx

* style(lint): Auto commit lint changes

* style(lint): Auto commit lint changes

---------

Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
  • Loading branch information
3 people committed Aug 3, 2023
1 parent 6677d63 commit 3a4eb9e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/docs/product/profiling/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,15 @@ From this view, you can also click "View Profile" to zoom in on the flame chart.

## Profiling Page

The **Profiling** page shows a list of transactions in descending order of execution time for your selected project(s). It also shows details about the three "Slowest Transactions" including a list of the slowest identified functions in that transaction. The "Profiles by Percentiles" timeline chart can be used to filter the transaction data by highlighting the desired time period. Using the Profiling page is typically an advanced workflow, enabling you to directly select transactions of interest and examine detailed profiling data.
The **Profiling** page shows a list of transactions in descending order of execution time for your selected project(s).

![Profiling page](profiling-page-view.png)

To zoom in further, select from the list of "Slowest App Functions" and see the associated flame chart for the profile.
The "Profiles by Percentiles" timeline chart can be used to filter the transaction data by highlighting the desired time period. Below that, there are three widgets to choose from.

The "Suspect Functions" widget shows you a list of the functions that took the most time in your application. It lists the transactions the function was called from. Clicking on a transaction will take you to an example profile. The "Most Regressed Functions" and "Most Improved Functions" widgets show you a list of the functions that have gotten slower/faster over time. Clicking on the timings will take you to an example from either before/after the detected regression/improvement.

Using the Profiling page is typically an advanced workflow, enabling you to directly select transactions of interest and examine detailed profiling data.

Selecting one of the transactions will take you to the **Profile Summary** page below. On this page, you can examine the consolidated [flame graph](/product/profiling/flame-charts-graphs) that presents aggregated sample data for the selected transaction.

Expand Down
Binary file modified src/docs/product/profiling/profiling-page-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 3a4eb9e

@vercel
Copy link

@vercel vercel bot commented on 3a4eb9e Aug 3, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

sentry-docs – ./

sentry-docs-git-master.sentry.dev
docs.sentry.io
sentry-docs.sentry.dev

Please sign in to comment.