diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2019-01-10 13:24:47 +0000 |
|---|---|---|
| committer | GitLab Release Tools Bot <robert+release-tools@gitlab.com> | 2019-01-10 21:11:21 +0000 |
| commit | 077f443b67ce1a80182dd12b604c26496b0dbd6b (patch) | |
| tree | 20f80235e9bc3a51e67400c0399a3e4cda0336a9 | |
| parent | c0aa6edc81e25ee38027d3bf2a1b7702bccab97f (diff) | |
| download | gitlab-ce-077f443b67ce1a80182dd12b604c26496b0dbd6b.tar.gz | |
Merge branch 'docs-error-tracking' into 'master'
Add documentation for Error Tracking
Closes #55581
See merge request gitlab-org/gitlab-ce!24275
(cherry picked from commit be855cc6a2b85da2ec3e51e0f767099dc87991e6)
21cc094e Add Error Tracking documentation
7887488c Add link to Error Tracking in operations settings docs
4eb796db Clean up various typos / styling issues
| -rw-r--r-- | doc/user/project/operations/error_tracking.md | 30 | ||||
| -rw-r--r-- | doc/user/project/operations/img/error_tracking_list.png | bin | 0 -> 230740 bytes | |||
| -rw-r--r-- | doc/user/project/settings/index.md | 6 |
3 files changed, 36 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..2b5abc7233f --- /dev/null +++ b/doc/user/project/operations/error_tracking.md @@ -0,0 +1,30 @@ +# Error Tracking + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/169) in GitLab 11.7. + +Error tracking allows developers to easily discover and view the errors that their application may be generating. By surfacing error information where the code is being developed, efficiency and awareness can be increased. + +## Sentry error tracking + +[Sentry](https://sentry.io/) is an open source error tracking system. GitLab allows administrators to connect Sentry to GitLab, to allow users to view a list of Sentry errors in GitLab itself. + +### Deploying Sentry + +You may sign up to the cloud hosted https://sentry.io or deploy your own [on-premise instance](https://docs.sentry.io/server/installation/). + +### Enabling Sentry + +GitLab provides an easy way to connect Sentry to 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 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_list.png b/doc/user/project/operations/img/error_tracking_list.png Binary files differnew file mode 100644 index 00000000000..aa0f9867fdb --- /dev/null +++ b/doc/user/project/operations/img/error_tracking_list.png diff --git a/doc/user/project/settings/index.md b/doc/user/project/settings/index.md index d6754372816..221fa4b3d9f 100644 --- a/doc/user/project/settings/index.md +++ b/doc/user/project/settings/index.md @@ -122,3 +122,9 @@ GitLab administrators can use the admin interface to move any project to any namespace if needed. [permissions]: ../../permissions.md##project-members-permissions + +## Operations settings + +### Error Tracking + +Configure Error Tracking to discover and view [Sentry errors within GitLab](../operations/error_tracking.md). |
