Skip to content

Commit

Permalink
docs(dashboards): Releases in Dashboards (#5083)
Browse files Browse the repository at this point in the history
Documentation for the Releases widget in Dashboard
  • Loading branch information
shruthilayaj authored Jun 8, 2022
1 parent 1661734 commit 407365f
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 14 deletions.
34 changes: 22 additions & 12 deletions src/docs/product/dashboards/widget-builder/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ Area, bar, and line chart visualizations allow you to plot one or more aggregate

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

Each chart type allows you to solve different problems:
Each chart type allows you to solve different problems:

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

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

### Errors & Transactions

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

- Tracking performance of an endpoint
- Throughput by country
- Tracking performance of an endpoint
- Throughput by country
- Users most affected by errors

### Issues
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.
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.
Choose this dataset if you want to customize a list of issues on your dashboard. Some widget examples include:

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

### Releases

<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 (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:
- Crash rates for your latest release
- Session count across releases

## Choose Your Columns

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

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

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

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:

Expand Down Expand Up @@ -127,6 +140,3 @@ The option to sort by a y-axis is only available if you've applied a grouping to
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:

![Custom equation field.](widget-builder-custom-equation-field.png)



31 changes: 29 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,22 @@ 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, represented in an area chart
- **High Throughput Transactions**: The top five transactions with the largest number of events, represented in an area chart
- **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 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

<Note>

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

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

Expand Down Expand Up @@ -90,3 +99,21 @@ 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

<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 as follows:

- Visualization Display: `Area Chart`

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

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

1 comment on commit 407365f

@vercel
Copy link

@vercel vercel bot commented on 407365f Jun 8, 2022

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

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

Please sign in to comment.