Skip to content

docs(dashboards): Releases in Dashboards #5083

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

Merged
merged 12 commits into from
Jun 8, 2022
Merged
16 changes: 15 additions & 1 deletion src/docs/product/dashboards/custom-dashboards/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,29 @@ transactions'.

## Data Set Selection
Copy link
Contributor

Choose a reason for hiding this comment

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

I've made the wording edits that will apply on this page, but most of this content is being moved to a new page in PR 5065.


Select between events and [issues](/product/issues/) data in a widget with the "Data Set" selector.
Select between events, [issues](/product/issues/) and [release health](/product/releases/health/) data in a widget with the "Data Set" selector.

### All Events
Choosing "All Events" 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:
- Tracking performance of an endpoint
- Throughput by country
- Users most affected by errors

### Issues
Choosing "Issues" 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. Choose this data set if you want to customize a list of issues on your dashboard. Some widget examples include:
- Issues assigned to your team
- Most frequently occurring issues

The "Issues" data set is only available in [table](#table-results) visualization widgets.

### Releases
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
### Releases
### Releases

Copy link
Member Author

Choose a reason for hiding this comment

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

<Note>

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.
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.

</Note>

Choosing "Releases" allows you to query properites specific to a release of your application, primarily session data. Choose this data set if you want to display healthy, errored and crashed sessions and crash rates for your releases or projects on your dashboard. Doesn't apply to World Map. Some widget examples include:
Copy link
Contributor

Choose a reason for hiding this comment

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

I've made the wording edits here, but this will end up living on a new page entirely

Suggested change
Choosing "Releases" allows you to query properites specific to a release of your application, primarily session data. Choose this data set if you want to display healthy, errored and crashed sessions and crash rates for your releases or projects on your dashboard. Doesn't apply to World Map. Some widget examples include:
Choosing "Releases" 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:

Copy link
Member Author

Choose a reason for hiding this comment

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

- Crash rates for your latest release
- Session count across releases
28 changes: 26 additions & 2 deletions src/docs/product/dashboards/widget-library/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ The widget library contains a collection of prebuilt widgets you can add to your
The library includes the following widgets:

- **Duration Distribution**: A multi-overlay chart visualizing the distribution of transaction duration across various percentiles (p50, p75, and p95)
- **High Throughput Transactions**: The top five transactions with the largest number of events
- **High Throughput Transactions**: The top transactions with the largest number of events
- **LCP by Country**: World map showing the p75 of page load times for each country
- **Miserable Users**: The total number of unique users who have experienced slow transactions (transaction duration greater than 1200ms)
- **Slow vs. Fast Transactions**: Bar chart comparing the percentage of transactions that are over 300ms (slow) and under 300ms (fast)
- **Issues For Review**: A table of unresolved issues for review, ordered by the most recently seen issues
- **Top Unhandled Error Types**: The top five most frequently encountered unhandled errors
- **Top Unhandled Error Types**: The top most frequently encountered unhandled errors
- **Users Affected by Errors**: A comparison of the total number of errors and the number of unique users affected by the errors
- **Crash Rates for Recent Releases**: Percentage of crashed sessions for your recent releases
- **Session Health**: The total number of abnormal, crashed, errored and healthy sessions
Copy link
Member Author

Choose a reason for hiding this comment

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

these two widget are only available for EA, should there be an indication of that?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, let's add a note after the list: "The Crash Rates for Recent Releases and Session Health widgets are only available..."

Copy link
Member Author

Choose a reason for hiding this comment

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


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

Expand Down Expand Up @@ -90,3 +92,25 @@ Update "Columns" to add `links` so you can see seen any external links related t

- Columns: `issue, assignee, events, title, links`
- Sort by: `Priority`


### Release Health
Copy link
Contributor

Choose a reason for hiding this comment

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

We've done sentence case on all the other ones so let's keep it consistent

Suggested change
### Release Health
### Release health

Copy link
Member Author

Choose a reason for hiding this comment

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


<Note>

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.
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.

</Note>

To monitor the health of your releases over time, you can modify the "Session Health" widget by updating the "Visualization Display" to "Area Chart":

- Visualization Display: `Area Chart`

Add search filters to narrow the data down to a particular release:

- Search condition 1: `release:{version}`

To monitor the health of your latest releases, update the Search condition to use the `latest` keyword:
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
To monitor the health of your latest releases, update the Search condition to use the `latest` keyword:
To monitor the health of your latest releases, update the search condition to use the `latest` keyword:

Copy link
Member Author

Choose a reason for hiding this comment

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


- Search condition 1: `release:latest`