Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
id: configure-release-views
title: Configuring Release Views
sidebar_label: Configuring Release Views
description: Choose the error type, set the version attribute, select the releases to compare, and filter the Releases view.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

Use the controls at the top of the **Releases** view to choose which errors to analyze, how releases are identified, and which releases to compare. The charts and comparison table update automatically when you change these settings.

## Choose the Error Type

The **Error type** dropdown filters the metrics on the page to a specific type of error. Each option shows the number of errors reported for that type.

**Step 1:** Click the **Error type** dropdown.

<img src={useBaseUrl('img/error-reporting/project-releases/configure-views/configure-views-1.png')} alt="Error type dropdown at the top of the Releases view" />

**Step 2:** Select **All**, or a single error type such as **Unhandled exception**, **Exception**, **Crash**, **Hang**, or **Low memory**.

The available error types depend on the errors reported by your project, so your options may differ. The number next to each option shows the error count for the selected time frame.

<img src={useBaseUrl('img/error-reporting/project-releases/configure-views/configure-views-2.png')} alt="Error type dropdown expanded with the error count for each type" />

:::tip
Select **Crash** or **Hang** to compare releases by the errors that disrupt users the most.
:::

## Set the Version Attribute

The **Compare releases by** dropdown determines which attribute is used to identify releases. For example, selecting `application.version` groups the data by application version.

Check warning on line 32 in docs/error-reporting/project-releases/configure-release-views.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/project-releases/configure-release-views.md#L32 <sauce.Dropdown>

Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message":"Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'","location":{"path":"docs/error-reporting/project-releases/configure-release-views.md","range":{"start":{"line":32,"column":29},"end":{"line":32,"column":37}}},"severity":"WARNING","code":{"value":"sauce.Dropdown"}}

**Step 1:** Click the **Compare releases by** dropdown.

Check warning on line 34 in docs/error-reporting/project-releases/configure-release-views.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/project-releases/configure-release-views.md#L34 <sauce.Dropdown>

Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message":"Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'","location":{"path":"docs/error-reporting/project-releases/configure-release-views.md","range":{"start":{"line":34,"column":47},"end":{"line":34,"column":55}}},"severity":"WARNING","code":{"value":"sauce.Dropdown"}}

<img src={useBaseUrl('img/error-reporting/project-releases/configure-views/configure-views-3.png')} alt="Compare releases by dropdown at the top of the Releases view" />

**Step 2:** Select the attribute that represents a release in your project, such as `application.version`, `application.marketing_version`, or `backtrace.version`.

<img src={useBaseUrl('img/error-reporting/project-releases/configure-views/configure-views-4.png')} alt="Compare releases by dropdown expanded with the available version attributes" />

:::note
To use a custom attribute, make sure it's properly configured and indexed. Attributes that aren't indexed don't appear in the dropdown.

Check warning on line 43 in docs/error-reporting/project-releases/configure-release-views.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/project-releases/configure-release-views.md#L43 <sauce.Dropdown>

Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message":"Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'","location":{"path":"docs/error-reporting/project-releases/configure-release-views.md","range":{"start":{"line":43,"column":127},"end":{"line":43,"column":135}}},"severity":"WARNING","code":{"value":"sauce.Dropdown"}}
:::

## Select Releases to Compare

The **Comparing releases** dropdown lists the releases available for the selected attribute. Each release includes its total error count.

:::note
You can compare up to four releases at a time.
:::

**Step 1:** Click the **Comparing releases** dropdown.

Check warning on line 54 in docs/error-reporting/project-releases/configure-release-views.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/project-releases/configure-release-views.md#L54 <sauce.Dropdown>

Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message":"Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'","location":{"path":"docs/error-reporting/project-releases/configure-release-views.md","range":{"start":{"line":54,"column":46},"end":{"line":54,"column":54}}},"severity":"WARNING","code":{"value":"sauce.Dropdown"}}

<img src={useBaseUrl('img/error-reporting/project-releases/configure-views/configure-views-5.png')} alt="Comparing releases dropdown at the top of the Releases view" />

**Step 2:** Select the checkbox next to each release you want to compare. Clear the checkbox to remove a release from the comparison.

The selected releases appear in the dropdown. The number next to each release shows its error count.

Check warning on line 60 in docs/error-reporting/project-releases/configure-release-views.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/project-releases/configure-release-views.md#L60 <sauce.Dropdown>

Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message":"Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'","location":{"path":"docs/error-reporting/project-releases/configure-release-views.md","range":{"start":{"line":60,"column":37},"end":{"line":60,"column":45}}},"severity":"WARNING","code":{"value":"sauce.Dropdown"}}

<img src={useBaseUrl('img/error-reporting/project-releases/configure-views/configure-views-6.png')} alt="Comparing releases dropdown expanded with a checkbox and error count for each release" />

:::tip
Include at least one earlier release you know was stable, so you have a baseline to compare against.
:::

## Filter the View

The Releases view also responds to the project's selected **Time frame** and the global filter bar. You can combine these filters with the release controls to focus on specific data.

| Goal | How to do it |
| ----- | ----- |
| Monitor a release during its launch window | Set **Time frame** to the most recent couple of days. |
| Compare crashes only | Select **Crash** in the **Error type** dropdown. |

Check warning on line 75 in docs/error-reporting/project-releases/configure-release-views.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/project-releases/configure-release-views.md#L75 <sauce.Dropdown>

Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message":"Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'","location":{"path":"docs/error-reporting/project-releases/configure-release-views.md","range":{"start":{"line":75,"column":65},"end":{"line":75,"column":73}}},"severity":"WARNING","code":{"value":"sauce.Dropdown"}}
| Exclude development builds | If your release attribute follows a pattern that separates development builds from production builds, filter out non-production builds in the global filter bar. |
56 changes: 56 additions & 0 deletions docs/error-reporting/project-releases/release-health-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
id: release-health-metrics
title: Check Release Health Metrics
sidebar_label: Check Release Health Metrics
description: Track user adoption, error-free sessions, errors over time, and new errors over time for each release in the Releases view.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The **Releases** view includes four charts that help you monitor the health of each release over time. Each chart displays a separate line for each selected release, making it easier to compare release stability during and after a launch.

The charts use the **Error type**, time frame, and filters selected in the Releases view. The chart titles also reflect the attribute selected in **Compare releases by**, such as `application.version`.

<img src={useBaseUrl('img/error-reporting/project-releases/health-metrics/health-metrics-1.png')} alt="Error type dropdown at the top of the Releases view, above the health charts" />

## User Adoption

The **User adoption** chart shows the percentage of total user events associated with each release over time. Use this chart to understand how quickly users move to a new release.

Consider user adoption when reviewing the other health metrics. A release with fewer users may appear more stable because it has less traffic.

<img src={useBaseUrl('img/error-reporting/project-releases/health-metrics/health-metrics-2.png')} alt="User adoption chart with a line for each selected release" />

After a release launches, its user adoption should generally increase as users upgrade. Similar adoption levels across releases provide a better basis for comparing their health.

## Error-Free Sessions

The **Error-free application launches** chart shows the percentage of application launches for each release where no errors occurred. A higher percentage indicates a more stable release.

<img src={useBaseUrl('img/error-reporting/project-releases/health-metrics/health-metrics-3.png')} alt="Error-free application launches chart with a line for each selected release" />

Look for a release whose percentage remains consistently lower than the others. This can indicate that the release is experiencing more errors during application launches.

## Errors Over Time

The **Errors over time** chart shows the number of errors reported for each release over the selected time period. Use it to identify error spikes and monitor how a release performs after launch.

Hover over the chart to view the error count for each release at a specific point in time.

<img src={useBaseUrl('img/error-reporting/project-releases/health-metrics/health-metrics-4.png')} alt="Errors over time chart with a line for each selected release" />

Look for releases with significantly higher error counts than other releases with similar user adoption. Sharp increases or spikes may indicate a stability issue that requires investigation.

## New Errors Over Time

The **New Errors over time** chart shows the number of errors that have not been seen previously, grouped by release. Use this chart to identify errors that may have been introduced by a new release rather than existing errors or previously known issues.

Hover over the chart to view the new error count for each release at a specific point in time.

<img src={useBaseUrl('img/error-reporting/project-releases/health-metrics/health-metrics-5.png')} alt="New errors over time chart with a line for each selected release" />

A rise above zero shortly after a release is launched can indicate a potential regression. Investigate these new errors to determine whether they are related to the release.

:::note
When every chart drops to zero for all releases at the same time, it usually reflects a gap in incoming data rather than a real change in stability.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
id: stability-metrics-table
title: Stability Metrics Table
sidebar_label: Stability Metrics Table
description: Compare aggregated stability metrics and triage status for each release, and open a release in the Triage view.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The **Stability Metrics** table at the bottom of the **Releases** view provides an overview of the health and stability of each selected release. The table title includes the attribute used for comparison, such as **Compare groups by application.version**.

<img src={useBaseUrl('img/error-reporting/project-releases/stability-table/stability-table-1.png')} alt="Compare groups table with one row per selected release" />

## Metrics in the Table

| Ref. | Column | What it shows |
| ----- | ----- | ----- |
| 1 | Release | The release name and color, plus a link icon that opens the release in the Triage view. |
| 2 | User adoption | The release's share of user activity, as a percentage. |
| 3 | Error-free Application Launches | The percentage of application launches (sessions) in which no errors occurred. |
| 4 | Error-free users | The percentage of users who haven't experienced an error. |
| 5 | New errors | The number of errors never seen before this release. |
| 6 | Unique errors | The number of distinct errors reported for the release. |
| 7 | Total errors | The total number of errors reported for the release. |
| 8 | Triage status | A bar showing how the release's errors split across triage states, labeled with the largest state, its error count, and its share. |

<img src={useBaseUrl('img/error-reporting/project-releases/stability-table/stability-table-2.png')} alt="Compare groups table with each column numbered" />

### Understand Triage Status

The **Triage status** column shows the distribution of errors across different triage states.

For example, **in-progress (316) 94.33%** means that 316 of the release's 335 total errors, or 94.33%, are in progress.

### Understand Percentage Metrics

Percentage-based metrics include a visual bar below the value. The dark portion represents the reported percentage, while the gray portion represents the remaining percentage up to 100%. This makes it easier to compare values across releases.

### View Details for a Percentage Metric

Hover over a percentage metric to view the numbers used to calculate it.

For example, hovering over **Error-free Application Launches** displays the number of error-free launches and the total number of launches.

## Open a Release in Triage

You can open a release directly in the **Triage** view to investigate its errors.

**Step 1:** Find the release you want to investigate in the table and click the **link icon** next to the release name.

<img src={useBaseUrl('img/error-reporting/project-releases/stability-table/stability-table-3.png')} alt="Link icon next to each release name in the compare groups table" />

The **Triage** view opens with the selected release already applied as a filter.

In the Triage view, errors are grouped by fingerprints. Start by reviewing fingerprints that affect the most users or have the highest number of reported errors. For more information, see [Triage](/docs/error-reporting/web-console/triage.md).
Loading
Loading