Commit 6700aca2 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'docs-aqualls-more-monitor-images' into 'master'

Move the rest of Monitor's images

See merge request gitlab-org/gitlab!37751
parents 6ab78ba7 42cb2434
...@@ -34,7 +34,7 @@ To create a new dashboard from the GitLab user interface: ...@@ -34,7 +34,7 @@ To create a new dashboard from the GitLab user interface:
1. Navigate to your dashboard at **{cloud-gear}** **Operations > Metrics**. 1. Navigate to your dashboard at **{cloud-gear}** **Operations > Metrics**.
1. In the top-right corner of your dashboard, click the **{file-addition-solid}** **Actions** menu, 1. In the top-right corner of your dashboard, click the **{file-addition-solid}** **Actions** menu,
and select **Create new**: and select **Create new**:
![Monitoring Dashboard actions menu with create new item](../../../user/project/integrations/img/actions_menu_create_new_dashboard_v13_2.png) ![Monitoring Dashboard actions menu with create new item](img/actions_menu_create_new_dashboard_v13_2.png)
1. In the modal window, click **Open Repository**, then follow the instructions 1. In the modal window, click **Open Repository**, then follow the instructions
for creating a new dashboard from the command line. for creating a new dashboard from the command line.
...@@ -106,7 +106,7 @@ To manage the settings for your metrics dashboard: ...@@ -106,7 +106,7 @@ To manage the settings for your metrics dashboard:
1. Navigate to your dashboard at **{cloud-gear}** **Operations > Metrics**. 1. Navigate to your dashboard at **{cloud-gear}** **Operations > Metrics**.
1. In the top-right corner of your dashboard, click **{settings}** **Metrics Settings**: 1. In the top-right corner of your dashboard, click **{settings}** **Metrics Settings**:
![Monitoring Dashboard actions menu with create new item](../../../user/project/integrations/img/metrics_settings_button_v13_2.png) ![Monitoring Dashboard actions menu with create new item](img/metrics_settings_button_v13_2.png)
## Chart Context Menu ## Chart Context Menu
...@@ -114,7 +114,7 @@ You can take action related to a chart's data by clicking the ...@@ -114,7 +114,7 @@ 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 **{ellipsis_v}** **More actions** dropdown box above the upper right corner of
any chart on a dashboard: any chart on a dashboard:
![Context Menu](../../../user/project/integrations/img/panel_context_menu_v13_0.png) ![Context Menu](img/panel_context_menu_v13_0.png)
The options are: The options are:
...@@ -152,7 +152,7 @@ its description. ...@@ -152,7 +152,7 @@ its description.
You can create annotations by making requests to the You can create annotations by making requests to the
[Metrics dashboard annotations API](../../../api/metrics_dashboard_annotations.md) [Metrics dashboard annotations API](../../../api/metrics_dashboard_annotations.md)
![Annotations UI](../../../user/project/integrations/img/metrics_dashboard_annotations_ui_v13.0.png) ![Annotations UI](img/metrics_dashboard_annotations_ui_v13.0.png)
### Annotation retention policy ### Annotation retention policy
...@@ -188,7 +188,7 @@ The dashboard's time range is appended to the `url` as URL parameters. ...@@ -188,7 +188,7 @@ 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`) The following example shows two related links (`GitLab.com` and `GitLab Documentation`)
added to a dashboard: added to a dashboard:
![Links UI](../../../user/project/integrations/img/related_links_v13_1.png) ![Links UI](img/related_links_v13_1.png)
### Links Syntax ### Links Syntax
......
...@@ -37,7 +37,7 @@ Note the following properties: ...@@ -37,7 +37,7 @@ Note the following properties:
| type | string | no | Type of panel to be rendered. Optional for area panel types | | type | string | no | Type of panel to be rendered. Optional for area panel types |
| query_range | string | required | For area panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) | | query_range | string | required | For area panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) |
![area panel chart](../../../user/project/integrations/img/prometheus_dashboard_area_panel_type_v12_8.png) ![area panel chart](img/prometheus_dashboard_area_panel_type_v12_8.png)
Starting in [version 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696), the y-axis values will automatically scale according to the data. Previously, it always started from 0. Starting in [version 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696), the y-axis values will automatically scale according to the data. Previously, it always started from 0.
...@@ -81,7 +81,7 @@ Note the following properties: ...@@ -81,7 +81,7 @@ Note the following properties:
| type | string | required | Must be `anomaly-chart` for anomaly panel types | | type | string | required | Must be `anomaly-chart` for anomaly panel types |
| query_range | yes | required | For anomaly panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) in every metric. | | query_range | yes | required | For anomaly panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) in every metric. |
![anomaly panel type](../../../user/project/integrations/img/prometheus_dashboard_anomaly_panel_type.png) ![anomaly panel type](img/prometheus_dashboard_anomaly_panel_type.png)
## Bar chart ## Bar chart
...@@ -110,7 +110,7 @@ Note the following properties: ...@@ -110,7 +110,7 @@ Note the following properties:
| `type` | string | yes | Type of panel to be rendered. For bar chart types, set to `bar` | | `type` | string | yes | Type of panel to be rendered. For bar chart types, set to `bar` |
| `query_range` | yes | yes | For bar chart, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) | `query_range` | yes | yes | For bar chart, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries)
![bar chart panel type](../../../user/project/integrations/img/prometheus_dashboard_bar_chart_panel_type_v12.10.png) ![bar chart panel type](img/prometheus_dashboard_bar_chart_panel_type_v12.10.png)
## Column chart ## Column chart
...@@ -137,7 +137,7 @@ Note the following properties: ...@@ -137,7 +137,7 @@ Note the following properties:
| type | string | yes | Type of panel to be rendered. For column panel types, set to `column` | | 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) | | 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](../../../user/project/integrations/img/prometheus_dashboard_column_panel_type.png) ![anomaly panel type](img/prometheus_dashboard_column_panel_type.png)
## Stacked column ## Stacked column
...@@ -169,7 +169,7 @@ panel_groups: ...@@ -169,7 +169,7 @@ panel_groups:
series_name: 'group 2' series_name: 'group 2'
``` ```
![stacked column panel type](../../../user/project/integrations/img/prometheus_dashboard_stacked_column_panel_type_v12_8.png) ![stacked column panel type](img/prometheus_dashboard_stacked_column_panel_type_v12_8.png)
| Property | Type | Required | Description | | Property | Type | Required | Description |
| ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ |
...@@ -202,7 +202,7 @@ Note the following properties: ...@@ -202,7 +202,7 @@ Note the following properties:
| field | string | no | Panels display the value of a metric. For a panel to display the value of a label instead, put the name of the label in this key. | | field | string | no | Panels display the value of a metric. For a panel to display the value of a label instead, put the name of the label in this key. |
| query | string | yes | For single stat panel types, you must use an [instant query](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries) | | query | string | yes | For single stat panel types, you must use an [instant query](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries) |
![single stat panel type](../../../user/project/integrations/img/prometheus_dashboard_single_stat_panel_type.png) ![single stat panel type](img/prometheus_dashboard_single_stat_panel_type.png)
## Percentile based results ## Percentile based results
...@@ -254,9 +254,9 @@ Note the following properties: ...@@ -254,9 +254,9 @@ Note the following properties:
| type | string | yes | Type of panel to be rendered. For heatmap panel types, set to `heatmap` | | 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) | | 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](../../../user/project/integrations/img/heatmap_panel_type.png) ![heatmap panel type](img/heatmap_panel_type.png)
CAUTION: **Warning:** CAUTION: **Warning:**
When a query returns too many data points, the heatmap data bucket dimensions tend downwards to 0, making the chart's data invisible, as shown in the image below. To fix this problem, limit the amount of data returned by changing the time range filter on the metrics dashboard UI, or adding the **step** property to your dashboard's YAML file. When a query returns too many data points, the heatmap data bucket dimensions tend downwards to 0, making the chart's data invisible, as shown in the image below. To fix this problem, limit the amount of data returned by changing the time range filter on the metrics dashboard UI, or adding the **step** property to your dashboard's YAML file.
![heatmap chart_too_much_data](../../../user/project/integrations/img/heatmap_chart_too_much_data_v_13_2.png) ![heatmap chart_too_much_data](img/heatmap_chart_too_much_data_v_13_2.png)
...@@ -26,7 +26,7 @@ time zone: ...@@ -26,7 +26,7 @@ time zone:
1. In the **Dashboard timezone** select box, select *User's local timezone* 1. In the **Dashboard timezone** select box, select *User's local timezone*
or *UTC*: or *UTC*:
![Dashboard timezone setting](../../../user/project/operations/img/dashboard_local_timezone_v13_1.png) ![Dashboard timezone setting](img/dashboard_local_timezone_v13_1.png)
1. Click **Save changes**. 1. Click **Save changes**.
## Link to an external dashboard ## Link to an external dashboard
...@@ -41,7 +41,7 @@ existing external dashboards: ...@@ -41,7 +41,7 @@ existing external dashboards:
**Metrics Dashboard**. **Metrics Dashboard**.
1. In **External dashboard URL**, provide the URL to your external dashboard: 1. In **External dashboard URL**, provide the URL to your external dashboard:
![External Dashboard Setting](../../../user/project/operations/img/dashboard_external_link_v13_1.png) ![External Dashboard Setting](img/dashboard_external_link_v13_1.png)
1. Click **Save changes**. 1. Click **Save changes**.
...@@ -49,4 +49,4 @@ GitLab displays a **View full dashboard** button in the top right corner of your ...@@ -49,4 +49,4 @@ GitLab displays a **View full dashboard** button in the top right corner of your
[monitoring dashboard](../../../ci/environments/index.md#monitoring-environments) [monitoring dashboard](../../../ci/environments/index.md#monitoring-environments)
which opens the URL you provided: which opens the URL you provided:
![External Dashboard Link](../../../user/project/operations/img/external_dashboard_link.png) ![External Dashboard Link](img/external_dashboard_link.png)
...@@ -99,7 +99,7 @@ metrics: ...@@ -99,7 +99,7 @@ metrics:
This may render a legend like this: This may render a legend like this:
![repeated legend label chart](../../../user/project/integrations/img/prometheus_dashboard_repeated_label.png) ![repeated legend label chart](img/prometheus_dashboard_repeated_label.png)
For labels to be more explicit, using variables that reflect time series labels is a good practice. The variables will be replaced by the values of the time series labels when the legend is rendered: For labels to be more explicit, using variables that reflect time series labels is a good practice. The variables will be replaced by the values of the time series labels when the legend is rendered:
...@@ -113,7 +113,7 @@ metrics: ...@@ -113,7 +113,7 @@ metrics:
The resulting rendered legend will look like this: The resulting rendered legend will look like this:
![legend with label variables](../../../user/project/integrations/img/prometheus_dashboard_label_variables.png) ![legend with label variables](img/prometheus_dashboard_label_variables.png)
There is also a shorthand value for dynamic dashboard labels that make use of only one time series label: There is also a shorthand value for dynamic dashboard labels that make use of only one time series label:
...@@ -127,7 +127,7 @@ metrics: ...@@ -127,7 +127,7 @@ metrics:
This works by lowercasing the value of `label` and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value will be used and rendered in the legend like this: This works by lowercasing the value of `label` and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value will be used and rendered in the legend like this:
![legend with label shorthand variable](../../../user/project/integrations/img/prometheus_dashboard_label_variable_shorthand.png) ![legend with label shorthand variable](img/prometheus_dashboard_label_variable_shorthand.png)
## Dashboard YAML syntax validation ## Dashboard YAML syntax validation
...@@ -142,19 +142,19 @@ To confirm your dashboard definition contains valid YAML syntax: ...@@ -142,19 +142,19 @@ To confirm your dashboard definition contains valid YAML syntax:
Files with valid syntax display **Metrics Dashboard YAML definition is valid**, Files with valid syntax display **Metrics Dashboard YAML definition is valid**,
and files with invalid syntax display **Metrics Dashboard YAML definition is invalid**. and files with invalid syntax display **Metrics Dashboard YAML definition is invalid**.
![Metrics Dashboard_YAML_syntax_validation](../../../user/project/integrations/img/prometheus_dashboard_yaml_validation_v13_1.png) ![Metrics Dashboard_YAML_syntax_validation](img/prometheus_dashboard_yaml_validation_v13_1.png)
When **Metrics Dashboard YAML definition is invalid** at least one of the following messages is displayed: When **Metrics Dashboard YAML definition is invalid** at least one of the following messages is displayed:
1. `dashboard: can't be blank` [learn more](../../../operations/metrics/dashboards/yaml.md#dashboard-top-level-properties) 1. `dashboard: can't be blank` [learn more](#dashboard-top-level-properties)
1. `panel_groups: should be an array of panel_groups objects` [learn more](../../../operations/metrics/dashboards/yaml.md#dashboard-top-level-properties) 1. `panel_groups: should be an array of panel_groups objects` [learn more](#dashboard-top-level-properties)
1. `group: can't be blank` [learn more](../../../operations/metrics/dashboards/yaml.md#panel-group-panel_groups-properties) 1. `group: can't be blank` [learn more](#panel-group-panel_groups-properties)
1. `panels: should be an array of panels objects` [learn more](../../../operations/metrics/dashboards/yaml.md#panel-group-panel_groups-properties) 1. `panels: should be an array of panels objects` [learn more](#panel-group-panel_groups-properties)
1. `title: can't be blank` [learn more](../../../operations/metrics/dashboards/yaml.md#panel-panels-properties) 1. `title: can't be blank` [learn more](#panel-panels-properties)
1. `metrics: should be an array of metrics objects` [learn more](../../../operations/metrics/dashboards/yaml.md#panel-panels-properties) 1. `metrics: should be an array of metrics objects` [learn more](#panel-panels-properties)
1. `query: can't be blank` [learn more](../../../operations/metrics/dashboards/yaml.md#metrics-metrics-properties) 1. `query: can't be blank` [learn more](#metrics-metrics-properties)
1. `query_range: can't be blank` [learn more](../../../operations/metrics/dashboards/yaml.md#metrics-metrics-properties) 1. `query_range: can't be blank` [learn more](#metrics-metrics-properties)
1. `unit: can't be blank` [learn more](../../../operations/metrics/dashboards/yaml.md#metrics-metrics-properties) 1. `unit: can't be blank` [learn more](#metrics-metrics-properties)
1. `YAML syntax: The parsed YAML is too big` 1. `YAML syntax: The parsed YAML is too big`
This is displayed when the YAML file is larger than 1 MB. This is displayed when the YAML file is larger than 1 MB.
......
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