Tooling for reporting bugs to GitLab

Description

Let's build a tool that makes reporting issues to GitLab easy

Proposal

We ask for the same information in bug reports. It's useful to have all of the environment information, an instance check and also a stack trace.

Can we facilitate the process of reporting reproducible bugs?

What information is useful?

  • Sanitised information from the gitlab:check rake task
  • Environment information from the gitlab:env:info rake task
  • Stack trace for relevant 500 errors
  • Surrounding logs from sidekiq, workhorse etc

Links / references

Debian's reportbug:

Documentation blurb

Overview

What is it?

A command to help our users report bugs and problems with GitLab

Why should someone use this feature?

To report issues that they experience on their own instance

What is the underlying (business) problem?

Issues are often reported with not enough information. This should help us to gather accurate information about bugs that our users encounter

How do you use this feature?

  • sudo gitlab-rake gitlab:report_bug
  • sudo gitlab-ctl report_bug

?

Use cases

Who is this for? Provide one or more use cases.

Users that want to report a bug that they experience when using or administering GitLab to the issue tracker or the support team

Feature checklist

Make sure these are completed before closing the issue, with a link to the relevant commit.

Edited by Mark Fletcher