Configure self-monitoring project to display GitLab instance metrics
Problem to solve
The monitoring dashboard in the self-monitoring project does not display any metrics out of the box since it only displays metrics if there are deployments to an environment.
Displaying metrics of the GitLab instance on the monitoring dashboard would allow admins to view resource usage and other metrics without leaving GitLab. It will also further the goal of using monitor features for self-monitoring.
Intended users
- Sasha, Software Developer, https://design.gitlab.com/research/personas#persona-sasha
- Devon, DevOps Engineer, https://design.gitlab.com/research/personas#persona-devon
- Sidney, Systems Administrator, https://design.gitlab.com/research/personas#persona-sidney
Goal
This epic has 2 goals in mind:
- create a gitlab self-monitoring dashboard
- Document how to add additional metrics to improve the user experience
Further details
- Create a special case to load a different default dashboard for the self-monitoring project.
- Add the following metrics to the dashboard (see #38038 (comment 260119683) for more details)
- Web Traffic - Error Ratio
- API Traffic - Error Ratio
- Document how to add additional metrics.
- Remove the feature flag so users can install the Self-Monitoring project.
Proposal
Permissions and Security
Documentation
Testing
What does success look like, and how can we measure that?
The GitLab self-monitoring project will be able to display metrics of the GitLab instance on the monitoring dashboard out of the box. The metrics themselves can be defined in another issue.
Links / references
Edited by Matt Nohr