Include issues created in GitLab on Sentry error details page

Problem to solve

The triage and resolution process for errors is time-consuming and complicated enough without requiring users to check for duplicates. By surfacing existing issues that people have opened for specific errors, we can automatically help teams reduce time and work needed for manual deduplication of errors.

Currently the error detail page for a given error surfaces GitLab issues that were created via the Sentry UI or linked from the Sentry UI, as per the integration. The issue for this is here: #35891 (closed).

Once #37026 (closed) is complete, we will have a database table that associates Sentry errors with issues created for issues created in GitLab from errors. It would be useful to surface this data in the error detail page.

If we don't do this, the UI may seem inconsistent to users. When they create an issue from an error in the GitLab UI, under certain circumstances they won't see the issue appear in the error detail view and will continue to be be presented with the 'Create Issue' button.

Intended users

  • Delaney (Development Team Lead)
  • Sasha (Software Developer)
  • Devon (DevOps Engineer)
  • Sidney (Systems Administrator)

Further details

This work supports the Error Tracking Vision.

Proposal

Proposed solution

  • Backend: In the sentry client, check for a GitLab issue linked to the fetched error and insert into the existing linked issue field if found.
  • Frontend: Smallest iteration: no change.

Prior Behavior

  • GitLab issues created/linked in Sentry are shown in the error detail view.

There is an edge case: What do we do when there are two different linked issues in GitLab and Sentry. The easiest solution would be to only use the issue created from GitLab. It might be possible that the backend can prevent this outcome if some kind of migration of linked issues from Sentry to GitLab occurs.

Deliverable

  • GitLab issues created in GitLab or created/linked in Sentry are shown in the error detail view.

Permissions and Security

Documentation

Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Links / references

Edited Dec 16, 2019 by Sarah Waldner
Assignee Loading
Time tracking Loading