Skip to content

Commit 39abb03

Browse files
authored
docs(perf): Clarify widget overall number values (#5402)
* Fix Markdown list formatting * Explain the overall value for widgets * Clarify User Misery statistics gotcha
1 parent 6522950 commit 39abb03

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

src/docs/product/performance/filters-display/widgets.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ description: "Learn more about Sentry's Performance widgets such as, Most Relate
77
Performance widgets offer visualizations that you can change to best match your workflow. They provide performance-specific views that allow you see and act on transaction data across your organization.
88
Depending on which **Performance** tab you've selected, different curated performance widgets will be available.
99

10+
<Note>
11+
12+
The value displayed in the top right of some widgets is the overall value for the selected time period, rather than the average of the data displayed in the chart. For data sets with low event volume the overall value may be higher or lower than expected due to the non-linear nature of metrics like [Apdex](/product/performance/metrics/#apdex) and [User Misery](/product/performance/metrics/#user-misery).
13+
14+
</Note>
15+
1016
## Most Improved
1117

1218
Shows the most improved transactions and visualizes the improvement for the selected transaction in the list. Only trends of a specific significance and throughput are shown. Learn more in [Trends](/product/performance/trends).

src/docs/product/performance/metrics.mdx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ Apdex is an industry-standard metric used to track and measure user satisfaction
1414

1515
Below are the components of Apdex and its formula:
1616

17-
* **T**: Threshold for the target response time.
18-
* **Satisfactory**: Users are satisfied using the app when their page load times are less than or equal to T.
19-
* **Tolerable**: Users consider the app tolerable to use when their page load times are greater than T and less than or equal to 4T.
20-
* **Frustrated**: Users are frustrated with the app when their page load times are greater than 4T.
21-
* **Apdex**: (Number of Satisfactory Requests + (Number of Tolerable Requests/2)) / (Number of Total Requests)
17+
- **T**: Threshold for the target response time.
18+
- **Satisfactory**: Users are satisfied using the app when their page load times are less than or equal to T.
19+
- **Tolerable**: Users consider the app tolerable to use when their page load times are greater than T and less than or equal to 4T.
20+
- **Frustrated**: Users are frustrated with the app when their page load times are greater than 4T.
21+
- **Apdex**: (Number of Satisfactory Requests + (Number of Tolerable Requests/2)) / (Number of Total Requests)
2222

2323
Configure what a satisfactory response time threshold (ms) is for Apdex in **Settings > Performance**. You can set this for each project with [custom thresholds](#custom-thresholds).
2424

@@ -81,6 +81,12 @@ User Misery is a user-weighted performance metric to assess the relative magnitu
8181

8282
You can set satisfactory thresholds for each project with [custom thresholds](#custom-thresholds).
8383

84+
<Note>
85+
86+
User Misery is calculated using a probability distribution. This prevents false positives and ensures reasonable values for data sets with low event volume. You can view the underlying data by querying for the [`count_miserable()` function](/product/discover-queries/query-builder/#stacking-functions).
87+
88+
</Note>
89+
8490
## Custom Thresholds
8591

8692
For each project, you can configure how [Apdex](#apdex) and [User Misery](#user-misery) are calculated in **[Project] > Settings > Performance**. You can override project-level settings at the transaction level in **Transaction Summary > Settings**.

0 commit comments

Comments
 (0)