Skip to content

Commit

Permalink
fix: copy edits
Browse files Browse the repository at this point in the history
  • Loading branch information
bradleycamacho committed Nov 17, 2021
1 parent 626b297 commit 3bcc47c
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 37 deletions.
16 changes: 8 additions & 8 deletions src/content/docs/apm/errors-inbox/errors-inbox-ui.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 'Errors inbox in APM: track and triage errors for faster resolution'
metaDescription: "New Relic Errors Inbox is an error tracking solution designed to put you in the driver’s seat when it comes to detecting, triaging, and resolving errors across your full application stack."
metaDescription: "Errors inbox is an error tracking solution designed to put you in the driver’s seat when it comes to detecting, triaging, and resolving errors across your full application stack."
---

New Relic errors inbox is a single place to proactively detect, triage, and take action on all the errors before they impact customers. Receive alerts whenever a critical, customer-impacting error arises via your preferred communication channel.
Errors inbox is a single place to proactively detect, triage, and take action on all the errors before they impact customers. Receive alerts whenever a critical, customer-impacting error arises via your preferred communication channel.

Errors inbox is embedded in the APM UI so you can resolve errors faster. Errors are grouped to cut down on noise and collaborating across teams is easy with shared visibility to the same error data.

Expand All @@ -15,24 +15,24 @@ Errors inbox is not available in the EU region.

No additional setup or workloads are needed to triage errors in APM. Just navigate to the APM service you want to view and follow the steps below:

1. On the APM UI overview screen, click the Errors Inbox option in the left-hand navigation in the Triage section.
2. This Errors Inbox view groups errors related specifically to the APM service you are looking at. You can see all error details and also triage the error right in the APM UI.
1. On the APM UI overview screen, click the **Errors inbox** option in the left-hand navigation in the triage section.
2. This errors inbox view groups errors related specifically to the APM service you are looking at. You can see all error details and also triage the error right in the APM UI.
3. Click an error group’s details to see the stack trace, logs in context attributes, and other information without navigating to other screens or services.
4. Click Go to global inbox for the broader Errors Inbox experience, which groups errors across the entire stack, including browser and mobile errors. New Relic automatically finds a workload that includes the APM service you were looking at or prompts you to create a new workload.
4. Click **Go to global inbox** for the broader errors inbox experience, which groups errors across the entire stack, including browser and mobile errors. New Relic automatically finds a workload that includes the APM service you were looking at or prompts you to create a new workload.

Using errors inbox in APM gives you an added layer of convenience, allowing you to triage errors without switching screens.

## Connect an inbox to Slack

When connected to Slack, new and resurfaced error groups will be sent to a Slack channel within seconds of them occurring. This enables your team to quickly identify any new errors or regressions, and resolve them quickly with direct links to the stack trace.
When connected to Slack, new and resurfaced error groups will be sent to a Slack channel within seconds of them occurring. This enables your team to quickly identify any new errors or regressions, and resolve them quickly with direct links to the stack trace.

1. If your Slack workspace does not have the [New Relic app](https://newrelic.slack.com/apps/AP92KQJS3-new-relic?tab=more_info) installed, do that first.
2. From an inbox, select the Inbox Settings icon (looks like a gear) in the top right corner.
3. Toggle the Slack button to "on" if it is "off".
3. Toggle the Slack button to **on** if it is **off**.
4. If no workspaces are available, click the "+" button to enable Slack with a one click Slack authentication.
5. Once authenticated, you will be able to select a Workspace and specific Channel to send notifications to.
6. Click "Test" to ensure messages are being sent to the right channel.

## Learn more about errors inbox

To learn more about the full capabilities of errors inbox, check out our [dedicated errors inbox doc](/docs/errors-inbox/errors-inbox).
To learn more about the full capabilities of errors inbox, check out our [dedicated errors inbox doc](/docs/errors-inbox/errors-inbox).
56 changes: 27 additions & 29 deletions src/content/docs/errors-inbox/errors-inbox.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: 'Errors inbox: one inbox for all your errors'
metaDescription: "New Relic errors inbox is an error tracking solution designed to give you the tools to proactively detect, triage, and resolve errors across your full application stack."
metaDescription: "Errors inbox is an error tracking solution designed to give you the tools to proactively detect, triage, and resolve errors across your full application stack."
redirects:
- /docs/error-tracking
- /docs/apm/apm-ui-pages/errors-inbox/errors-inbox
---

New Relic errors inbox is a single place to proactively detect, triage, and take action on all the errors before they impact customers. Receive alerts whenever a critical, customer-impacting error arises via your preferred communication channel, like Slack.
Errors inbox is a single place to proactively detect, triage, and take action on all the errors before they impact customers. Receive alerts whenever a critical, customer-impacting error arises via your preferred communication channel, like Slack.

Resolve errors faster with errors from across your stack, including all APM, browser (RUM), mobile, and serverless (AWS Lambda) data, displayed on one screen. Errors are grouped to cut down on noise and collaborating across teams is easy with shared visibility to the same error data.
Resolve errors faster with errors from across your stack, including all APM, browser (RUM), mobile, and serverless (AWS Lambda) data, displayed on one screen. Errors are grouped to cut down on noise, and collaborating across teams is easy with shared visibility to the same error data.

<Callout variant="important">
Errors inbox is not available in the EU region.
Expand All @@ -28,29 +28,29 @@ Errors inbox provides a unified error tracking experience to detect and triage e

To enable errors inbox, follow these steps below. Afterwards, errors groups should start to appear in your inbox.

1. From [one.newrelic.com](one.newrelic.com) select **More** in the top right and click **Errors inbox** from the dropdown.
1. From [one.newrelic.com](one.newrelic.com) select **Errors inbox** from the top nav.
2. If this is your first time accessing errors inbox, you will be prompted to select a [workload](/docs/new-relic-one/use-new-relic-one/workloads/workloads-isolate-resolve-incidents-faster/) in the top left.
3. If you have no workloads set up, you will be prompted [to create one](/docs/new-relic-one/use-new-relic-one/workloads/use-workloads/) before you can use errors inbox.

Once you select your workload, your inbox should populate with error groups.

![This is an image of the main errors inbox UI](./images/errors-ui.png "ui-main")

<figcaption>[one.newrelic.com](one.newrelic.com) > **More** > ** Errors inbox**</figcaption>
<figcaption>[one.newrelic.com](one.newrelic.com) > **More** > **Errors inbox**</figcaption>

## Monitor errors

Once you've set up your errors inbox, you can begin proactively monitoring all errors in your stack:

### Error groups

Error groups are sets of events that make up a unique error. Error groups are stored long term and contain metrics, activity log, discussions, and basic information about the unique error. Error groups are tied to the [entity](/docs/new-relic-one/use-new-relic-one/core-concepts/what-entity-new-relic/), making a change to the state of an error group in one errors inbox will impact all other inboxes that contain that entity.
Error groups are sets of events that make up a unique error. Error groups are stored long term and contain metrics, activity log, discussions, and basic information about the unique error. Error groups are tied to the [entity](/docs/new-relic-one/use-new-relic-one/core-concepts/what-entity-new-relic/), so making a change to the state of an error group in one errors inbox will impact all other inboxes that contain that entity.

**How error groups work**

Error events get grouped into an error group when they share the same fingerprint. As events are ingested by New Relic, we run the events through a set of managed rules that output a fingerprint. Every unique fingerprint has a single error group associated with it.
Error events get grouped into an error group when they share the same fingerprint. As events are ingested by New Relic, we run the events through a set of managed rules that output a fingerprint. Every unique fingerprint has a single error group associated with it.

The New Relic managed rules normalize the error data, identifying and ignoring unique values such as UUIDs, hex values, email addresses, etc. that would cause grouping “like” errors into unique groups. New Relic account ID, Entity ID, Error Class, message, and stack traces and exceptions are data that can impact a fingerprint.
The New Relic managed rules normalize the error data, identifying and ignoring unique values such as UUIDs, hex values, email addresses, etc. that would cause grouping “like” errors into unique groups. NR account ID, entity ID, error class, error message, stack trace and exception are all data that can impact a fingerprint.

<CollapserGroup>
<Collapser
Expand All @@ -59,11 +59,11 @@ The New Relic managed rules normalize the error data, identifying and ignoring u
title="Troubleshooting: similar looking events do not group together"
>

If you see “like” error events grouped into different error groups incorrectly, try removing the unique identifier from the error class or message and store those as attributes instead. This will allow you to more easily facet on the attribute values and reduce the number of error groups.
If you see “like” error events grouped into different error groups incorrectly, try removing the unique identifier from the error class or message and store those as attributes instead. This will allow you to more easily facet on the attribute values and reduce the number of error groups.

If you have a single application reporting as multiple entities in New Relic (for instance, running in different clusters, cells, etc.), you might see duplicate error groups, since our grouping logic looks at account and entity IDs as part of the fingerprinting process. You can consider [rolling up the multiple entities into a single entity](/docs/agents/manage-apm-agents/app-naming/use-multiple-names-app/) and including only that rolled up entity as part of your errors inbox.
If you have a single application reporting as multiple entities in New Relic (i.e. running in different clusters, cells, etc), you might see duplicate error groups, since our grouping logic looks at account and entity IDs as part of the fingerprinting process. You can consider [rolling up the multiple entities into a single entity](/docs/agents/manage-apm-agents/app-naming/use-multiple-names-app/) and including only that rolled up entity as part of your errors inbox.

You can also use the feedback tool in NR1 to share error groups that could use improved grouping. We’re continually updating our rules to improve the quality of error groups.
You can also use the feedback tool in NR1 to share error groups that could use improved grouping. We’re continually updating our rules to improve the quality of error groups.

</Collapser>
</CollapserGroup>
Expand All @@ -79,26 +79,26 @@ Using the dropdown in the top right, you can sort the list of grouped errors by

### Errors status

Errors inbox enables you to triage error groups right from the main screen or from the error details page. Triaging helps remove the noise from your errors inbox, and let’s you focus on the high impact errors that need attention.
Errors inbox enables you to triage error groups directly from the main screen or from the error details page. Triaging helps remove the noise from your errors inbox, and lets you focus on the high impact errors that need attention.

You can set one of three statuses, and filter your inbox by status.
- Unresolved: This is the default status of error groups.
- Resolved: Setting an error as resolved will hide it from the default inbox view unless filters are updated to include resolved errors. If events matching the error group fingerprint occur after marking an error group as resolved, it will automatically unresolve. This can be useful for identifying regressions.
- Ignored: Ignored will hide the error group from the inbox view unless filters are updated to include ignored errors, or until you stop ignoring the error group.
- Resolved: Setting an error as resolved will hide it from the default inbox view unless filters are updated to include resolved errors. If events matching the error group fingerprint occur after marking an error group as resolved, it will automatically reset the status to Unresolved. This can be useful for identifying regressions.
- Ignored: Ignored will hide the error group from the inbox view unless filters are updated to include ignored errors, or until you stop ignoring the error group.

## Error details [#error-details]

![An image showing the context menu of an image](./images/context.png "context menu")
![An image showing the details page of an error group](./images/context.png "Error group details page")

Clicking on a specific error group takes you to the error details page, where you will find full context of the issue. This context can assist in triaging the error and assigning it to the correct team or individual.
Clicking on a specific error group takes you to the error details page, where you will find full context of the issue. This context can assist in triaging the error and assigning it to the correct team or individual.

<CollapserGroup>
<Collapser
className="freq-link"
id="occurrences"
title="Occurrences"
>
The occurrences page includes details like:
The **Occurrences** tab includes details like:
- Related account
- Stack trace
- Logs in context
Expand All @@ -112,7 +112,7 @@ The detailed view also allows you to view specific errors. In the top right, you
id="attributes"
title="Attributes"
>
The Attributes tab enables you to quickly find commonalities between the related errors for faster resolution.
The **Attributes** tab enables you to quickly find commonalities between the related errors for faster resolution.

Click on a specific attribute to open a sidebar with specific details.
</Collapser>
Expand All @@ -121,37 +121,35 @@ Click on a specific attribute to open a sidebar with specific details.
id="activity"
title="Activity"
>
Displays a log of the status changes and user assignments of an error group.
</Collapser>
The **Activity** tab displays a log of the status changes and user assignments of an error group.
</Collapser>
<Collapser
className="freq-link"
id="discussions"
title="Discussions"
>
The discussions provides room for detailed and organized collaboration. This is key to looping in collaborators and ensuring the entire team has the same context regardless of where they sit. Discussions includes:
The **Discussions** tab provides room for detailed and organized collaboration. This is key to looping in collaborators and ensuring the entire team has the same context regardless of where they sit. Discussions includes:

1. **Threaded conversations**: Reply directly to top level comments to tie replies to specific posts.
2. **Comment deletion**: Delete comments. The content of the post will be removed, but the box will remain with the message **comment deleted**.
3. **Markdown support**: Add styling and links to your comments in Markdown.

2. **Comment deletion**: Delete comments. The content of the post will be removed unless it is the parent of a thread, in which case the box will remain with the message “Comment deleted by user.”
3. **Markdown support**: Add styling and links to your comments in Markdown.

</Collapser>
</Collapser>
</CollapserGroup>


## Assign errors

You can assign an error group to anyone. Simply select the user from the assign dropdown menu. You may also assign an error to any email address, even if they aren’t a New Relic user.

You can update the filter in errors inbox to show only errors assigned to yourself, or a teammate.
You can update the filter in errors inbox to show only errors assigned to yourself, or a teammate.

<Callout variant="important">
Currently assigning an error group to a user does not send a notification. Notifications of assignment and changes to error groups will be coming soon.
</Callout>

## Connect an inbox to Slack [#slack]

When connected to Slack, new and resurfaced error groups will be sent to a Slack channel within seconds of them occurring. This enables your team to quickly identify any new errors or regressions, and resolve them quickly with direct links to the stack trace.
When connected to Slack, new and resurfaced error groups will be sent to a Slack channel within seconds of them occurring. This enables your team to quickly identify any new errors or regressions, and resolve them quickly with direct links to the stack trace.

1. If your Slack workspace does not have the [New Relic app](https://newrelic.slack.com/apps/AP92KQJS3-new-relic?tab=more_info) installed, do that first.
2. From an inbox, select the **Inbox Settings** icon (looks like a gear) in the top right corner.
Expand All @@ -162,7 +160,7 @@ When connected to Slack, new and resurfaced error groups will be sent to a Slack

## Connect errors inbox to CodeStream

To use CodeStream's Open in IDE with your APM stack trace errors, use environment variables to configure your APM agent with your application's [commit sha](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection) and/or your [release tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) associated with the running version of your software.
To use CodeStream's Open in IDE integration with your APM stack trace errors, use environment variables to configure your APM agent with your application's [commit sha](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection) and/or your [release tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) associated with the running version of your software.

Once set up, you can jump from an error group directly to the offending code in your IDE by clicking the **Open in IDE** button.

Expand Down

0 comments on commit 3bcc47c

Please sign in to comment.