Embedding Grafana charts
原文:https://docs.gitlab.com/ee/operations/metrics/embed_grafana.html
- Embedding charts via Grafana Rendered Images
- Embedding charts via integration with Grafana HTTP API
- Setting up the Grafana integration
- Generating a link to a chart
Embedding Grafana charts
Grafana 指标可以嵌入到GitLab 风味 Markdown 中 .
Embedding charts via Grafana Rendered Images
可以在问题中嵌入实时Grafana图表,作为直接链接的渲染图像 .
Grafana 中的共享对话框提供了链接,如下所示.
注意:为了使此嵌入正确显示,Grafana 实例必须可作为公共仪表板或在同一网络上供目标用户使用.
复制链接并在 Markdown 中将图像标签添加为内联 HTML . 您可以根据需要调整查询参数. 例如,删除&from=
和&to=
参数将为您提供实时图表. 这是来自 GitLab 公共仪表板的实时图表的示例标记:
<img src="https://dashboards.gitlab.com/d/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&from=1580444107655&to=1580465707655"/>
这将呈现为:
Embedding charts via integration with Grafana HTTP API
在 GitLab 12.5 中引入 .
每个项目可以支持与一个 Grafana 实例的集成. 此配置允许用户将链接复制到 Grafana 中的面板,然后将其粘贴到 GitLab Markdown 字段中. 该图表将以 GitLab 图表格式呈现.
从 Grafana 实例嵌入的先决条件:
- 数据源必须是 Prometheus 实例.
- 数据源必须是可代理的,因此 HTTP 访问设置应设置为
Server
.
Setting up the Grafana integration
- Generate an Admin-level API Token in Grafana.
- 在您的 GitLab 项目中,导航至设置>操作> Grafana 身份验证 .
- 要启用集成,请选中”活动”复选框.
- 对于” Grafana URL”,输入 Grafana 实例的基本 URL.
- 对于” API 令牌”,输入您刚生成的 Admin API 令牌.
- Click 保存更改.
Generating a link to a chart
- 在 Grafana 中,导航到要嵌入面板的仪表板.
- 在页面的左上角,为图表中查询所需的每个变量选择一个特定值.
- 在 Grafana 中,单击面板的标题,然后单击” 共享”以将面板的共享对话框打开到” 链接”选项卡. 如果您单击仪表板的共享面板,则 GitLab 将尝试在仪表板上嵌入第一个受支持的面板(如果有).
- 如果您的普罗米修斯查询使用 Grafana 的自定义模板变量,确保”模板变量”选项切换为开 . 在 Grafana 全局模板变量中,目前仅支持
$__interval
,$__from
和$__to
. 切换“当前时间范围”选项来指定图表的时间范围. 否则,默认范围将是最近 8 小时. - 单击复制将 URL 复制到剪贴板.
- 在 GitLab 中,将该 URL 粘贴到 Markdown 字段中并保存. 该图表将需要一些时间来呈现.