Skip to content

Commit 407365f

Browse files
authored
docs(dashboards): Releases in Dashboards (#5083)
Documentation for the Releases widget in Dashboard
1 parent 1661734 commit 407365f

File tree

2 files changed

+51
-14
lines changed

2 files changed

+51
-14
lines changed

src/docs/product/dashboards/widget-builder/index.mdx

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ Area, bar, and line chart visualizations allow you to plot one or more aggregate
3838

3939
![Time-series visualizations.](widget-builder-time-series-visualizations.png)
4040

41-
Each chart type allows you to solve different problems:
41+
Each chart type allows you to solve different problems:
4242

43-
- Area charts are ideal for showing results that are cumulative or where you want to show a breakdown. An example would be “count of errors for each major browser”.
44-
- Bar charts will group results by day, making them good for daily roll-ups or as “big picture” summaries. An example would be “count of errors per day”.
43+
- Area charts are ideal for showing results that are cumulative or where you want to show a breakdown. An example would be “count of errors for each major browser”.
44+
- Bar charts will group results by day, making them good for daily roll-ups or as “big picture” summaries. An example would be “count of errors per day”.
4545
- Line charts are a general-purpose visualization. Make sure the Y-Axis units match if you add multiple overlays. Mixing count with duration will not yield useful results.
4646

4747
### Table
@@ -62,20 +62,33 @@ In the dataset selection step, choose which type of data you would like to use i
6262

6363
### Errors & Transactions
6464

65-
Choosing "Errors and Transactions" allows you to query and aggregate error and transaction events in the same way you would for a [Discover Query](/product/discover-queries/). Some widget examples include:
65+
Choosing "Errors and Transactions" allows you to query and aggregate error and transaction events in the same way you would for a [Discover Query](/product/discover-queries/). Some widget examples include:
6666

67-
- Tracking performance of an endpoint
68-
- Throughput by country
67+
- Tracking performance of an endpoint
68+
- Throughput by country
6969
- Users most affected by errors
7070

7171
### Issues
72-
Choosing "Issues (States, Assignment, Time, etc.)" allows you to query issue properties, such as `is:unresolved` or event properties such as `error.handled:0`, and to sort by issue fields such as `First Seen`. When searching on event properties, the search will return any issue that has one or more events matching the supplied event filters.
72+
Choosing "Issues (States, Assignment, Time, etc.)" allows you to query issue properties, such as `is:unresolved` or event properties such as `error.handled:0`, and to sort by issue fields such as `First Seen`. When searching on event properties, the search will return any issue that has one or more events matching the supplied event filters.
7373
Choose this dataset if you want to customize a list of issues on your dashboard. Some widget examples include:
7474

75-
- Issues assigned to your team
75+
- Issues assigned to your team
7676
- Most frequently occurring issues
7777
- The "Issues" dataset is only available in table visualization widgets and its disabled if you have other visualizations selected.
7878

79+
### Releases
80+
81+
<Note>
82+
83+
This feature is available only if you're in the Early Adopter program. Features available to Early Adopters are still in-progress and may have bugs. We recognize the irony.
84+
If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in General Settings. This will affect all users in your organization and can be turned back off just as easily.
85+
86+
</Note>
87+
88+
Choosing "Releases (sessions, crash rates)" allows you to query properties specific to a release of your application, primarily session data. Choose this dataset if you want to display healthy, errored, and crashed sessions and crash rates for your releases or projects on your dashboard. This dataset isn't available in for [world map](#world-map) visualizations. Some example widgets using this dataset include:
89+
- Crash rates for your latest release
90+
- Session count across releases
91+
7992
## Choose Your Columns
8093

8194
The option to set columns is only available for [table visualizations](/product/dashboards/widget-builder/#table).
@@ -84,7 +97,7 @@ By default, the first column is already configured for you, but you can update i
8497

8598
You can also add equations to your query using the table columns as equation variables, and the results will be displayed in the query results table. Learn more in [Adding Query Equations](/product/discover-queries/query-builder/query-equations/).
8699

87-
Next to each column and equation, you have the option to set an alias that will replace the column name in the table header.
100+
Next to each column and equation, you have the option to set an alias that will replace the column name in the table header.
88101

89102
If two or more columns are added, you can change the order in which they're displayed in the table by clicking and dragging them:
90103

@@ -127,6 +140,3 @@ The option to sort by a y-axis is only available if you've applied a grouping to
127140
If you select “Custom Equation”, an extra field appears where you can enter an equation of your choice that will be applied to the query:
128141

129142
![Custom equation field.](widget-builder-custom-equation-field.png)
130-
131-
132-

src/docs/product/dashboards/widget-library/index.mdx

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,22 @@ The widget library contains a collection of prebuilt widgets you can add to your
1515
The library includes the following widgets:
1616

1717
- **Duration Distribution**: A multi-overlay chart visualizing the distribution of transaction duration across various percentiles (p50, p75, and p95)
18-
- **High Throughput Transactions**: The top five transactions with the largest number of events, represented in an area chart
18+
- **High Throughput Transactions**: The top five transactions with the largest number of events, represented in an area chart
1919
- **LCP by Country**: World map showing the p75 of page load times for each country
2020
- **Miserable Users**: The total number of unique users who have experienced slow transactions (transaction duration greater than 1200ms)
2121
- **Slow vs. Fast Transactions**: Bar chart comparing the percentage of transactions that are over 300ms (slow) and under 300ms (fast)
2222
- **Issues For Review**: A table of unresolved issues for review, ordered by the most recently seen issues
23-
- **Top Unhandled Error Types**: The top five most frequently encountered unhandled errors
23+
- **Top Unhandled Error Types**: The most frequently encountered unhandled errors
2424
- **Users Affected by Errors**: A comparison of the total number of errors and the number of unique users affected by the errors
25+
- **Crash Rates for Recent Releases**: Percentage of crashed sessions for your recent releases
26+
- **Session Health**: The total number of abnormal, crashed, errored, and healthy sessions
27+
28+
<Note>
29+
30+
The Crash Rates for Recent Releases and Session Health widgets are available only if you're in the Early Adopter program. Features available to Early Adopters are still in-progress and may have bugs. We recognize the irony.
31+
If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in General Settings. This will affect all users in your organization and can be turned back off just as easily.
32+
33+
</Note>
2534

2635
You can change the title, queries, fields, visualization types, sort order, and other fields of these prebuilt widgets to suit your use case by clicking the context menu on the widget and selecting "Edit Widget".
2736

@@ -90,3 +99,21 @@ Update "Columns" to add `links` so you can see seen any external links related t
9099

91100
- Columns: `issue, assignee, events, title, links`
92101
- Sort by: `Priority`
102+
103+
104+
### Release health
105+
106+
<Note>
107+
108+
This feature is available only if you're in the Early Adopter program. Features available to Early Adopters are still in-progress and may have bugs. We recognize the irony.
109+
If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in General Settings. This will affect all users in your organization and can be turned back off just as easily.
110+
111+
</Note>
112+
113+
To monitor the health of your releases over time, you can modify the "Session Health" widget as follows:
114+
115+
- Visualization Display: `Area Chart`
116+
117+
Add search filters to narrow the data down to a particular release:
118+
119+
- Search condition 1: `release:{version}`

0 commit comments

Comments
 (0)