Commit ddd88a64 authored by Dhiraj Bodicherla's avatar Dhiraj Bodicherla Committed by Amy Qualls

Update prometheus docs

This MR adds link type to prometheus docs along
with the time range feature
parent dee867c1
...@@ -397,6 +397,7 @@ Read the documentation on [templating](#templating-variables-for-metrics-dashboa ...@@ -397,6 +397,7 @@ Read the documentation on [templating](#templating-variables-for-metrics-dashboa
| -------- | ---- | -------- | ----------- | | -------- | ---- | -------- | ----------- |
| `url` | string | yes | The address of the link. | | `url` | string | yes | The address of the link. |
| `title` | string | no | Display title for the link. | | `title` | string | no | Display title for the link. |
| `type` | string | no | Type of the link. Specifies the link type, can be: `grafana` |
Read the documentation on [links](#add-related-links-to-custom-dashboards). Read the documentation on [links](#add-related-links-to-custom-dashboards).
...@@ -844,9 +845,14 @@ templating: ...@@ -844,9 +845,14 @@ templating:
Related links can be added to the top of your metrics dashboard, which can be used for quickly Related links can be added to the top of your metrics dashboard, which can be used for quickly
navigating between dashboards or external services. The links will open in the same tab. navigating between dashboards or external services. The links will open in the same tab.
The dashboard's time range is appended to the `url` as URL parameters.
The `url` attribute is required for the link but the `title` attribute is optional; if the `title` The `url` attribute is required for the link but the `title` attribute is optional; if the `title`
is missing then the full address of the URL will be displayed. is missing then the full address of the URL will be displayed.
The `type` attribute is optional; if the `type` is `grafana`, the dashboard's time range values are
converted to Grafana's time range format and appended to the `url`.
![Links UI](img/related_links_v13_1.png) ![Links UI](img/related_links_v13_1.png)
#### Links Syntax #### Links Syntax
...@@ -857,6 +863,9 @@ links: ...@@ -857,6 +863,9 @@ links:
url: https://gitlab.com url: https://gitlab.com
- title: GitLab Documentation - title: GitLab Documentation
url: https://docs.gitlab.com url: https://docs.gitlab.com
- title: Public Grafana playground dashboard
url: https://play.grafana.org/d/000000012/grafana-play-home?orgId=1
type: grafana
``` ```
### View and edit the source file of a custom dashboard ### View and edit the source file of a custom dashboard
......
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