Error Tracking

Introduced in GitLab 11.8.

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 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.

Deploying Sentry

You may sign up to the cloud hosted https://sentry.io, deploy your own on-premise instance or use GitLab to install Sentry to a Kubernetes cluster.

Enabling Sentry

Note: You will need at least Maintainer permissions to enable the Sentry integration.

GitLab provides an easy way to connect Sentry to your project:

  1. Sign up to Sentry.io or deploy your own Sentry instance.
  2. Create a new Sentry project. For each GitLab project that you want to integrate, we recommend that you create a new Sentry project.
  3. Find or generate a Sentry auth token for your Sentry project. Make sure to give the token at least the following scopes: event:read and project:read.
  4. Navigate to your project’s Settings > Operations.
  5. Ensure that the Active checkbox is set.
  6. In the Sentry API URL field, enter your Sentry hostname. For example, enter https://sentry.example.com if this is the address at which your Sentry instance is available. For the SaaS version of Sentry, the hostname will be https://sentry.io.
  7. In the Auth Token field, enter the token you previously generated.
  8. Click the Connect button to test the connection to Sentry and populate the Project dropdown.
  9. From the Project dropdown, choose a Sentry project to link to your GitLab project.
  10. Click Save changes for the changes to take effect.
  11. You can now visit Operations > Error Tracking in your project’s sidebar to view a list of Sentry errors.

You may also want to enable Sentry’s GitLab integration by following the steps in the Sentry documentation

Error Tracking List

Note: You will need at least Reporter permissions to view the Error Tracking list.

You can find the Error Tracking list at Operations > Error Tracking in your project’s sidebar. Here, you can filter errors by title or by status (one of Ignored , Resolved, or Unresolved) and sort in descending order by Frequency, First Seen, or Last Seen. By default, the error list is ordered by Last Seen and filtered to Unresolved errors.

Error Tracking list

Error Details

From error list, users can navigate to the error details page by clicking the title of any error.

This page has:

  • A link to the Sentry issue.
  • A link to the GitLab commit if the Sentry release ID/version on the Sentry Issue’s first release matches a commit SHA in your GitLab hosted project.
  • Other details about the issue, including a full stack trace.
  • In GitLab 12.7 and newer, language and urgency are displayed.

By default, a Create issue button is displayed:

Error Details without Issue Link

If you create a GitLab issue from the error, the Create issue button will change to a View issue button and a link to the GitLab issue will surface within the error detail section:

Error Details with Issue Link

Taking Action on errors

You can take action on Sentry Errors from within the GitLab UI.

Ignoring errors

GitLab 12.7で導入されました。

From within the Error Details page you can ignore a Sentry error by simply clicking the Ignore button near the top of the page.

Ignoring an error will prevent it from appearing in the Error Tracking List, and will silence notifications that were set up within Sentry.

Resolving errors

GitLab 12.7で導入されました。

From within the Error Details page you can resolve a Sentry error by clicking the Resolve button near the top of the page.

Marking an error as resolved indicates that the error has stopped firing events. If a GitLab issue is linked to the error, then the issue will be closed.

If another event occurs, the error reverts to unresolved.