Commit 4a86262b authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'jivanvl-add-documentation-column-charts' into 'master'

Add documentation for column panel types

See merge request gitlab-org/gitlab!23907
parents 0c6e94b8 885e55a1
...@@ -329,6 +329,33 @@ Note the following properties: ...@@ -329,6 +329,33 @@ Note the following properties:
![anomaly panel type](img/prometheus_dashboard_anomaly_panel_type.png) ![anomaly panel type](img/prometheus_dashboard_anomaly_panel_type.png)
#### Column
To add a column panel type to a dashboard, look at the following sample dashboard file:
```yaml
dashboard: 'Dashboard Title'
panel_groups:
- group: 'Group title'
panels:
- title: "Column"
type: "column"
metrics:
- id: 1024_memory
query: 'avg(sum(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}) by (job)) without (job) / count(avg(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}) without (job)) /1024/1024'
unit: MB
label: "Memory Usage"
```
Note the following properties:
| Property | Type | Required | Description |
| ------ | ------ | ------ | ------ |
| type | string | yes | Type of panel to be rendered. For column panel types, set to `column` |
| query_range | yes | yes | For column panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) |
![anomaly panel type](img/prometheus_dashboard_column_panel_type.png)
##### Single Stat ##### Single Stat
To add a single stat panel type to a dashboard, look at the following sample dashboard file: To add a single stat panel type to a dashboard, look at the following sample dashboard file:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment