Skip to content
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

Daily release/sep 23 2024 9 18 #18743

Merged
merged 27 commits into from
Sep 23, 2024
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
734e7a0
chore(mobile): replace http errors page with new request errors page
ally-sassman Sep 17, 2024
717b881
fix(mobile): change new page path name
ally-sassman Sep 17, 2024
506786c
feat(mobile): migrate gDoc draft to mdx file
ally-sassman Sep 17, 2024
acb6f03
chore(mobile): add images
ally-sassman Sep 17, 2024
000aa96
feat(mobile): add screenshot, other style fixes
ally-sassman Sep 18, 2024
87a5a4b
more edits
ally-sassman Sep 18, 2024
76a0256
other updates
ally-sassman Sep 19, 2024
c9bcaf3
feat: Added databricks integration docs
jcountsNR Sep 19, 2024
0cad0e9
Update errors-inbox_screenshot-crop_request-errors-attributes.webp
ally-sassman Sep 19, 2024
4807c12
fix(.NET): fixing links in compatibility doc
jeff-colucci Sep 19, 2024
58d38d9
feat(OHI OCSF): exploded the OCSF acronym
Sep 20, 2024
5bffcc0
style(OHI Databricks): Added TW edits
Sep 20, 2024
b5a7671
fix yaml syntax error
sunnyzanchi Sep 20, 2024
329d884
chore(whats-new-ids): updated ids
svc-docs-eng-opensource-bot Sep 20, 2024
7637398
Apply suggestions from code review
ally-sassman Sep 20, 2024
daeaf8d
Update src/content/docs/errors-inbox/group-request-errors.mdx
ally-sassman Sep 20, 2024
106a180
Apply suggestions from code review
ally-sassman Sep 20, 2024
15daccb
Apply suggestions from code review
ally-sassman Sep 20, 2024
68cb513
Apply suggestions from code review
ally-sassman Sep 20, 2024
9c8c2ac
chore: add translations
svc-docs-eng-opensource-bot Sep 21, 2024
62a690b
chore: add translations
svc-docs-eng-opensource-bot Sep 21, 2024
507f070
Merge pull request #18717 from jcountsNR/develop
nbaenam Sep 23, 2024
55d9b97
Merge pull request #18730 from newrelic/nb-ocsf-acronym
nbaenam Sep 23, 2024
817cd58
Merge pull request #18737 from newrelic/translations-9c8c2ac3
jmiraNR Sep 23, 2024
a19612a
Merge pull request #18738 from newrelic/translations-62a690bd
jmiraNR Sep 23, 2024
50ee245
Merge pull request #18728 from newrelic/fixing-links-in-compatibility…
jeff-colucci Sep 23, 2024
850939d
feat(errors): new request errors page for mobile monitoring
ally-sassman Sep 23, 2024
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
Prev Previous commit
Next Next commit
more edits
  • Loading branch information
ally-sassman committed Sep 18, 2024
commit 87a5a4bf70451247735621cdd69471d6a9609730
99 changes: 39 additions & 60 deletions src/content/docs/errors-inbox/group-request-errors.mdx
Original file line number Diff line number Diff line change
@@ -33,41 +33,35 @@ To view the request errors page, go to **<DNT>[one.newrelic.com > All capabiliti

We recommend the following approach to investigate HTTP request errors and network failures, allowing you to gain a complete understanding of the error, identify contributing factors, and implement effective debugging strategies:

1. Drill down into a single error:

To view details about a request error or network failure, click on the row from the error group table. Here you can view the request information, request attributes, and response body as well as get more information about that error.
1. **Drill down into a single error**: To view details about a request error or network failure, click on the row from the error group table. Here you can view the request information, request attributes, and response body as well as get more information about that error.

2. Query and share error data:

To explore the data behind any of the charts or lists on the HTTP errors page:
2. **Query and share error data**: To explore the data behind any of the charts or lists on the HTTP errors page:

a. On any chart, click **… > <DNT>View query</DNT>**.
b. From the query builder, you can add the error data to a dashboard and share it via a permalink.
* On any chart, click **… > <DNT>View query</DNT>**.
* From the query builder, you can add the error data to a dashboard and share it via a permalink.

To dig deeper into the error data, query your data for the following events and attributes:

* `MobileRequestError` events and attributes
* `MobileRequest` events and attributes

3. Change how the page groups and sorts errors and network failures:

Make selections using both the attributes and filter bars at the top of the page. By default, the errors are grouped by request domain and request path.
3. **Change how the page groups and sorts errors and network failures**: Make selections using both the attributes and filter bars at the top of the page. By default, the errors are grouped by request domain and request path.

4. Filter for specific errors and network failures:

Select an error or failure using multiple filters from the filter bar.
4. **Filter for specific errors and network failures**: Select an error or failure using multiple filters from the filter bar.

5. See which filters you applied or remove filters:

The filters you select display in the filter bar. To clear filters, select the **X** next to the filter you want to clear.
5. **See which filters you applied or remove filters**: The filters you select display in the filter bar. To clear filters, select the **X** next to the filter you want to clear.

6. Change the time window:

Select a new time period from the time picker dropdown.
6. **Change the time window**: Select a new time period from the time picker dropdown.

7. **View information for one specific app version**: Select the version that you want to see charts and lists for in the versions dropdown. By default, all available versions are shown.


The sections below describe what you can do on the request errors page.

## Triage errors tab [#triage-errors]

The triage tab shows an overview of unresolved errors and how they correlate with the error rate. The error group table lists groups of errors by occurrence and allows you to asssign them to users who can investigate and fix them.

7. View information for one specific app version:

Select the version that you want to see charts and lists for in the versions dropdown. By default, all available versions are shown.

## Group errors tab [#group-errors]

@@ -81,15 +75,13 @@ On the group errors tab you can:

* **Investigate individual request errors**: Select a request error report to view its distributed trace, event trail, response body, attributes, and other relevant details necessary for effective debugging.

* **Update error status**: Mark the request error as **Resolved** or assign it to a specific team member who can own and examining the issue, and then deploy a fix.
* **Update error status**: Mark the request error as **Resolved** or assign it to a specific team member who can own and examine the issue, and then deploy a fix.

## Request error details view [#error-details]
## Request error details [#error-details]

The request error details view displays:
* All occurrences chart:
Displays the frequency of a request error over the selected period, starting from its initial detection. You can view either the aggregated data of all occurrences or a breakdown by app version.
2. Error type breakdown:
* Displays the distribution of this request errors across different operating system versions or affected devices.
On the request errors page, click into a specific error to see:
* **All occurrences chart**: Displays the frequency of a request error over the selected period, starting from its initial detection. You can view either the aggregated data of all occurrences or a breakdown by app version.
* **Error type breakdown**: Displays the distribution of this request errors across different operating system versions or affected devices.

Resolved errors include a banner containing details on the user who resolved the request error and the resolution timestamp. Note that mobile monitoring's data retention policies apply, allowing you to filter by resolved errors for historical analysis when needed.

@@ -104,14 +96,16 @@ Resolved errors include a banner containing details on the user who resolved the
**<DNT>[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Request errors</DNT>**: Select a request error to open the request errors details page.
</figcaption>

## Error profiles [#error-profiles]
### Profiles [#error-profiles]

Error profiles provide visual details about significant differences in the frequency of different values for HTTP error events. For each attribute, the error profile includes:
* A heatmap showing how the error's attribute is distributed for values that deviate the most
* A label comparing the error attribute's distribution to that of other errors

<img
title="Request errors profiles"
style={{align: "left" }}
width="50%"
alt="Screenshot of the request errors profiles section"
src="/images/errors-inbox_screenshot-crop_request-errors-profiles.webp"
/>
@@ -121,7 +115,7 @@ Error profiles provide visual details about significant differences in the frequ
**<DNT>[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Request errors</DNT>**: Select a request error to open the request errors details page and view the heatmap distribution of the attributes.
</figcaption>

## Triage your errors [#triage-errors]
### Triage [#triage-errors]

The triage section associates the specific error occurrence you are viewing with its [system-created error group](/docs/errors-inbox/errors-inbox/#groups). These system-created error groups are identified by a unique fingerprint. It is this unique fingerprint that allows you to triage error groups by status updates or assignments.

@@ -138,9 +132,9 @@ For more info on how error groups are created, see [How error groups work](/docs
**<DNT>[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Request errors</DNT> > (Select a request error)**: From the request errors details page you can triage specific error occurrences by adding status updates or assignments.
</figcaption>

## Distributed trace [#distributed-trace]
### Distributed trace [#distributed-trace]

The Distributed Trace section tracks and observes your requests as they flow through your application, traversing various services to reach completion. By visualizing the entire request path across different services, you can rapidly identify failures or performance bottlenecks.
The distributed trace section tracks and observes your requests as they flow through your application, traversing various services to reach completion. By visualizing the entire request path across different services, you can rapidly identify failures or performance bottlenecks.

To learn more about how distributed tracing works, see [Track requests across your microservices](/docs/distributed-tracing/concepts/introduction-distributed-tracing/).

@@ -155,11 +149,11 @@ To learn more about how distributed tracing works, see [Track requests across yo
**<DNT>[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Request errors</DNT> > (Select a request error)**: From the request errors details page you view the distributed trace associated with that request.
</figcaption>

## Response [#response]
### Response [#response]

A typical response to a request comprises a response header and response body, which together convey information about the success or failure of the request. The response header contains metadata about the server, while the response body holds information about the output, including a success or failure code and corresponding message.

New Relic captures the response body for requests whenever available, displaying it on the request errors details page to facilitate expedited debugging.
We capture the response body for requests whenever available, displaying it on the request errors details page to expedite debugging.

<img
title="Request errors response section"
@@ -172,22 +166,20 @@ New Relic captures the response body for requests whenever available, displaying
**<DNT>[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Request errors</DNT> > (Select a request error)**: From the request errors details page you view the response body associated with that request.
</figcaption>

## Event trail [#event-trail]
### Event trail [#event-trail]

The event trail provides a chronological log of all events leading up to the request error, aiding root cause analysis. These can be events New Relic monitors by default, or custom events. The event trail is sorted chronologically, beginning with the oldest event, which is typically the app launch, but you can modify the following:
The event trail provides a chronological log of all events leading up to the request error, which helps with root cause analysis. These can be events New Relic monitors by default, or custom events. The event trail is sorted chronologically, beginning with the oldest event, which is typically the app launch, but you can modify the following:

* Sort: Toggle between ascending and descending order
* Event filtering: Filter by event type, like app launch, request, request error, or user actions
* Event details: Expand individual events to inspect their attributes, like errorType, responseTime, or requestUrl for request events.

After you've sorted and filtered your events, you can dig a little deeper into the events that lead up to the error by examining:

* Custom breadcrumbs:
Utilize the [Record breadcrumb SDK](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-breadcrumb/) to create custom MobileBreadcrumb events. This allows you to log specific application interactions that may be relevant to investigating your error.
* Handled exceptions:
Use the [Record Handled Exception SDK](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-handled-exceptions/) methods for iOS and Android to annotate where exceptions are handled in your application. These annotations will automatically populate the crash event trail.
* **Custom breadcrumbs**: Utilize the [Record breadcrumb SDK](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-breadcrumb/) to create custom MobileBreadcrumb events. This allows you to log specific application interactions that may be relevant to investigating your error.
* **Handled exceptions**: Use the [Record Handled Exception SDK](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-handled-exceptions/) methods for iOS and Android to annotate where exceptions are handled in your application. These annotations will automatically populate the crash event trail.

For detailed guidance on enhancing crash event trails with custom data, see [Record breadcrumbs](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-breadcrumb/).
For guidance on enhancing crash event trails with custom data, see [Record breadcrumbs](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-breadcrumb/).

To fully leverage our crash analysis tools, make sure to:
1. Use the mobile SDK to create custom MobileBreadcrumb or MobileHandledException events.
@@ -204,26 +196,13 @@ To fully leverage our crash analysis tools, make sure to:
**<DNT>[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > Request errors</DNT> > (Select a request error)**: From the request errors details page you can dig deeper into the events that led up to a specific error using our event trail.
</figcaption>

## Attributes [#attributes]

Each request error sample provides detailed information about the request, response, as well as the parameters that led to the request erroring, including:
* App version:
The apecific version of the application in which the request error occurred
* Network details:
The mobile network carrier information available for the device
* Device type:
The model of the device on which the request error occurred
* OS version:
The operating system version running on the device
* RAM used:
The amount of memory the application was utilizing at the time of the request error
* Disk free:
The amount of available storage space on the device when the request error happened
* Attributes:
Detailed attributes associated with the request error, offering deeper insights into the context of the error.
### Attributes [#attributes]

Each request error sample provides detailed information about the request, response as well as the parameters that led to the request erroring.

<img
title="Request errors attributes"
style={{align: "left" }}
alt="Screenshot of the request errors attributes section"
src="/images/errors-inbox_screenshot-crop_request-errors-attributes.webp"
/>
Loading
Oops, something went wrong.