Skip to content

Commit eda627c

Browse files
authored
Merge pull request #21808 from newrelic/NR-467508-error-updates
feat: Added Sessions and Devices Impacted metrics to Errors Inbox docs
2 parents f1c4521 + 2b7ea8c commit eda627c

File tree

10 files changed

+173
-15
lines changed

10 files changed

+173
-15
lines changed

src/content/docs/errors-inbox/browser-tab.mdx

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,35 @@ redirects:
1313
freshnessValidatedDate: 2024-01-02
1414
---
1515

16-
With <DNT>**Group errors**</DNT> 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.
16+
With <DNT>**Group errors**</DNT> 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.
1717

1818
<img
1919
title="browser group errors tab "
2020
alt="a screenshot depiciting the browser group errors tab"
2121
src="/images/errors-inbox_screenshot-full_browser-group-errors-tab.webp"
2222
/>
2323

24+
## Session impact tracking [#session-impact]
25+
26+
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.
27+
28+
**Key benefits of session impact tracking:**
29+
30+
- **Automatic collection**: No additional configuration required - the metric is collected automatically for all browser entities
31+
- **Fallback metric**: When user impact data isn't available, New Relic displays sessions impacted to ensure visibility into error scope
32+
- **Prioritization**: Helps you prioritize error fixes by showing which errors affect the most browser sessions
33+
- **Alerting**: You can create alerts based on sessions impacted thresholds
34+
35+
You can query sessions impacted using NRQL:
36+
37+
```sql
38+
SELECT uniqueCount(newrelic.error.group.sessionImpact)
39+
FROM Metric
40+
WHERE metricName='newrelic.error.group.sessionImpact'
41+
```
42+
43+
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/).
44+
2445
To examine JavaScript errors:
2546

2647
1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Browser > (select an app) > Errors**</DNT>.

src/content/docs/errors-inbox/error-users-impacted.mdx renamed to src/content/docs/errors-inbox/error-impacted.mdx

Lines changed: 127 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,38 @@
11
---
2-
title: 'Track users impacted with errors inbox'
3-
metaDescription: "Triage more effectively by viewing how many users are impacted by an error group."
2+
title: 'Error scope: Users, sessions, and devices impacted'
3+
metaDescription: "Triage more effectively by viewing how many users, sessions, or devices are impacted by an error group."
44
redirects:
55
- /docs/errors-inbox/users-impacted
6+
- /docs/errors-inbox/error-users-impacted
67
freshnessValidatedDate: never
78
---
89

9-
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.
10+
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:
11+
12+
- **Users impacted**: The number of unique users affected by errors
13+
- **Sessions impacted**: The number of unique browser sessions affected (fallback for browser entities)
14+
- **Devices impacted**: The number of unique mobile devices affected (fallback for mobile entities)
15+
16+
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.
1017

1118
<img
12-
title="An image showing how to navigate users impacted"
13-
alt="This is an image of the main errors inbox users impacted"
19+
title="An image showing how to navigate impact metrics in errors inbox"
20+
alt="This is an image of the main errors inbox showing users, sessions, and devices impacted"
1421
src="/images/errors-inbox_screenshot-full_users-impacted.webp"
1522
/>
1623
<figcaption>
17-
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.
24+
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.
1825
</figcaption>
1926

27+
## Fallback impact metrics [#fallback-metrics]
28+
29+
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:
30+
31+
- **Browser entities**: Displays **Sessions impacted** - the number of unique browser sessions affected by errors
32+
- **Mobile entities**: Displays **Devices impacted** - the number of unique mobile devices affected by errors
33+
34+
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.
35+
2036
## Custom attributes to track users impacted [#custom-attributes]
2137

2238
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,26 +46,85 @@ For example, [OpenTelemetry standards](https://opentelemetry.io/docs/reference/s
3046

3147
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).
3248

33-
## Query for users impacted [#query]
49+
## Query for impact metrics [#query]
3450

35-
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:
51+
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:
52+
53+
<CollapserGroup>
54+
<Collapser
55+
className="freq-link"
56+
id="users"
57+
title="Users impacted"
58+
>
59+
60+
You can query the number of users impacted using `newrelic.error.group.userImpact` as metric name in NRQL queries:
3661

3762
```sql
3863
SELECT uniqueCount(newrelic.error.group.userImpact)
3964
FROM Metric
4065
WHERE metricName='newrelic.error.group.userImpact'
4166
```
4267

43-
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`.
68+
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`.
69+
70+
</Collapser>
71+
72+
<Collapser
73+
className="freq-link"
74+
id="sessions"
75+
title="Sessions impacted"
76+
>
77+
78+
You can query the number of sessions impacted using `newrelic.error.group.sessionImpact` as metric name in NRQL queries:
79+
80+
```sql
81+
SELECT uniqueCount(newrelic.error.group.sessionImpact)
82+
FROM Metric
83+
WHERE metricName='newrelic.error.group.sessionImpact'
84+
```
85+
86+
</Collapser>
87+
88+
<Collapser
89+
className="freq-link"
90+
id="devices"
91+
title="Devices impacted"
92+
>
93+
94+
You can query the number of devices impacted using `newrelic.error.group.deviceUuidImpact` as metric name in NRQL queries:
95+
96+
```sql
97+
SELECT uniqueCount(newrelic.error.group.deviceUuidImpact)
98+
FROM Metric
99+
WHERE metricName='newrelic.error.group.deviceUuidImpact'
100+
```
101+
102+
</Collapser>
103+
104+
</CollapserGroup>
44105

45-
## Alert on users impacted [#alert]
46106

47-
By creating an [NRQL alert condition](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-alert-conditions/), developers can trigger <InlinePopover type="alerts"/> when the amount of users impacted by errors exceeds a threshold.
107+
108+
## Alert on impact metrics [#alert]
109+
110+
By creating an [NRQL alert condition](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-alert-conditions/), developers can trigger <InlinePopover type="alerts"/> when the scope of errors exceeds a threshold. You can create alerts for any of the impact metrics:
111+
112+
- **Users impacted**: Alert when user impact exceeds your threshold
113+
- **Sessions impacted**: Alert when browser session impact exceeds your threshold
114+
- **Devices impacted**: Alert when mobile device impact exceeds your threshold
48115

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

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

120+
<CollapserGroup>
121+
<Collapser
122+
className="freq-link"
123+
id="user"
124+
title="Alerts on users impacted"
125+
>
126+
127+
53128
```sql
54129
SELECT uniqueCount(newrelic.error.group.userImpact)
55130
FROM Metric
@@ -67,13 +142,53 @@ FROM Metric
67142
WHERE metricName='newrelic.error.group.userImpact' SINCE 1 hour ago TIMESERIES
68143
```
69144

145+
146+
</Collapser>
147+
148+
<Collapser
149+
className="freq-link"
150+
id="session"
151+
title="Alerts on sessions impacted"
152+
>
153+
154+
For browser applications, you can create alerts based on sessions impacted:
155+
156+
```sql
157+
SELECT uniqueCount(newrelic.error.group.sessionImpact)
158+
FROM Metric
159+
WHERE metricName='newrelic.error.group.sessionImpact'
160+
AND entity.guid='YOUR_BROWSER_ENTITY_GUID' FACET error.group.guid TIMESERIES
161+
```
162+
163+
</Collapser>
164+
165+
<Collapser
166+
className="freq-link"
167+
id="device"
168+
title="Alerts on devices impacted"
169+
>
170+
171+
For mobile applications, you can create alerts based on devices impacted:
172+
173+
```sql
174+
SELECT uniqueCount(newrelic.error.group.deviceUuidImpact)
175+
FROM Metric
176+
WHERE metricName='newrelic.error.group.deviceUuidImpact'
177+
AND entity.guid='YOUR_MOBILE_ENTITY_GUID' FACET error.group.guid TIMESERIES
178+
```
179+
180+
</Collapser>
181+
182+
</CollapserGroup>
183+
184+
70185
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).
71186

72187
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).
73188

74189
## Set users impacted with setUser method [#set-users]
75190

76-
You can use an agent method to identify an end user. See implementation details for each agent below:
191+
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:
77192

78193
<table>
79194
<thead>

src/content/docs/errors-inbox/mobile-tab.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ With the **Group crashes** page you can:
2020

2121
* **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.
2222
* **Filter for deeper analysis**: Utilize groups and filters to focus on specific crash attributes, such as device type, location, or custom data points.
23-
* **Identify patterns**: Examine the **Crash location** table for trends related to location, exception type, date, frequency, app version, and the number of affected users.
23+
* **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.
24+
* **Monitor device impact**: Track how many unique devices are affected by crashes through the **Devices impacted** metric, which is automatically collected for mobile applications.
2425
* **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.
2526
* **Update crash status**: Mark the crash as `Resolved` or choose from other status options, such as `Resolved in specific version`.
2627

@@ -34,6 +35,27 @@ With the **Group crashes** page you can:
3435
<DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Crashes (errors inbox)**</DNT>: With our **Group crashes** tab you can analyze crash rate and crash free users at a glance or dive deeper into specific crash locations.
3536
</figcaption>
3637

38+
## Device impact tracking [#device-impact]
39+
40+
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.
41+
42+
**Key benefits of device impact tracking:**
43+
44+
- **Automatic collection**: No additional configuration required - the metric is collected automatically for all mobile entities
45+
- **Fallback metric**: When user impact data isn't available, New Relic displays devices impacted to ensure visibility into error scope
46+
- **Prioritization**: Helps you prioritize crash fixes by showing which errors affect the most devices
47+
- **Alerting**: You can create alerts based on devices impacted thresholds
48+
49+
You can query devices impacted using NRQL:
50+
51+
```sql
52+
SELECT uniqueCount(newrelic.error.group.deviceImpact)
53+
FROM Metric
54+
WHERE metricName='newrelic.error.group.deviceImpact'
55+
```
56+
57+
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/).
58+
3759
## Suggested workflow [#workflow]
3860

3961
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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

src/nav/errors-inbox.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pages:
1313
- title: Email notifications
1414
path: /docs/errors-inbox/errors-email-notifications
1515
- title: Track users impacted
16-
path: /docs/errors-inbox/error-users-impacted
16+
path: /docs/errors-inbox/error-impacted
1717
- title: Errors inbox external services
1818
path: /docs/errors-inbox/error-external-services
1919
- title: Version tracking
309 KB
Loading

0 commit comments

Comments
 (0)