diff --git a/src/content/docs/errors-inbox/browser-tab.mdx b/src/content/docs/errors-inbox/browser-tab.mdx index 51c955d47e3..1034dbb9fc3 100644 --- a/src/content/docs/errors-inbox/browser-tab.mdx +++ b/src/content/docs/errors-inbox/browser-tab.mdx @@ -13,7 +13,7 @@ redirects: freshnessValidatedDate: 2024-01-02 --- -With **Group errors** tab you can dynamically filter and group errors for deeper analysis. Group errors shows you where your JavaScript errors are happening, and provides tools to help you figure out the root cause. You can also query and create dashboards of JS error data in the [query builder](/docs/query-your-data/explore-query-data/query-builder/introduction-query-builder), or use the browser API to monitor handled errors. +With **Group errors** tab you can dynamically filter and group errors for deeper analysis. Group errors shows you where your JavaScript errors are happening, and provides tools to help you figure out the root cause. You can also track the scope of errors through **Sessions impacted**, which automatically shows how many browser sessions are affected by each error group. Additionally, you can query and create dashboards of JS error data in the [query builder](/docs/query-your-data/explore-query-data/query-builder/introduction-query-builder), or use the browser API to monitor handled errors. **Group errors** tab you can dynamically filter and group errors src="/images/errors-inbox_screenshot-full_browser-group-errors-tab.webp" /> +## Session impact tracking [#session-impact] + +For browser applications, New Relic automatically tracks **Sessions impacted** as a key metric in the Errors inbox. This metric shows the number of unique browser sessions affected by JavaScript errors and helps you understand the scope of issues across your user base. + +**Key benefits of session impact tracking:** + +- **Automatic collection**: No additional configuration required - the metric is collected automatically for all browser entities +- **Fallback metric**: When user impact data isn't available, New Relic displays sessions impacted to ensure visibility into error scope +- **Prioritization**: Helps you prioritize error fixes by showing which errors affect the most browser sessions +- **Alerting**: You can create alerts based on sessions impacted thresholds + +You can query sessions impacted using NRQL: + +```sql +SELECT uniqueCount(newrelic.error.group.sessionImpact) +FROM Metric +WHERE metricName='newrelic.error.group.sessionImpact' +``` + +For more details on impact metrics and alerting, see [Error scope: Users, sessions, and devices impacted](/docs/errors-inbox/error-scope-users-sessions-devices-impacted/). + To examine JavaScript errors: 1. Go to **[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Browser > (select an app) > Errors**. diff --git a/src/content/docs/errors-inbox/error-users-impacted.mdx b/src/content/docs/errors-inbox/error-impacted.mdx similarity index 55% rename from src/content/docs/errors-inbox/error-users-impacted.mdx rename to src/content/docs/errors-inbox/error-impacted.mdx index 46d3906a5ce..d0bc7ab807e 100644 --- a/src/content/docs/errors-inbox/error-users-impacted.mdx +++ b/src/content/docs/errors-inbox/error-impacted.mdx @@ -1,22 +1,38 @@ --- -title: 'Track users impacted with errors inbox' -metaDescription: "Triage more effectively by viewing how many users are impacted by an error group." +title: 'Error scope: Users, sessions, and devices impacted' +metaDescription: "Triage more effectively by viewing how many users, sessions, or devices are impacted by an error group." redirects: - /docs/errors-inbox/users-impacted + - /docs/errors-inbox/error-users-impacted freshnessValidatedDate: never --- -New Relic agents automatically capture data about user impact. When you organize by error group, you can see how many users are affected by errors. This helps you prioritize where to focus your debugging efforts by showing you the errors with the highest numbers of users affected. +New Relic agents automatically capture data about the scope of errors affecting your applications. When you organize by error group, you can see the impact through three key metrics: + +- **Users impacted**: The number of unique users affected by errors +- **Sessions impacted**: The number of unique browser sessions affected (fallback for browser entities) +- **Devices impacted**: The number of unique mobile devices affected (fallback for mobile entities) + +When users impacted data isn't available, New Relic automatically displays the appropriate fallback metric based on your entity type. This helps you prioritize where to focus your debugging efforts by showing you the errors with the highest scope of impact. This is an image of the main errors inbox users impacted
- Go to **[one.newrelic.com](https://one.newrelic.com) > APM & Services > Errors (errors inbox) > Triage**: You can find users impacted in the second column of the **Error groups** table, located beneath the **Error count** and **Error rate** time series. + Go to **[one.newrelic.com](https://one.newrelic.com) > APM & Services > Errors (errors inbox) > Triage**: You can find impact metrics in the second column of the **Error groups** table, located beneath the **Error count** and **Error rate** time series.
+## Fallback impact metrics [#fallback-metrics] + +New Relic prioritizes showing the most relevant impact data for your specific application type. When **Users impacted** data isn't available, the system automatically falls back to entity-specific metrics: + +- **Browser entities**: Displays **Sessions impacted** - the number of unique browser sessions affected by errors +- **Mobile entities**: Displays **Devices impacted** - the number of unique mobile devices affected by errors + +These fallback metrics are automatically collected without requiring additional configuration, unlike Users impacted which may need custom attributes. This ensures you always have visibility into the scope of errors affecting your applications, regardless of your setup. + ## Custom attributes to track users impacted [#custom-attributes] In some cases, an error event may not have attributes that identify the end user affected by that error event. You can manually add custom attributes so our agents capture user-identifying metadata at the time of ingest. @@ -30,9 +46,18 @@ For example, [OpenTelemetry standards](https://opentelemetry.io/docs/reference/s You can review how New Relic processes custom attributes by reading our doc about [collecting custom events](/docs/data-apis/custom-data/custom-events/collect-custom-attributes/#enabling-custom). -## Query for users impacted [#query] +## Query for impact metrics [#query] -The number of users impacted on an error group is recorded as a [Metric data type](/docs/data-apis/understand-data/metric-data/metric-data-type/) with the name `newrelic.error.group.userImpact`. You can use this metric with the following NRQL string: +Impact metrics for error groups are recorded as [Metric data types](/docs/data-apis/understand-data/metric-data/metric-data-type/) with specific metric names: + + + + + You can query the number of users impacted using `newrelic.error.group.userImpact` as metric name in NRQL queries: ```sql SELECT uniqueCount(newrelic.error.group.userImpact) @@ -40,16 +65,66 @@ FROM Metric WHERE metricName='newrelic.error.group.userImpact' ``` -The metric captures the approximate number of unique users in the time period selected. Additional attributes provided by the `userImpact` metric which can be used in a `FACET` clause are `error.group.guid`, `entity.guid`. +This NRQL query metric captures the approximate number of unique users in the time period selected. Additional attributes provided by the `userImpact` metric which can be used in a `FACET` clause are `error.group.guid`, `entity.guid`. + + + + + +You can query the number of sessions impacted using `newrelic.error.group.sessionImpact` as metric name in NRQL queries: + +```sql +SELECT uniqueCount(newrelic.error.group.sessionImpact) +FROM Metric +WHERE metricName='newrelic.error.group.sessionImpact' +``` + + + + + +You can query the number of devices impacted using `newrelic.error.group.deviceUuidImpact` as metric name in NRQL queries: + +```sql +SELECT uniqueCount(newrelic.error.group.deviceUuidImpact) +FROM Metric +WHERE metricName='newrelic.error.group.deviceUuidImpact' +``` + + + + -## Alert on users impacted [#alert] -By creating an [NRQL alert condition](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-alert-conditions/), developers can trigger when the amount of users impacted by errors exceeds a threshold. + +## Alert on impact metrics [#alert] + +By creating an [NRQL alert condition](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-alert-conditions/), developers can trigger when the scope of errors exceeds a threshold. You can create alerts for any of the impact metrics: + +- **Users impacted**: Alert when user impact exceeds your threshold +- **Sessions impacted**: Alert when browser session impact exceeds your threshold +- **Devices impacted**: Alert when mobile device impact exceeds your threshold Creating this alert requires determining the [NRQL query](/docs/query-your-data/nrql-new-relic-query-language/get-started/introduction-nrql-new-relics-query-language/) which measures the amount of users impacted in a way which best captures your use case. As an example, the following NRQL query measures the amount of unique users which have been impacted by an [error group](/docs/errors-inbox/errors-inbox/#groups) coming from a specific entity: + + + + ```sql SELECT uniqueCount(newrelic.error.group.userImpact) FROM Metric @@ -67,13 +142,53 @@ FROM Metric WHERE metricName='newrelic.error.group.userImpact' SINCE 1 hour ago TIMESERIES ``` + + + + + +For browser applications, you can create alerts based on sessions impacted: + +```sql +SELECT uniqueCount(newrelic.error.group.sessionImpact) +FROM Metric +WHERE metricName='newrelic.error.group.sessionImpact' +AND entity.guid='YOUR_BROWSER_ENTITY_GUID' FACET error.group.guid TIMESERIES +``` + + + + + +For mobile applications, you can create alerts based on devices impacted: + +```sql +SELECT uniqueCount(newrelic.error.group.deviceUuidImpact) +FROM Metric +WHERE metricName='newrelic.error.group.deviceUuidImpact' +AND entity.guid='YOUR_MOBILE_ENTITY_GUID' FACET error.group.guid TIMESERIES +``` + + + + + + Once you have decided on a NRQL query, it can be used to create a [NRQL alert condition](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/#create). To improve the signal to noise ratio of your triggered alerts see [alert creation tips](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/#condition-tips), [how alert thresholds are evaluated](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/#advanced-signal), and [alert condition examples](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/#examples). ## Set users impacted with setUser method [#set-users] -You can use an agent method to identify an end user. See implementation details for each agent below: +You can use an agent method to identify an end user for the **Users impacted** metric. Sessions and devices impacted are automatically collected without additional configuration. See implementation details for each agent below: diff --git a/src/content/docs/errors-inbox/mobile-tab.mdx b/src/content/docs/errors-inbox/mobile-tab.mdx index 6d5340fa656..e221ba0001c 100644 --- a/src/content/docs/errors-inbox/mobile-tab.mdx +++ b/src/content/docs/errors-inbox/mobile-tab.mdx @@ -20,7 +20,8 @@ With the **Group crashes** page you can: * **Assess overall crash trends**: Review the **Crash rate percentage** and **Crash-free users **percentage charts to quickly identify any anomalies or patterns in crash occurrences. * **Filter for deeper analysis**: Utilize groups and filters to focus on specific crash attributes, such as device type, location, or custom data points. -* **Identify patterns**: Examine the **Crash location** table for trends related to location, exception type, date, frequency, app version, and the number of affected users. +* **Identify patterns**: Examine the **Crash location** table for trends related to location, exception type, date, frequency, app version, and the number of affected users or devices. +* **Monitor device impact**: Track how many unique devices are affected by crashes through the **Devices impacted** metric, which is automatically collected for mobile applications. * **Investigate individual crashes**: Select a crash report to view its interaction trail, event trail, thread details, attributes, and other relevant information. You can also resymbolicate or export the details to Xcode for debugging. * **Update crash status**: Mark the crash as `Resolved` or choose from other status options, such as `Resolved in specific version`. @@ -34,6 +35,27 @@ With the **Group crashes** page you can: **[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Crashes (errors inbox)**: With our **Group crashes** tab you can analyze crash rate and crash free users at a glance or dive deeper into specific crash locations. +## Device impact tracking [#device-impact] + +For mobile applications, New Relic automatically tracks **Devices impacted** as a key metric in the Errors inbox. This metric shows the number of unique mobile devices affected by crashes and helps you understand the scope of issues across your user base. + +**Key benefits of device impact tracking:** + +- **Automatic collection**: No additional configuration required - the metric is collected automatically for all mobile entities +- **Fallback metric**: When user impact data isn't available, New Relic displays devices impacted to ensure visibility into error scope +- **Prioritization**: Helps you prioritize crash fixes by showing which errors affect the most devices +- **Alerting**: You can create alerts based on devices impacted thresholds + +You can query devices impacted using NRQL: + +```sql +SELECT uniqueCount(newrelic.error.group.deviceImpact) +FROM Metric +WHERE metricName='newrelic.error.group.deviceImpact' +``` + +For more details on impact metrics and alerting, see [Error scope: Users, sessions, and devices impacted](/docs/errors-inbox/error-scope-users-sessions-devices-impacted/). + ## Suggested workflow [#workflow] These steps outline our recommended approach to crash investigation, enabling you to gain a complete understanding of the incident, identify contributing factors, and implement effective debugging strategies. diff --git a/src/i18n/content/es/docs/errors-inbox/error-users-impacted.mdx b/src/i18n/content/es/docs/errors-inbox/error-impacted.mdx similarity index 100% rename from src/i18n/content/es/docs/errors-inbox/error-users-impacted.mdx rename to src/i18n/content/es/docs/errors-inbox/error-impacted.mdx diff --git a/src/i18n/content/fr/docs/errors-inbox/error-users-impacted.mdx b/src/i18n/content/fr/docs/errors-inbox/error-impacted.mdx similarity index 100% rename from src/i18n/content/fr/docs/errors-inbox/error-users-impacted.mdx rename to src/i18n/content/fr/docs/errors-inbox/error-impacted.mdx diff --git a/src/i18n/content/jp/docs/errors-inbox/error-users-impacted.mdx b/src/i18n/content/jp/docs/errors-inbox/error-impacted.mdx similarity index 100% rename from src/i18n/content/jp/docs/errors-inbox/error-users-impacted.mdx rename to src/i18n/content/jp/docs/errors-inbox/error-impacted.mdx diff --git a/src/i18n/content/kr/docs/errors-inbox/error-users-impacted.mdx b/src/i18n/content/kr/docs/errors-inbox/error-impacted.mdx similarity index 100% rename from src/i18n/content/kr/docs/errors-inbox/error-users-impacted.mdx rename to src/i18n/content/kr/docs/errors-inbox/error-impacted.mdx diff --git a/src/i18n/content/pt/docs/errors-inbox/error-users-impacted.mdx b/src/i18n/content/pt/docs/errors-inbox/error-impacted.mdx similarity index 100% rename from src/i18n/content/pt/docs/errors-inbox/error-users-impacted.mdx rename to src/i18n/content/pt/docs/errors-inbox/error-impacted.mdx diff --git a/src/nav/errors-inbox.yml b/src/nav/errors-inbox.yml index 6cb0a26fa62..508c0fb88f8 100644 --- a/src/nav/errors-inbox.yml +++ b/src/nav/errors-inbox.yml @@ -13,7 +13,7 @@ pages: - title: Email notifications path: /docs/errors-inbox/errors-email-notifications - title: Track users impacted - path: /docs/errors-inbox/error-users-impacted + path: /docs/errors-inbox/error-impacted - title: Errors inbox external services path: /docs/errors-inbox/error-external-services - title: Version tracking diff --git a/static/images/errors-inbox_screenshot-full_users-impacted.webp b/static/images/errors-inbox_screenshot-full_users-impacted.webp index 098ac65e472..7b7d15b8e50 100644 Binary files a/static/images/errors-inbox_screenshot-full_users-impacted.webp and b/static/images/errors-inbox_screenshot-full_users-impacted.webp differ