diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-05 00:06:15 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-05 00:06:15 +0300 |
commit | a5af2cab8c4543b413d674b8a3048dcbe59f1b0b (patch) | |
tree | 7265293aacd1147992a4d64c4b1aec16f7099e7b /doc | |
parent | 7b25b12016eeca73262cf2a618b411fb911295e1 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ci/yaml/README.md | 3 | ||||
-rw-r--r-- | doc/user/project/integrations/img/heatmap_panel_type.png | bin | 0 -> 8272 bytes | |||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 29 |
3 files changed, 32 insertions, 0 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 8449dfec049..eb78ceacf26 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -456,6 +456,9 @@ Jobs will run on your own Runners in parallel only if: ### `only`/`except` (basic) +NOTE: **Note:** +These parameters will soon be [deprecated](https://gitlab.com/gitlab-org/gitlab/issues/27449) in favor of [`rules`](#rules) as it offers a more powerful syntax. + `only` and `except` are two parameters that set a job policy to limit when jobs are created: diff --git a/doc/user/project/integrations/img/heatmap_panel_type.png b/doc/user/project/integrations/img/heatmap_panel_type.png Binary files differnew file mode 100644 index 00000000000..a2b3911ec68 --- /dev/null +++ b/doc/user/project/integrations/img/heatmap_panel_type.png diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 841f558d25c..9c5b53f8d47 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -286,6 +286,35 @@ Note the following properties: ![single stat panel type](img/prometheus_dashboard_single_stat_panel_type.png) +##### Heatmaps + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/30581) in GitLab 12.5. + +To add a heatmap panel type to a dashboard, look at the following sample dashboard file: + +```yaml +dashboard: 'Dashboard Title' +panel_groups: + - group: 'Group Title' + panels: + - title: "Heatmap" + type: "heatmap" + metrics: + - id: 10 + query: 'sum(rate(nginx_upstream_responses_total{upstream=~"%{kube_namespace}-%{ci_environment_slug}-.*"}[60m])) by (status_code)' + unit: req/sec + label: "Status code" +``` + +Note the following properties: + +| Property | Type | Required | Description | +| ------ | ------ | ------ | ------ | +| type | string | yes | Type of panel to be rendered. For heatmap panel types, set to `heatmap` | +| query_range | yes | yes | For area panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) | + +![heatmap panel type](img/heatmap_panel_type.png) + ### Downloading data as CSV Data from Prometheus charts on the metrics dashboard can be downloaded as CSV. |