Custom metrics dashboard name should be reflected in the browser title
Problem to solve
As we aim to replace Grafana with Metrics Dashboard (internally) and advocating other organizations to do so, we should make it easier for users to know what dashboards they are looking at by looking at the website title. Right now, no matter what custom dashboard you are viewing on the metrics dashboard, the <title> of the page will not display the name of the dashboard. It only shows Metrics for environment · <name of environment> · <namespace> / <project name> · GitLab.
Intended users
- Delaney (Development Team Lead)
- Sasha (Software Developer)
- Devon (DevOps Engineer)
- Sidney (Systems Administrator)
- Allison (Application Ops)
Further details
Environments are tightly coupled with the metrics dashboard as described in #213833 (closed). It is going to take a lot of time to decouple them but we shouldn't let that stop us from improving this iteratively.
Proposal
Add the name of the dashboard to the <title>.
Eg. if a dashboard is named sla.yml, for a first iteration and improving this aspect, we can name the <title> sla.yml · Metrics Dashboard · <name of environment> · <namespace> / <project name> · GitLab.
The default dashboard will display the text default dashboard instead of the filename used for the other dashboards.
| Dashboard type | Before | After |
|---|---|---|
| Default | Metrics for environment · <name of environment> · <namespace> / <project name> · GitLab |
Default dashboard · Metrics Dashboard · <name of environment> · <namespace> / <project name> · GitLab |
| Custom | Metrics for environment · <name of environment> · <namespace> / <project name> · GitLab |
fileName.yml · Metrics Dashboard · <name of environment> · <namespace> / <project name> · GitLab |
Permissions and Security
Documentation
This will need documentation.