diff options
| -rw-r--r-- | doc/user/project/integrations/prometheus.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 765aa91b00f..7c5f8d70309 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -134,6 +134,7 @@ All projects include a GitLab-defined system dashboard, which includes a few key Dashboards have several components. A dashboard has many panel groups, which are comprised of panels, which support one or more metrics. The dashboard should be saved with the `.yml` extension. Sample YML Configuration + ``` dashboard: 'Dashboard Title' priority: 2 @@ -153,6 +154,7 @@ panel_groups: The above sample dashboard would display a single area chart. The following sections outline the details of expected properties. ##### Dashboard Properties + | Property | Type | Required? | Meaning | | ------ | ------ | ------ | ------ | | `dashboard` | string | required | Heading for the dashboard. Only one dashboard should be defined per file. | @@ -160,6 +162,7 @@ The above sample dashboard would display a single area chart. The following sect | `panel_groups` | array | required | The panel groups which should be on the dashboard. | ##### Panel Group Properties + | Property | Type | Required? | Meaning | | ------ | ------ | ------ | ------ | | `group` | string | required | Heading for the panel group. | @@ -167,6 +170,7 @@ The above sample dashboard would display a single area chart. The following sect | `panels` | array | required | The panels which should be in the panel group. | ##### Panel Properties + | Property | Type | Required? | Meaning | | ------ | ------ | ------ | ------- | | `type` | enum | optional, defaults to `area-chart` | Specifies the chart type to use. Only `area-chart` is currently supported. | @@ -176,6 +180,7 @@ The above sample dashboard would display a single area chart. The following sect | `metrics` | array | required | The metrics which should be displayed in the panel. | ##### Metric Properties + | Property | Type | Required? | Meaning | | ------ | ------ | ------ | ------ | | `id` | string | optional | Used for associating dashboard metrics with database records. Must be unique across dashboard configuration files. Required for [alerting](#setting-up-alerts-for-prometheus-metrics-ultimate) (support not yet enabled, see [relevant issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/60319)). | |