diff options
author | Tristan Read <tread@gitlab.com> | 2019-01-08 13:15:52 +0100 |
---|---|---|
committer | Tristan Read <tread@gitlab.com> | 2019-01-08 13:15:52 +0100 |
commit | 90351d8682c8f1682ced141840dba9cd23a89688 (patch) | |
tree | 6e11e4ec83d0130ba1b1a3ad5c88480c6fbe8399 | |
parent | e4c2bf8c1b36377a33d05fd27898c59777e926f7 (diff) | |
download | gitlab-ce-90351d8682c8f1682ced141840dba9cd23a89688.tar.gz |
Add Error Tracking documentation
-rw-r--r-- | doc/user/project/operations/error_tracking.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/user/project/operations/error_tracking.md b/doc/user/project/operations/error_tracking.md new file mode 100644 index 00000000000..3a1b28a688d --- /dev/null +++ b/doc/user/project/operations/error_tracking.md @@ -0,0 +1,35 @@ +# Error Tracking + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/169) in GitLab 11.8. + +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. + +### Deploying Sentry + +You may sign up to the cloud hosted https://sentry.io or deploy your own on-premise instance. + +On-premise deployment instructions are detailed in the [Sentry docs](https://docs.sentry.io/server/installation/). + +### 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. 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 List + +The Error Tracking list may be found at **Operations > Error Tracking** in your project's sidebar. + +TODO: Add screenshot |