diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2019-08-30 11:52:01 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-08-30 11:52:01 +0000 |
| commit | 3ca9a6bd28aa22e06d82e965b24ba78d412c2444 (patch) | |
| tree | 03921e849f37d427f0d44638851073e9618a8969 | |
| parent | fb4de18dc1076067eb5613fbc48041e530045e7d (diff) | |
| parent | cc518f4f938503811682fbb82fc95cd0980d8d78 (diff) | |
| download | gitlab-ce-3ca9a6bd28aa22e06d82e965b24ba78d412c2444.tar.gz | |
Merge branch 'tr-embed-grafana-image-docs' into 'master'
Documentation for embedding Grafana live charts as images
Closes #66662
See merge request gitlab-org/gitlab-ce!32342
| -rw-r--r-- | doc/user/project/integrations/img/grafana_live_embed.png | bin | 0 -> 44603 bytes | |||
| -rw-r--r-- | doc/user/project/integrations/prometheus.md | 21 |
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/user/project/integrations/img/grafana_live_embed.png b/doc/user/project/integrations/img/grafana_live_embed.png Binary files differnew file mode 100644 index 00000000000..91970cd379a --- /dev/null +++ b/doc/user/project/integrations/img/grafana_live_embed.png diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index d13592559b9..3583c0554ee 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -393,6 +393,27 @@ The following requirements must be met for the metric to unfurl:  +### Embedding live Grafana charts + +It is also possible to embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.html) charts within issues, as a [Direct Linked Rendered Image](https://grafana.com/docs/reference/sharing/#direct-link-rendered-image). + +The sharing dialog within Grafana provides the link, as highlighted below. + + + +NOTE: **Note:** +For this embed to display correctly the Grafana instance must be available to the target user, either as a public dashboard or on the same network. + +Copy the link and add an image tag as [inline HTML](../../markdown.md#inline-html) in your markdown. You may tweak the query parameters as required. For instance, removing the `&from=` and `&to=` parameters will give you a live chart. Here is example markup for a live chart from GitLab's public dashboard: + +```html +<img src="https://dashboards.gitlab.com/render/d-solo/RZmbBr7mk/gitlab-triage?orgId=1&refresh=30s&var-env=gprd&var-environment=gprd&var-prometheus=prometheus-01-inf-gprd&var-prometheus_app=prometheus-app-01-inf-gprd&var-backend=All&var-type=All&var-stage=main&panelId=1247&width=1000&height=300"/> +``` + +This will render like so: + +<img src="https://dashboards.gitlab.com/render/d-solo/RZmbBr7mk/gitlab-triage?orgId=1&refresh=30s&var-env=gprd&var-environment=gprd&var-prometheus=prometheus-01-inf-gprd&var-prometheus_app=prometheus-app-01-inf-gprd&var-backend=All&var-type=All&var-stage=main&panelId=1247&width=1000&height=300"/> + ## Troubleshooting If the "No data found" screen continues to appear, it could be due to: |
