2020-07-28 23:09:34 +05:30
---
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-07-28 23:09:34 +05:30
---
2022-03-02 08:16:31 +05:30
# Custom dashboards (DEPRECATED) **(FREE)**
2020-07-28 23:09:34 +05:30
2022-03-02 08:16:31 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/59974) in GitLab 12.1.
> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) in GitLab 14.7.
WARNING:
This feature is in its end-of-life process. It is [deprecated ](https://gitlab.com/gitlab-org/gitlab/-/issues/346541 )
for use in GitLab 14.7, and is planned for removal in GitLab 15.0.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
By default, all projects include a [GitLab-defined Prometheus dashboard ](default.md ), which
includes a few key metrics, but you can also define your own custom dashboards.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
You may create a [new dashboard from scratch ](#add-a-new-dashboard-to-your-project )
or [duplicate a GitLab-defined Prometheus dashboard ](#duplicate-a-gitlab-defined-dashboard ).
## Add a new dashboard to your project
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
> UI option [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228856) in GitLab 13.3.
You can configure a custom dashboard by adding a new YAML file into your project's
`.gitlab/dashboards/` directory. For the dashboard to display on your project's
2021-09-04 01:27:46 +05:30
**Monitor > Metrics** page, the files must have a `.yml`
2020-10-24 23:57:45 +05:30
extension and be present in your project's **default** branch.
To create a new dashboard from the GitLab user interface:
1. Sign in to GitLab as a user with Maintainer or Owner
2020-07-28 23:09:34 +05:30
[permissions ](../../../user/permissions.md#project-members-permissions ).
2021-09-04 01:27:46 +05:30
1. Navigate to your dashboard at **Monitor > Metrics** .
2020-10-24 23:57:45 +05:30
1. In the top-right corner of your dashboard, click the ** {ellipsis_v}** **More actions** menu,
and select **Create new** :
1. In the modal window, click **Open Repository** , then follow the instructions
for creating a new dashboard from the command line.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
To create a new dashboard from the command line:
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
1. Create `.gitlab/dashboards/prom_alerts.yml` under your repository's root
directory. Each YAML file should define the layout of the dashboard and the
Prometheus queries used to populate data. This example dashboard displays a
single area chart:
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
```yaml
dashboard: 'Dashboard Title'
panel_groups:
- group: 'Group Title'
panels:
- type: area-chart
2021-01-03 14:25:43 +05:30
title: 'Chart Title'
y_label: 'Y-Axis'
2020-10-24 23:57:45 +05:30
y_axis:
format: number
precision: 0
metrics:
- id: my_metric_id
query_range: 'http_requests_total'
2021-01-03 14:25:43 +05:30
label: 'Instance: {{instance}}, method: {{method}}'
unit: 'count'
2020-10-24 23:57:45 +05:30
```
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
1. Save the file, commit, and push to your repository. The file must be present in your **default** branch.
2021-09-04 01:27:46 +05:30
1. Navigate to your project's **Monitor > Metrics** and choose the custom
2020-10-24 23:57:45 +05:30
dashboard from the dropdown.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
Your custom dashboard is available at `https://example.com/project/-/metrics/custom_dashboard_name.yml` .
2020-07-28 23:09:34 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
Configuration files nested under subdirectories of `.gitlab/dashboards` aren't
supported or available in the UI.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
## Add a new metrics panel to a dashboard
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
> UI option [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228761) in GitLab 13.3.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
The metrics dashboard supports various [multiple panel types ](../../../operations/metrics/dashboards/panel_types.md ).
You can quickly test how a panel configuration would display in your metrics dashboard
with the **Add Panel** page:
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
1. Sign in to GitLab as a user with Maintainer or Owner
[permissions ](../../../user/permissions.md#project-members-permissions ).
1. Click **Add panel** in the ** {ellipsis_v}** **More actions** menu.
2021-02-22 17:27:13 +05:30
NOTE:
2021-01-03 14:25:43 +05:30
You can only add panels to custom dashboards.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
1. In the **Define and preview panel** section, paste in the YAML you want to
preview in the **Panel YAML** field.
1. Click **Preview panel** , and GitLab displays a preview of the chart below the
`Define and preview panel` section:
## Duplicate a GitLab-defined dashboard
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/37238) in GitLab 12.7.
2021-03-11 19:13:27 +05:30
> - [GitLab versions 12.8 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/39505), custom metrics are also duplicated when you duplicate a dashboard.
2020-10-24 23:57:45 +05:30
2021-01-03 14:25:43 +05:30
You can save a complete copy of a GitLab-defined dashboard along with all custom metrics added to it.
2020-10-24 23:57:45 +05:30
The resulting `.yml` file can be customized and adapted to your project.
You can decide to save the dashboard `.yml` file in the project's **default** branch or in a
2021-01-03 14:25:43 +05:30
new branch. To duplicate a GitLab-defined dashboard:
2020-10-24 23:57:45 +05:30
1. Click **Duplicate current dashboard** in the ** {ellipsis_v}** **More actions** menu.
1. Enter the filename and other information, such as the new commit's message, and click **Duplicate** .
1. Select a branch to add your dashboard to:
- *If you select your **default** branch,* the new dashboard becomes immediately available.
- *If you select another branch,* this branch should be merged to your **default** branch first.
Your custom dashboard is available at `https://example.com/project/-/metrics/custom_dashboard_name.yml` .
## Manage the metrics dashboard settings
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/223204) in GitLab 13.2.
2021-01-29 00:20:46 +05:30
Users with project Maintainer or Administrator
[permissions ](../../../user/permissions.md#project-members-permissions )
can manage [the settings ](settings.md ) for your metrics dashboard.
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
## Chart Context Menu
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
You can take action related to a chart's data by clicking the
**{ellipsis_v}** **More actions** dropdown box above the upper right corner of
any chart on a dashboard:
2020-07-28 23:09:34 +05:30
2021-09-30 23:02:18 +05:30
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
The options are:
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
- **Expand panel** - Displays a larger version of a visualization. To return to
2021-03-11 19:13:27 +05:30
the dashboard, click the **Back** button in your browser, or press the < kbd > Escape</ kbd > key.
2020-10-24 23:57:45 +05:30
([Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3100) in GitLab 13.0.)
- **View logs** ** (ULTIMATE)** - Displays [Logs ](../../../user/project/clusters/kubernetes_pod_logs.md ),
if they are enabled. If used in conjunction with the [timeline zoom ](#timeline-zoom-and-url-sharing )
feature, logs narrow down to the selected time range. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/122013) in GitLab 12.8.)
- **Download CSV** - Data from Prometheus charts on the metrics dashboard can be downloaded as CSV.
- [Copy link to chart ](../embed.md#embedding-gitlab-managed-kubernetes-metrics )
2020-07-28 23:09:34 +05:30
### Timeline zoom and URL sharing
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198910) in GitLab 12.8.
You can use the **Timeline zoom** function at the bottom of a chart to zoom in
on a date and time of your choice. When you click and drag the sliders to select
a different beginning or end date of data to display, GitLab adds your selected start
2021-03-11 19:13:27 +05:30
and end times to the URL, enabling you to share specific time frames more easily.
2020-07-28 23:09:34 +05:30
## Dashboard Annotations
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211330) in GitLab 12.10 (enabled by feature flag `metrics_dashboard_annotations`).
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/215224) in GitLab 13.0.
You can use **Metrics Dashboard Annotations** to mark any important events on
every metrics dashboard by adding annotations to it. While viewing a dashboard,
2021-02-22 17:27:13 +05:30
annotation entries assigned to the selected time range are automatically
2020-07-28 23:09:34 +05:30
fetched and displayed on every chart within that dashboard. On mouse hover, each
annotation presents additional details, including the exact time of an event and
its description.
You can create annotations by making requests to the
[Metrics dashboard annotations API ](../../../api/metrics_dashboard_annotations.md )
2020-10-24 23:57:45 +05:30
2020-07-28 23:09:34 +05:30
2020-10-24 23:57:45 +05:30
### Annotation retention policy
2020-07-28 23:09:34 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211433) in GitLab 13.01.
To avoid excessive storage space consumption by stale annotations, records attached
to time periods older than two weeks are removed daily. This recurring background
job runs at 1:00 a.m. local server time.
## Add related links to custom dashboards
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216385) in GitLab 13.1.
You can embed links to other dashboards or external services in your custom
dashboard by adding **Related links** to your dashboard's YAML file. Related links
open in the same tab as the dashboard. Related links can be displayed in the
following locations on your dashboard:
- At the top of your dashboard as the top level [`links` dashboard property ](../../../operations/metrics/dashboards/yaml.md#dashboard-top-level-properties ).
- In charts context menus as the [`links` property of a panel ](../../../operations/metrics/dashboards/yaml.md#panel-panels-properties ).
Related links can contain the following attributes:
- `url` : The full URL to the link. Required.
- `title` : A phrase describing the link. Optional. If this attribute is not set,
the full URL is used for the link title.
- `type` : A string declaring the type of link. Optional. If set to `grafana` , the
dashboard's time range values are converted to Grafana's time range format and
appended to the `url` .
The dashboard's time range is appended to the `url` as URL parameters.
The following example shows two related links (`GitLab.com` and `GitLab Documentation` )
added to a dashboard:
2020-10-24 23:57:45 +05:30
2020-07-28 23:09:34 +05:30
### Links Syntax
```yaml
links:
- title: GitLab.com
url: https://gitlab.com
- title: GitLab Documentation
url: https://docs.gitlab.com
- title: Public Grafana playground dashboard
url: https://play.grafana.org/d/000000012/grafana-play-home?orgId=1
type: grafana
```
## Troubleshooting
2021-09-04 01:27:46 +05:30
### Accessing the UI of Prometheus in Kubernetes
When troubleshooting issues with an in-cluster Prometheus, it can help to
view the Prometheus UI. In the example below, we assume the Prometheus
server to be the pod `prometheus-prometheus-server` in the `gitlab-managed-apps`
namespace:
1. Find the name of the Prometheus pod in the user interface of your Kubernetes
provider, such as GKE, or by running the following `kubectl` command in your
terminal. For example:
```shell
kubectl get pods -n gitlab-managed-apps | grep 'prometheus-prometheus-server'
```
The command should return a result like the following example, where
`prometheus-prometheus-server-55b4bd64c9-dpc6b` is the name of the Prometheus pod:
```plaintext
gitlab-managed-apps prometheus-prometheus-server-55b4bd64c9-dpc6b 2/2 Running 0 71d
```
1. Run a `kubectl port-forward` command. In the following example, `9090` is the
Prometheus server's listening port:
```shell
kubectl port-forward prometheus-prometheus-server-55b4bd64c9-dpc6b 9090:9090 -n gitlab-managed-apps
```
The `port-forward` command forwards all requests sent to your system's `9090` port
to the `9090` port of the Prometheus pod. If the `9090` port on your system is used
by another application, you can change the port number before the colon to your
desired port. For example, to forward port `8080` of your local system, change the
command to:
```shell
kubectl port-forward prometheus-prometheus-server-55b4bd64c9-dpc6b 8080:9090 -n gitlab-managed-apps
```
1. Open `localhost:9090` in your browser to display the Prometheus user interface.
2020-07-28 23:09:34 +05:30
### "No data found" error on Metrics dashboard page
If the "No data found" screen continues to appear, it could be due to:
- No successful deployments have occurred to this environment.
- Prometheus does not have performance data for this environment, or the metrics
are not labeled correctly. To test this, connect to the Prometheus server and
[run a query ](../../../user/project/integrations/prometheus_library/kubernetes.md#metrics-supported ), replacing `$CI_ENVIRONMENT_SLUG`
with the name of your environment.
- You may need to re-add the GitLab predefined common metrics. This can be done by running the [import common metrics Rake task ](../../../administration/raketasks/maintenance.md#import-common-metrics ).
