Commit f6ec55c3 authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-aqualls-move-images' into 'master'

Move Monitor + metrics images to new folder

See merge request gitlab-org/gitlab!37743
parents f18a62ef b06a7fa3
...@@ -26,7 +26,7 @@ For managed Prometheus instances using auto configuration, you can ...@@ -26,7 +26,7 @@ For managed Prometheus instances using auto configuration, you can
1. Set threshold and operator. 1. Set threshold and operator.
1. Click **Add** to save and activate the alert. 1. Click **Add** to save and activate the alert.
![Adding an alert](../../user/project/integrations/img/prometheus_alert.png) ![Adding an alert](img/prometheus_alert.png)
To remove the alert, click back on the alert icon for the desired metric, and click **Delete**. To remove the alert, click back on the alert icon for the desired metric, and click **Delete**.
...@@ -41,7 +41,7 @@ use with Prometheus webhooks. If you have manual configuration enabled, an ...@@ -41,7 +41,7 @@ use with Prometheus webhooks. If you have manual configuration enabled, an
This section contains the **URL** and **Authorization Key** you will need. The This section contains the **URL** and **Authorization Key** you will need. The
**Reset Key** button will invalidate the key and generate a new one. **Reset Key** button will invalidate the key and generate a new one.
![Prometheus service configuration of Alerts](../../user/project/integrations/img/prometheus_service_alerts.png) ![Prometheus service configuration of Alerts](img/prometheus_service_alerts.png)
To send GitLab alert notifications, copy the **URL** and **Authorization Key** into the To send GitLab alert notifications, copy the **URL** and **Authorization Key** into the
[`webhook_configs`](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config) [`webhook_configs`](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)
......
...@@ -24,17 +24,17 @@ To display metric charts, include a link of the form ...@@ -24,17 +24,17 @@ To display metric charts, include a link of the form
`https://<root_url>/<project>/-/environments/<environment_id>/metrics` in a field `https://<root_url>/<project>/-/environments/<environment_id>/metrics` in a field
that supports GitLab-flavored Markdown: that supports GitLab-flavored Markdown:
![Embedded Metrics Markdown](../../user/project/integrations/img/embedded_metrics_markdown_v12_8.png) ![Embedded Metrics Markdown](img/embedded_metrics_markdown_v12_8.png)
GitLab unfurls the link as an embedded metrics panel: GitLab unfurls the link as an embedded metrics panel:
![Embedded Metrics Rendered](../../user/project/integrations/img/embedded_metrics_rendered_v12_8.png) ![Embedded Metrics Rendered](img/embedded_metrics_rendered_v12_8.png)
You can also embed a single chart. To get a link to a chart, click the You can also embed a single chart. To get a link to a chart, click the
**{ellipsis_v}** **More actions** menu in the upper right corner of the chart, **{ellipsis_v}** **More actions** menu in the upper right corner of the chart,
and select **Copy link to chart**, as shown in this example: and select **Copy link to chart**, as shown in this example:
![Copy Link To Chart](../../user/project/integrations/img/copy_link_to_chart_v12_10.png) ![Copy Link To Chart](img/copy_link_to_chart_v12_10.png)
The following requirements must be met for the metric to unfurl: The following requirements must be met for the metric to unfurl:
...@@ -46,11 +46,11 @@ The following requirements must be met for the metric to unfurl: ...@@ -46,11 +46,11 @@ The following requirements must be met for the metric to unfurl:
If all of the above are true, then the metric unfurls as seen below: If all of the above are true, then the metric unfurls as seen below:
![Embedded Metrics](../../user/project/integrations/img/view_embedded_metrics_v12_10.png) ![Embedded Metrics](img/view_embedded_metrics_v12_10.png)
Metric charts may also be hidden: Metric charts may also be hidden:
![Show Hide](../../user/project/integrations/img/hide_embedded_metrics_v12_10.png) ![Show Hide](img/hide_embedded_metrics_v12_10.png)
You can open the link directly into your browser for a You can open the link directly into your browser for a
[detailed view of the data](dashboards/index.md#chart-context-menu). [detailed view of the data](dashboards/index.md#chart-context-menu).
...@@ -61,7 +61,7 @@ You can also embed either the default dashboard metrics or individual metrics in ...@@ -61,7 +61,7 @@ You can also embed either the default dashboard metrics or individual metrics in
issue templates. For charts to render side-by-side, separate links to the entire metrics issue templates. For charts to render side-by-side, separate links to the entire metrics
dashboard or individual metrics by either a comma or a space. dashboard or individual metrics by either a comma or a space.
![Embedded Metrics in issue templates](../../user/project/integrations/img/embed_metrics_issue_template.png) ![Embedded Metrics in issue templates](img/embed_metrics_issue_template.png)
## Embedding metrics based on alerts in incident issues ## Embedding metrics based on alerts in incident issues
...@@ -106,4 +106,4 @@ The following requirements must be met for the metric to unfurl: ...@@ -106,4 +106,4 @@ The following requirements must be met for the metric to unfurl:
If the above requirements are met, then the metric unfurls as seen below. If the above requirements are met, then the metric unfurls as seen below.
![Embedded Cluster Metric in issue descriptions](../../user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png) ![Embedded Cluster Metric in issue descriptions](img/prometheus_cluster_health_embed_v12_9.png)
...@@ -15,7 +15,7 @@ charts in issues as a ...@@ -15,7 +15,7 @@ charts in issues as a
[direct linked rendered image](https://grafana.com/docs/grafana/latest/reference/share_panel/#direct-link-rendered-image). [direct linked rendered image](https://grafana.com/docs/grafana/latest/reference/share_panel/#direct-link-rendered-image).
The **Direct link rendered image** sharing dialog within Grafana provides the link: The **Direct link rendered image** sharing dialog within Grafana provides the link:
![Grafana Direct Linked Rendered Image](../../user/project/integrations/img/grafana_live_embed.png) ![Grafana Direct Linked Rendered Image](img/grafana_live_embed.png)
NOTE: **Note:** NOTE: **Note:**
For this embed to display correctly, the Grafana instance must be available to the For this embed to display correctly, the Grafana instance must be available to the
...@@ -32,7 +32,7 @@ markup for a live chart from GitLab's public dashboard: ...@@ -32,7 +32,7 @@ markup for a live chart from GitLab's public dashboard:
This markup renders a graph of `5xx` errors, like this: This markup renders a graph of `5xx` errors, like this:
![Grafana dashboard embedded preview](../../user/project/integrations/img/grafana_embedded.png) ![Grafana dashboard embedded preview](img/grafana_embedded.png)
## Embedding charts via integration with Grafana HTTP API ## Embedding charts via integration with Grafana HTTP API
...@@ -46,7 +46,7 @@ from a Grafana instance, the data source must: ...@@ -46,7 +46,7 @@ from a Grafana instance, the data source must:
1. Be a Prometheus instance. 1. Be a Prometheus instance.
1. Be proxyable, so the HTTP Access setting should be set to `Server`: 1. Be proxyable, so the HTTP Access setting should be set to `Server`:
![HTTP Proxy Access](../../user/project/integrations/img/http_proxy_access_v12_5.png) ![HTTP Proxy Access](img/http_proxy_access_v12_5.png)
## Setting up the Grafana integration ## Setting up the Grafana integration
...@@ -60,10 +60,10 @@ from a Grafana instance, the data source must: ...@@ -60,10 +60,10 @@ from a Grafana instance, the data source must:
## Generating a link to a chart ## Generating a link to a chart
1. In Grafana, navigate to the dashboard you wish to embed a panel from. 1. In Grafana, navigate to the dashboard you wish to embed a panel from.
![Grafana Metric Panel](../../user/project/integrations/img/grafana_panel_v12_5.png) ![Grafana Metric Panel](img/grafana_panel_v12_5.png)
1. In the upper-left corner of the page, select a specific value for each variable 1. In the upper-left corner of the page, select a specific value for each variable
required for the queries in the chart. required for the queries in the chart.
![Select Query Variables](../../user/project/integrations/img/select_query_variables_v12_5.png) ![Select Query Variables](img/select_query_variables_v12_5.png)
1. In Grafana, click on a panel's title, then click **Share** to open the panel's 1. In Grafana, click on a panel's title, then click **Share** to open the panel's
sharing dialog to the **Link** tab. If you click the _dashboard's_ share panel sharing dialog to the **Link** tab. If you click the _dashboard's_ share panel
instead, GitLab attempts to embed the first supported panel on the dashboard (if available). instead, GitLab attempts to embed the first supported panel on the dashboard (if available).
...@@ -72,8 +72,8 @@ from a Grafana instance, the data source must: ...@@ -72,8 +72,8 @@ from a Grafana instance, the data source must:
variables, only `$__interval`, `$__from`, and `$__to` are supported. variables, only `$__interval`, `$__from`, and `$__to` are supported.
1. Toggle **On** the **Current time range** option to specify the time range of 1. Toggle **On** the **Current time range** option to specify the time range of
the chart. Otherwise, the default range is the last 8 hours. the chart. Otherwise, the default range is the last 8 hours.
![Grafana Sharing Dialog](../../user/project/integrations/img/grafana_sharing_dialog_v12_5.png) ![Grafana Sharing Dialog](img/grafana_sharing_dialog_v12_5.png)
1. Click **Copy** to copy the URL to the clipboard. 1. Click **Copy** to copy the URL to the clipboard.
1. In GitLab, paste the URL into a Markdown field and save. The chart takes a few 1. In GitLab, paste the URL into a Markdown field and save. The chart takes a few
moments to render. moments to render.
![GitLab Rendered Grafana Panel](../../user/project/integrations/img/rendered_grafana_embed_v12_5.png) ![GitLab Rendered Grafana Panel](img/rendered_grafana_embed_v12_5.png)
...@@ -70,7 +70,7 @@ helps quickly create a deployment: ...@@ -70,7 +70,7 @@ helps quickly create a deployment:
1. When the pipeline has run successfully, graphs are available on the 1. When the pipeline has run successfully, graphs are available on the
**{cloud-gear}** **Operations > Metrics** page. **{cloud-gear}** **Operations > Metrics** page.
![Monitoring Dashboard](../../user/project/integrations/img/prometheus_monitoring_dashboard_v13_1.png) ![Monitoring Dashboard](img/prometheus_monitoring_dashboard_v13_1.png)
## Customize your metrics dashboard ## Customize your metrics dashboard
...@@ -104,7 +104,7 @@ After saving them, they display on the environment metrics dashboard provided th ...@@ -104,7 +104,7 @@ After saving them, they display on the environment metrics dashboard provided th
[Prometheus installed on the cluster](../../user/project/integrations/prometheus.md#enabling-prometheus-integration). [Prometheus installed on the cluster](../../user/project/integrations/prometheus.md#enabling-prometheus-integration).
- Prometheus is [manually configured](../../user/project/integrations/prometheus.md#manual-configuration-of-prometheus). - Prometheus is [manually configured](../../user/project/integrations/prometheus.md#manual-configuration-of-prometheus).
![Add New Metric](../../user/project/integrations/img/prometheus_add_metric.png) ![Add New Metric](img/prometheus_add_metric.png)
A few fields are required: A few fields are required:
...@@ -127,7 +127,7 @@ suggested if this feature is used. ...@@ -127,7 +127,7 @@ suggested if this feature is used.
You can edit existing additional custom metrics for your dashboard by clicking the You can edit existing additional custom metrics for your dashboard by clicking the
**{ellipsis_v}** **More actions** dropdown and selecting **Edit metric**. **{ellipsis_v}** **More actions** dropdown and selecting **Edit metric**.
![Edit metric](../../user/project/integrations/img/prometheus_dashboard_edit_metric_link_v_12_9.png) ![Edit metric](img/prometheus_dashboard_edit_metric_link_v_12_9.png)
## Keyboard shortcuts for charts ## Keyboard shortcuts for charts
......
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