diff --git a/src/content/docs/errors-inbox/version-tracking.mdx b/src/content/docs/errors-inbox/version-tracking.mdx new file mode 100644 index 00000000000..00fea401d43 --- /dev/null +++ b/src/content/docs/errors-inbox/version-tracking.mdx @@ -0,0 +1,73 @@ +--- +title: 'Error tracking with errors inbox' +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." +--- + +import errorsinboxFilterErrorsbyVersions from 'images/errors-inbox_screenshot-crop_filter-errors-by-versions.webp' + +import errorsinboxErrorDate from 'images/errors-inbox_screenshot-full_error-date.webp' + +import errorsinboxErrorsInboxChangeTracking from 'images/errors-inbox_screenshot-crop_errors-inbox-change-tracking.webp' + +Errors inbox version tracking allows developers to monitor each deployment to check for accuracy and success. Let's say you and your team get an alert that says one of your entities has a spike in its error rate. You identify the [source of the error](docs/tutorial-error-tracking/respond-outages/) and decide to release a canary deployment. You can use version tracking to monitor your fix as well as the previous deployments to determine if you solved the problem or if you need to go back to the drawing board. + +A screenshot that depicts error occurrences by version + +## Understand version tracking fields + +Before you instrument version tracking, it's important to understand how errors inbox sorts your results. In APM and OpenTelemetry applications, when you're tracking errors the following event fields are checked and displayed _in this order_: + +1. `service.version` +2. `tags.service.version` +3. `tags.releaseTag` +4. `tags.commit` + +For mobile applications, the event field is `appVersion`. + +For browser applications, the event field is `application.version`. + +## Instrument version tracking + +To capture data from our version tracking, you must configure fields for relevant entities: + +* [For OpenTelemetry entities, configure `service.version`](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-best-practices-resources/). +* For APM entities, configure environment variables for APM entities. + * [Go](/docs/apm/agents/go-agent/api-guides/guide-using-go-agent-api/#error-fingerprinting) + * [Java](/docs/apm/agents/java-agent/api-guides/java-agent-api-register-error-group-callback-to-set-fingerprint/) + * [.NET](https://docs.newrelic.com/docs/apm/agents/net-agent/net-agent-api/seterrorgroupcallback-net-agent-api/) + * [Node.js](docs/apm/agents/nodejs-agent/api-guides/guide-using-nodejs-agent-api/#errors) + * [Python](/docs/apm/agents/python-agent/python-agent-api/seterrrorgroupcallback-python-agent-api/) + * [Ruby](/docs/apm/agents/ruby-agent/api-guides/sending-handled-errors-new-relic/#error-fingerprinting) +* [For mobile entities, configure `appVersion`](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-application-version/). +* [For browser entities, use `application.version`](/docs/browser/new-relic-browser/browser-apis/setApplicationVersion/). + +## Filter by version +Once you have instrumented version tracking, your error groups will automatically capture data from each release. You can filter by each version. + +To filter error groups with multiple versions, use the + operator to choose an `OR` condition. + +A screenshot depicting how to filter by versions in errors inbox. + +You can use [change tracking](/docs/change-tracking/change-tracking-view-analyze/) to monitor your deployments. If you have done this, it's important to make sure that your deployments match the same version format you instrumented on your entities so you can match versions from your errors to your deployments. + +## Find versions by error group + +You can also click on an error group to see each deployment that matches the first and last seen dates for your error group. You will only see versions that were live within 30 minutes after your first seen date and within 30 minutes before your last seen date. + +A screenshot depicting last seen date of errors + +You can dive deeper into your error groups by using the chart that shows each of your error occurrences grouped by version. + +If you have also set up deployments with change tracking, you will see deployment markers on this chart. These markers indicate when each deployment was released. Click the marker to navigate to the deployment. diff --git a/src/images/errors-inbox_screenshot-crop_errors-inbox-change-tracking.webp b/src/images/errors-inbox_screenshot-crop_errors-inbox-change-tracking.webp new file mode 100644 index 00000000000..eb484503e8f Binary files /dev/null and b/src/images/errors-inbox_screenshot-crop_errors-inbox-change-tracking.webp differ diff --git a/src/images/errors-inbox_screenshot-crop_filter-errors-by-versions.webp b/src/images/errors-inbox_screenshot-crop_filter-errors-by-versions.webp new file mode 100644 index 00000000000..5d15582c3bc Binary files /dev/null and b/src/images/errors-inbox_screenshot-crop_filter-errors-by-versions.webp differ diff --git a/src/images/errors-inbox_screenshot-full_error-date.webp b/src/images/errors-inbox_screenshot-full_error-date.webp new file mode 100644 index 00000000000..f93d44bd8d3 Binary files /dev/null and b/src/images/errors-inbox_screenshot-full_error-date.webp differ diff --git a/src/nav/errors-inbox.yml b/src/nav/errors-inbox.yml index 5fc7dc258b5..3e6d1a5c710 100644 --- a/src/nav/errors-inbox.yml +++ b/src/nav/errors-inbox.yml @@ -16,6 +16,8 @@ pages: path: /docs/errors-inbox/error-users-impacted - title: Errors inbox external services path: /docs/errors-inbox/error-external-services + - title: Version tracking + path: /docs/errors-inbox/version-tracking - title: Group errors pages: - title: APM group errors tab