diff --git a/src/data/nav.yml b/src/data/nav.yml index a27b518c3..e8c34a840 100644 --- a/src/data/nav.yml +++ b/src/data/nav.yml @@ -63,6 +63,15 @@ url: '/automate-workflows/diagnose-problems/error-alerts' - title: Tear down Telco Lite url: '/automate-workflows/diagnose-problems/tear-down' + - title: Resolve Errors Faster with Full Stack Error Tracking + url: '/automate-workflows/error-inbox' + pages: + - title: Spin up Geek movie shop architecture + url: '/automate-workflows/error-inbox/spin-up-geek-movie' + - title: Create a workload + url: '/automate-workflows/error-inbox/create-a-workload' + - title: Track and triage errors in error inbox + url: '/automate-workflows/error-inbox/set-up-error-inbox' - title: Build apps icon: nr-build-apps url: '/build-apps' diff --git a/src/images/error-inbox/add-jira-destination.png b/src/images/error-inbox/add-jira-destination.png new file mode 100644 index 000000000..8f557bfd0 Binary files /dev/null and b/src/images/error-inbox/add-jira-destination.png differ diff --git a/src/images/error-inbox/add-jira-workspace.png b/src/images/error-inbox/add-jira-workspace.png new file mode 100644 index 000000000..0966d52ca Binary files /dev/null and b/src/images/error-inbox/add-jira-workspace.png differ diff --git a/src/images/error-inbox/add-new-template.png b/src/images/error-inbox/add-new-template.png new file mode 100644 index 000000000..bd383a286 Binary files /dev/null and b/src/images/error-inbox/add-new-template.png differ diff --git a/src/images/error-inbox/add-service-to-workload.png b/src/images/error-inbox/add-service-to-workload.png new file mode 100644 index 000000000..ecab8c79b Binary files /dev/null and b/src/images/error-inbox/add-service-to-workload.png differ diff --git a/src/images/error-inbox/assign-error-via-email.png b/src/images/error-inbox/assign-error-via-email.png new file mode 100644 index 000000000..dee61f20d Binary files /dev/null and b/src/images/error-inbox/assign-error-via-email.png differ diff --git a/src/images/error-inbox/assign-error.png b/src/images/error-inbox/assign-error.png new file mode 100644 index 000000000..c05e30d80 Binary files /dev/null and b/src/images/error-inbox/assign-error.png differ diff --git a/src/images/error-inbox/builtin-assertion-error.png b/src/images/error-inbox/builtin-assertion-error.png new file mode 100644 index 000000000..234dbee27 Binary files /dev/null and b/src/images/error-inbox/builtin-assertion-error.png differ diff --git a/src/images/error-inbox/change-filter.png b/src/images/error-inbox/change-filter.png new file mode 100644 index 000000000..139498a6d Binary files /dev/null and b/src/images/error-inbox/change-filter.png differ diff --git a/src/images/error-inbox/channel-wrong-state-error.png b/src/images/error-inbox/channel-wrong-state-error.png new file mode 100644 index 000000000..681bb50e7 Binary files /dev/null and b/src/images/error-inbox/channel-wrong-state-error.png differ diff --git a/src/images/error-inbox/channel-wrong-state.png b/src/images/error-inbox/channel-wrong-state.png new file mode 100644 index 000000000..d3e75c6bd Binary files /dev/null and b/src/images/error-inbox/channel-wrong-state.png differ diff --git a/src/images/error-inbox/codestream.png b/src/images/error-inbox/codestream.png new file mode 100644 index 000000000..d16dcb6ab Binary files /dev/null and b/src/images/error-inbox/codestream.png differ diff --git a/src/images/error-inbox/create-a-service-workload.png b/src/images/error-inbox/create-a-service-workload.png new file mode 100644 index 000000000..f0b122ab2 Binary files /dev/null and b/src/images/error-inbox/create-a-service-workload.png differ diff --git a/src/images/error-inbox/create-a-workload.png b/src/images/error-inbox/create-a-workload.png new file mode 100644 index 000000000..74b6d11a8 Binary files /dev/null and b/src/images/error-inbox/create-a-workload.png differ diff --git a/src/images/error-inbox/edit-template.png b/src/images/error-inbox/edit-template.png new file mode 100644 index 000000000..33a8050ac Binary files /dev/null and b/src/images/error-inbox/edit-template.png differ diff --git a/src/images/error-inbox/error-detail-page.png b/src/images/error-inbox/error-detail-page.png new file mode 100644 index 000000000..291f00d9e Binary files /dev/null and b/src/images/error-inbox/error-detail-page.png differ diff --git a/src/images/error-inbox/error-groups-in-errors-inbox.png b/src/images/error-inbox/error-groups-in-errors-inbox.png new file mode 100644 index 000000000..f50e1bbc8 Binary files /dev/null and b/src/images/error-inbox/error-groups-in-errors-inbox.png differ diff --git a/src/images/error-inbox/error-inbox.png b/src/images/error-inbox/error-inbox.png new file mode 100644 index 000000000..87a568bdd Binary files /dev/null and b/src/images/error-inbox/error-inbox.png differ diff --git a/src/images/error-inbox/errors-inbox-ui.png b/src/images/error-inbox/errors-inbox-ui.png new file mode 100644 index 000000000..2c3da4c89 Binary files /dev/null and b/src/images/error-inbox/errors-inbox-ui.png differ diff --git a/src/images/error-inbox/errors-inbox.png b/src/images/error-inbox/errors-inbox.png new file mode 100644 index 000000000..1642a88cd Binary files /dev/null and b/src/images/error-inbox/errors-inbox.png differ diff --git a/src/images/error-inbox/filters-pane.png b/src/images/error-inbox/filters-pane.png new file mode 100644 index 000000000..3b0c394d9 Binary files /dev/null and b/src/images/error-inbox/filters-pane.png differ diff --git a/src/images/error-inbox/full-trace.png b/src/images/error-inbox/full-trace.png new file mode 100644 index 000000000..bb21ecec0 Binary files /dev/null and b/src/images/error-inbox/full-trace.png differ diff --git a/src/images/error-inbox/ignore-assertion-error.png b/src/images/error-inbox/ignore-assertion-error.png new file mode 100644 index 000000000..62baca398 Binary files /dev/null and b/src/images/error-inbox/ignore-assertion-error.png differ diff --git a/src/images/error-inbox/ignored-error-groups.png b/src/images/error-inbox/ignored-error-groups.png new file mode 100644 index 000000000..454435959 Binary files /dev/null and b/src/images/error-inbox/ignored-error-groups.png differ diff --git a/src/images/error-inbox/jira-integration.png b/src/images/error-inbox/jira-integration.png new file mode 100644 index 000000000..ca203cc68 Binary files /dev/null and b/src/images/error-inbox/jira-integration.png differ diff --git a/src/images/error-inbox/loader-traffic.png b/src/images/error-inbox/loader-traffic.png new file mode 100644 index 000000000..3c95513f4 Binary files /dev/null and b/src/images/error-inbox/loader-traffic.png differ diff --git a/src/images/error-inbox/resolve-error.png b/src/images/error-inbox/resolve-error.png new file mode 100644 index 000000000..33da4b9c7 Binary files /dev/null and b/src/images/error-inbox/resolve-error.png differ diff --git a/src/images/error-inbox/select-workload.png b/src/images/error-inbox/select-workload.png new file mode 100644 index 000000000..0be2bc8ae Binary files /dev/null and b/src/images/error-inbox/select-workload.png differ diff --git a/src/images/error-inbox/show-full-stack-trace.png b/src/images/error-inbox/show-full-stack-trace.png new file mode 100644 index 000000000..428b970bf Binary files /dev/null and b/src/images/error-inbox/show-full-stack-trace.png differ diff --git a/src/images/error-inbox/unresolved-errors.png b/src/images/error-inbox/unresolved-errors.png new file mode 100644 index 000000000..8b82ce083 Binary files /dev/null and b/src/images/error-inbox/unresolved-errors.png differ diff --git a/src/images/error-inbox/view-ignored-errors.png b/src/images/error-inbox/view-ignored-errors.png new file mode 100644 index 000000000..ee5c7b098 Binary files /dev/null and b/src/images/error-inbox/view-ignored-errors.png differ diff --git a/src/images/error-inbox/workload-ui.png b/src/images/error-inbox/workload-ui.png new file mode 100644 index 000000000..151a5b30b Binary files /dev/null and b/src/images/error-inbox/workload-ui.png differ diff --git a/src/markdown-pages/automate-workflows/error-inbox/create-a-workload.mdx b/src/markdown-pages/automate-workflows/error-inbox/create-a-workload.mdx new file mode 100644 index 000000000..78371cf95 --- /dev/null +++ b/src/markdown-pages/automate-workflows/error-inbox/create-a-workload.mdx @@ -0,0 +1,55 @@ +--- +path: '/automate-workflows/error-inbox/create-a-workload' +title: 'Create a workload in New Relic' +template: 'GuideTemplate' +description: 'Create a workload consisting of geek movie services' +duration: 15 +procIdx: 2 +--- + + + +This procedure is part of a lab that teaches you how to track full stack errors using Error Inbox. + +Each procedure in the lab builds upon the last, so make sure you've [set your lab environment](/automate-workflows/error-inbox/spin-up-geek-movie), before starting this one. + + + +You can group specific apps and services that you want to monitor in a workload. This allows you to get an aggregated view of health and activity of the entities in the workload. You can also use workloads with error inbox to detect issues and track errors across your entire stack. + +In this procedure, you create a workload with all the geek movie shop services. + +# Create a workload + + + + +Navigate to [New Relic One](one.newrelic.com) and sign in with your account. + + + +Click **+ Create a workload** in top right hand corner. +![create a workload](../../../images/error-inbox/create-a-workload.png) + + + +Name your workload as _error-inbox-lab_. Under **Select entities**, scroll down to the geek shop services and click **+ Add** against each service to add it to workload. +![add service to workload](../../../images/error-inbox/add-service-to-workload.png) + + + +Click **Create a workload** once you've added all the services. +![create a workload with services](../../../images/error-inbox/create-a-service-workload.png) + + + +This creates a workload with all the geek-movie services for you and automatically redirects you to view the workload in New Relic. +![error inbox lab workload](../../../images/error-inbox/workload-ui.png) + +Now that you have created workload, you can set up error inbox. + + + +This procedure is part of a lab that teaches you how to track full stack errors using Error Inbox. Now that you've created a workload, continue on to next procedure [Track and triage errors in error inbox](/automate-workflows/error-inbox/set-up-error-inbox). + + \ No newline at end of file diff --git a/src/markdown-pages/automate-workflows/error-inbox/index.mdx b/src/markdown-pages/automate-workflows/error-inbox/index.mdx new file mode 100644 index 000000000..5f96824f1 --- /dev/null +++ b/src/markdown-pages/automate-workflows/error-inbox/index.mdx @@ -0,0 +1,44 @@ +--- +path: '/automate-workflows/error-inbox' +title: 'Resolve Errors Faster with Full Stack Error Tracking' +template: 'LabOverviewTemplate' +description: 'Use New Relic to qucikly track errors in your application with the help of error inbox.' +--- + + + +You're a developer of an eCommerce website called Geek's movie shop. You made some recent changes in your site's architecture and introduced some new features. The changes are ready to go live. However, you know that it's hard to identify the blast radius of errors once the application is in production. Since the changes are going to impact thousands of your customers, you want to find out if these changes will have any negative effect on them before pushing it to production. +To ensure a smooth experience for your customers, you can use Error Inbox to track errors across you stack and take action on them before they impact your customers. + + + + + +Errors inbox is not available in the EU region. + + + +
+ +
+ +## Learning Objectives + +In this lab, you: + +- Spin up the infrastructure for Geek's movie shop +- Create a workload in New Relic +- Track and triage errors in error Inbox + +
+ +
+ +## Requirements + +- Create a free [New Relic account](https://newrelic.com/signup?utm_source=developer-site) +- Install [Docker](https://www.docker.com/) + +
+ +
diff --git a/src/markdown-pages/automate-workflows/error-inbox/set-up-error-inbox.mdx b/src/markdown-pages/automate-workflows/error-inbox/set-up-error-inbox.mdx new file mode 100644 index 000000000..6d636d39a --- /dev/null +++ b/src/markdown-pages/automate-workflows/error-inbox/set-up-error-inbox.mdx @@ -0,0 +1,199 @@ +--- +path: '/automate-workflows/error-inbox/set-up-error-inbox' +title: 'Track and Triage errors in error inbox' +template: 'GuideTemplate' +description: 'Set up error inbox to track and triage errors across your stack' +duration: 15 +procIdx: 3 +--- + + + +This procedure is part of a lab that teaches you how to track full stack errors using Error Inbox. + +Each procedure in the lab builds upon the last, so make sure you've completed the last procedure, [Create a workload](/automate-workflows/error-inbox/create-a-workload), before starting this one. + + + +Error inbox provides a unified error tracking to detect and triage errors from across your stack. You analyze the errors in context of the full stack and resolve them with precision. + +In this procedure, you track and triage errors across your stack using error inbox. + + + +Errors inbox is not available in the EU region. + + + +# Set up error inbox + +Before you start tracking error in errors inbox, you need to set it up. + +Enable error inbox as follow: + + + +From [New Relic One](one.newrelic.com), select **Errors Inbox** from the top nav. +![navigate to errors inbox](../../../images/error-inbox/errors-inbox-ui.png) + + + +Click **Select Workload** and select **error-inbox-lab** workload from the drop down. +![select a workload](../../../images/error-inbox/select-workload.png) + + + +You see the error groups across your workload here. +![errors group in error inbox](../../../images/error-inbox/error-groups-in-errors-inbox.png) + + + +Your error inbox is now set and you can start proactively monitoring errors across your stack. + +# Triage errors + +You can triage error groups directly from the main screen. Triaging helps removing the noise from your error inbox so you focus on the high impact errors. + +## Error details + +With errors inbox, you get all the errors on one screen. To understand the root cause of these error, you need more details. For instance: + +Click on **pika.exceptions:ChannelWrongStateError** error. +![pika.exceptions:ChannelWrongStateError error](../../../images/error-inbox/channel-wrong-state-error.png) + +This takes you to error details page. You find full context of the issue here including **Occurances**, **Stack Trace** and others. +![error detail page](../../../images/error-inbox/error-detail-page.png) + +Stack trace is especially important since it helps you narrow down the cause of the problem. +Under **Stack Trace**, click **Show all** in bottom right corner. +![show full stack trace](../../../images/error-inbox/show-full-stack-trace.png) + +This shows you the full stack trace. +![full stack trace](../../../images/error-inbox/full-trace.png) + +By taking a closer look at the above trace, you know for sure that something is wrong in your payment service. Now you can fix it before pushing the changes to production. + + + +You can also integrate [CodeStream](https://newrelic.com/codestream) with your errors inbox. This allows you to explore the stack trace in your IDE on a click of a single button. Once you've configured CodeStream, click ** Open in IDE** button to navigate to your IDE and explore the error. +![Code Stream Integration](../../../images/error-inbox/codestream.png) + + +## Change the error status + +Each error in errors inbox has **unresolved** status by defulat. But you can set your error status as resolved, or ignored and filter your inbox by status. + +### Set the error status as 'Resolved' +Once you fixed the issue, you come back to errors inbox and change its status to resolved. + +Navigate to **Errors inbox** in New Relic One. +![errors inbox](../../../images/error-inbox/errors-inbox.png) + +You were told that another developer on your team has fixed **pika.exceptions:ChannelWrongStateError** but the errors inbox still has this issue marked as unresolved. Change it's status: + +Click **Unresolved** against the error. +![channel wrong state error](../../../images/error-inbox/channel-wrong-state.png) + +You see two options in the dropdown here. Select **Resolve**. +![set error status to resolve](../../../images/error-inbox/resolve-error.png) + +Once the status is updated, you no longer see the error on the main screen. However, if the error still persists, then it'll automatically be marked as unresolved. + +### Set the error status as 'Ignored' +Some errors are expected and part of the system as it operates. Set those errors as ignored: + +Navigate to **Errors inbox** in New Relic One. +![errors inbox](../../../images/error-inbox/error-inbox.png) + +Take a quick scan of the errors here. There's one **builtins:AssertionError**. +![assertion-error](../../../images/error-inbox/builtin-assertion-error.png) + +This error is expected since the payment was aborted by the user and there's nothing you can do about it. Ignore this error: + +Click **Unresolved** against the error and then select **Ignore** from the dropdown. +![ignore error](../../../images/error-inbox/ignore-assertion-error.png) + +Once the status is updated, you no longer see the error on the main screen until you stop ignoring or change the filter to include ignored error groups. + +## Change filter +By default, errors inbox show all the unresolved errors on the main screen. Once the error status is updated to resolved or ignored, you no longer see the error on the main screen. However, you can change the filter to view these errors. + +The main screen of errors inbox has a filter pane right below the top nav. +![filters pane of errors inbox](../../../images/error-inbox/filters-pane.png) + +Click **Unresolved** to change the filter value. +![chnage filter value](../../../images/error-inbox/change-filter.png) + +Here, you see three options in the dropdown. Select **Ignored**. +![view ignored error groups](../../../images/error-inbox/view-ignored-errors.png) + +Your errors inbox now show all the ignored error groups. +![ignored error groups](../../../images/error-inbox/ignored-error-groups.png) + +## Assign errors +Change the errors inbox filter to show all the unresolved errors. +![unresolved error groups](../../../images/error-inbox/unresolved-errors.png) + +Oops! you were told that somebody fixed **pika.exceptions:ChannelWrongStateError** error but you still see it under unresolved errors. You don't know who fixed this error previously and there's no way for you to find that out. To avoid such situation in future, assign the error from inside errors inbox. + +Click the human icon on the far right side of the error group. +![assign error](../../../images/error-inbox/assign-error.png) + +Enter the email address of the person you want to assign error to, and click **+**. +![assign error via email](../../../images/error-inbox/assign-error-via-email.png) + +The error is now assigned and its now easier for you to keep a track of who worked on the error. + + + +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. + + +## Connect an inbox to Jira +Connect errors inbox to jira to qucikly and easily create tickets containing error details and link to the stack trace. It allows you to collaborate and resolve errors faster. + +Connect your errors inbox to jira: + + + +Click on the Jira integration icon on the far right side of the error group you want to connect to Jira. +![jira integration](../../../images/error-inbox/jira-integration.png) + + + +Click **Add JIRA Workspace** from the dropdown. +![add jira workspace](../../../images/error-inbox/add-jira-workspace.png) + + + +Fill in the fields on the next page and click **Test connection** to ensure that your details are correct. Then, click **Save destination**. +![add jira destination](../../../images/error-inbox/add-jira-destination.png) + + + +Next, set up a template. Click the jira integration icon against the error group and select **Add New Template +**. +![add new template](../../../images/error-inbox/add-new-template.png) + + + +Add **Jira destination**, **Project**, and **Issue type** on the next page and click **Update message** to save the template. +![edit template](../../../images/error-inbox/edit-template.png) + + + +Here, you can also click **Send test notification** to preview the ticket in your jira board before saving the template. Note that a test notification will create a jira ticket in your workspace. + + + + +Now you can create jira ticket by clicking the jira integration icon on the far right side of the error group and selecting a template. + +# Summary: +In this lab, you set up errors inbox to track and triage errors in your application. You also integrated your errors inbox with jira to help you effectively collaborate and resolve errors faster from across your stack. +For more help + +# Homework +Now that you know how to track and triage errors using errors inbox, here are some other things to familiarize yourself even more with errors inbox. +- Read our documentation on [errors inbox](https://docs.newrelic.com/docs/errors-inbox/errors-inbox/) +- Read our blog [Collaborate and fix errors quickly with Errors Inbox and workloads](https://newrelic.com/blog/how-to-relic/track-errors-errors-inbox) +- Read our blog [Error Tracking Across Your Entire Stack with New Relic Errors Inbox](https://newrelic.com/blog/how-to-relic/error-tracking-with-errors-inbox) \ No newline at end of file diff --git a/src/markdown-pages/automate-workflows/error-inbox/spin-up-geek-movie.mdx b/src/markdown-pages/automate-workflows/error-inbox/spin-up-geek-movie.mdx new file mode 100644 index 000000000..f43343394 --- /dev/null +++ b/src/markdown-pages/automate-workflows/error-inbox/spin-up-geek-movie.mdx @@ -0,0 +1,95 @@ +--- +path: '/automate-workflows/error-inbox/spin-up-geek-movie' +title: 'Spin up Geek movie architecture' +template: 'GuideTemplate' +description: 'Set up your your environment to deploy geek movie shop.' +duration: 20 +procIdx: 1 +--- + + + +This procedure is part of a lab that teaches you how to track full stack errors using Error Inbox. If you haven't already, check out the [lab introduction](/automate-workflows/error-inbox). + + + +Geek's Movie Shop (former Stan's Robot Shop) is a web application that consists of several interconnected microservices like cart, catalogue, payment, user, and more. These services are instrumented with New Relic for performance monitoring and full visibility across all layers. The application also has a loader service that generates traffic In this lab, we use New Relic's Error Inbox for full stack error tracking. + +## Set up your environment + +Before you begin with the lab, set up your development environment. + + +Clone the lab repository: + +```bash +git clone https://github.com/newrelic-experimental/error-inbox-lab-materical.git +``` + + + +Open the cloned repo in your IDE and create a .env file from env.template and set these variables: + +``` +DOCKERHUB_USER=username +TAG=latest +CLUSTER_NAME=local +PUBLIC_URL=http://docker-for-desktop:8888 + +NEW_RELIC_LICENSE_KEY= +``` + +Here, NEW_RELIC_LICENSE_KEY is your liscence key for New Relic account. Your application uses this key to write telemetry data to New Relic. [You can find your New Relic license key in your account settings](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/). + + + + +Navigate to the root directory of your application and export these variables: + +```bash +./env.sh +``` + + +Build and run the application: + +```bash animate +docker compose build +docker compose up +[output] {blue} [+] Building 96.1s (103/103) FINISHED +[output] {blue}=> [username/rs-shipping:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 784B 0.0s +[output] {blue}=> [username/rs-mongodb:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 95B 0.0s +[output] {blue}=> [username/rs-ratings:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 1.11kB 0.0s +[output] {blue}=> [username/rs-dispatch:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 398B 0.0s +[output] {blue}=> [username/rs-catalogue:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 187B 0.0s +[output] {blue}=> [username/rs-web:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 234B 0.0s +[output] {blue}=> [username/rs-cart:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 187B 0.0s +[output] {blue}=> [username/rs-payment:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 227B 0.0s +[output] {blue}=> [username/rs-mysql:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 422B 0.0s +[output] {blue}=> [username/rs-user:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 187B 0.0s +[output] {blue}=> [username/rs-loader:latest internal] load build definition from Dockerfile 0.0s +[output] {blue}=> => transferring dockerfile: 187B 0.0s +``` +Once your application is up and running, you'll see loader generating the traffic: + +![loader traffic](../../../images/error-inbox/loader-traffic.png) + +Leave the application running so you could see the telemetry data in New Relic. + + + + + +This procedure is part of a lab that teaches you how to track full stack errors using Error Inbox. Now that you've set up your environment, [Create a workload](/automate-workflows/error-inbox/create-a-workload). + + diff --git a/src/markdown-pages/contribute-to-quickstarts/person.png b/src/markdown-pages/contribute-to-quickstarts/person.png new file mode 100644 index 000000000..fcf89b242 Binary files /dev/null and b/src/markdown-pages/contribute-to-quickstarts/person.png differ