From cb88a952807fcb53f98bacd371266408bb4555a2 Mon Sep 17 00:00:00 2001 From: Tristan Read Date: Tue, 8 Jan 2019 17:25:47 +0100 Subject: Add error tracking configuration screenshot --- doc/user/project/operations/error_tracking.md | 9 ++++----- .../operations/img/error_tracking_configuration.png | Bin 0 -> 242552 bytes 2 files changed, 4 insertions(+), 5 deletions(-) create mode 100644 doc/user/project/operations/img/error_tracking_configuration.png diff --git a/doc/user/project/operations/error_tracking.md b/doc/user/project/operations/error_tracking.md index 3805146959b..a815b5f68e6 100644 --- a/doc/user/project/operations/error_tracking.md +++ b/doc/user/project/operations/error_tracking.md @@ -4,11 +4,9 @@ Error tracking provides a way to ingest and display error tracking in GitLab. -TODO: 1 sentence explanation of why it's useful to view errors in GitLab. - ## Sentry error tracking -[Sentry](https://sentry.io/) is an open source error tracking system. +[Sentry](https://sentry.io/) is an open source error tracking system. GitLab allows administrators to integrate Sentry with GitLab, to allow users to view a list of Sentry errors in GitLab itself. ### Deploying Sentry @@ -18,16 +16,17 @@ On-premise deployment instructions are detailed in the [Sentry docs](https://doc ### Enabling Sentry -TODO: Potentially move this section to the admin docs - GitLab provides an easy way to connect to your Sentry instance from within your project. 1. Sign up to Sentry.io or [deploy your own](#deploying-sentry) Sentry instance 1. [Find or generate](https://docs.sentry.io/api/auth/) a Sentry auth token for your Sentry project 1. Navigate to your project’s **Settings > Operations** and provide the Sentry API URL and auth token +1. Ensure that the 'Active` checkbox is set 1. Click **Save changes** for the changes to take effect. 1. You can now visit **Operations > Error Tracking** in your project's sidebar to [view a list](#error-tracking-list) of Sentry errors +![Error Tracking configuration](img/error_tracking_configuration.png) + ## Error Tracking List The Error Tracking list may be found at **Operations > Error Tracking** in your project's sidebar. diff --git a/doc/user/project/operations/img/error_tracking_configuration.png b/doc/user/project/operations/img/error_tracking_configuration.png new file mode 100644 index 00000000000..006b54d51d4 Binary files /dev/null and b/doc/user/project/operations/img/error_tracking_configuration.png differ -- cgit v1.2.1