Commit 77299e52 authored by Nick Gaskill's avatar Nick Gaskill

Merge branch 'fix/doc-operations-metrics-dashboards' into 'master'

Edits for docs consistency in Metrics Dashboards

See merge request gitlab-org/gitlab!71596
parents e9bb479e 0b5ff0e5
......@@ -62,12 +62,10 @@ panel_groups:
query_range: 'http_requests_total'
label: '# of Requests'
unit: 'count'
metrics:
- id: anomaly_requests_upper_limit
query_range: 10000
label: 'Max # of requests'
unit: 'count'
metrics:
- id: anomaly_requests_lower_limit
query_range: 2000
label: 'Min # of requests'
......
......@@ -8,7 +8,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w
## Query variables
Variables can be specified using double curly braces, such as `"{{ci_environment_slug}}"` ([added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20793) in GitLab 12.7).
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20793) in GitLab 12.7.
Variables can be specified using double curly braces, such as `"{{ci_environment_slug}}"`.
Support for the `"%{ci_environment_slug}"` format was
[removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31581) in GitLab 13.0.
......@@ -66,5 +68,5 @@ avg(sum(container_memory_usage_bytes{container_name!="{{pod}}"}) by (job)) witho
The URL for this query would be:
```plaintext
http://gitlab.com/<user>/<project>/-/environments/<environment_id>/metrics?dashboard=.gitlab%2Fdashboards%2Fcustom.yml&pod=POD
https://gitlab.com/<user>/<project>/-/environments/<environment_id>/metrics?dashboard=.gitlab%2Fdashboards%2Fcustom.yml&pod=POD
```
......@@ -14,7 +14,7 @@ Dashboards have several components:
The following tables outline the details of expected properties.
## **Dashboard (top-level) properties**
## Dashboard (top-level) properties
| Property | Type | Required | Description |
| ------ | ------ | ------ | ------ |
......@@ -23,7 +23,7 @@ The following tables outline the details of expected properties.
| `templating` | hash | no | Top level key under which templating related options can be added. |
| `links` | array | no | Add links to display on the dashboard. |
## **Templating (`templating`) properties**
## Templating (`templating`) properties
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
......@@ -31,7 +31,7 @@ The following tables outline the details of expected properties.
Read the documentation on [templating](templating_variables.md).
## **Links (`links`) properties**
## Links (`links`) properties
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
......@@ -41,7 +41,7 @@ Read the documentation on [templating](templating_variables.md).
Read the documentation on [links](index.md#add-related-links-to-custom-dashboards).
## **Panel group (`panel_groups`) properties**
## Panel group (`panel_groups`) properties
Dashboards display panel groups in the order they are listed in the dashboard YAML file.
......@@ -55,7 +55,7 @@ is no longer used.
Panels in a panel group are laid out in rows consisting of two panels per row. An exception to this rule are single panels on a row: these panels take the full width of their containing row.
## **Panel (`panels`) properties**
## Panel (`panels`) properties
Dashboards display panels in the order they are listed in the dashboard YAML file.
......@@ -72,7 +72,7 @@ is no longer used.
| `metrics` | array | yes | The metrics which should be displayed in the panel. Any number of metrics can be displayed when `type` is `area-chart` or `line-chart`, whereas only 3 can be displayed when `type` is `anomaly-chart`. |
| `links` | array | no | Add links to display on the chart's [context menu](index.md#chart-context-menu). |
## **Axis (`panels[].y_axis`) properties**
## Axis (`panels[].y_axis`) properties
| Property | Type | Required | Description |
| ----------- | ------ | ----------------------------- | -------------------------------------------------------------------- |
......@@ -80,7 +80,7 @@ is no longer used.
| `format` | string | no, defaults to `engineering` | Unit format used. See the [full list of units](yaml_number_format.md). |
| `precision` | number | no, defaults to `2` | Number of decimal places to display in the number. | |
## **Metrics (`metrics`) properties**
## Metrics (`metrics`) properties
| Property | Type | Required | Description |
| ------ | ------ | ------ | ------ |
......
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