Drone CI Grafana 数据源
注意
Drone 企业数据源适用于 Grafana 目前处于 公开预览 阶段。Grafana Labs 提供有限支持,在功能广泛可用之前,可能发生破坏性变更。
Drone 数据源插件允许您从您的 Drone 实例检索存储库和构建的数据。
要求
此插件有以下要求
- 有效的 Drone 实例
- 任何免费或付费的 Grafana Cloud 计划或已激活的 本地部署的 Grafana 企业版许可证。合同云客户应参考其协议。
安装数据源
要安装数据源,请参阅安装指南。
在 Grafana 中配置数据源
通过填写以下信息添加数据源
连接
URL
这是您的 Drone 实例 URL。您应包含协议(例如 https://
)并删除末尾的 /
。下面有一些示例。
URL | 正确吗? |
---|---|
https://drone.company.com | ✅ 正确 |
https://company.com/drone | ✅ 正确 |
drone.company.com | ❌ 错误 - 缺少 https:// |
https://drone.company.com/ | ❌ 错误 - 有尾随的 / |
身份验证
API令牌
插件支持API令牌身份验证。您可以在Drone实例的<YOUR_DRONE_URL>/account
页面找到您的API令牌。
使用配置文件配置数据源
您可以使用Grafana的配置文件系统使用配置文件来配置数据源。要了解其工作原理,请参阅配置Grafana数据源。
以下是一个使用API令牌身份验证的配置示例
apiVersion: 1
datasources:
- name: Drone
type: grafana-drone-datasource
jsonData:
variables:
url: <YOUR_DRONE_URL>
secureJsonData:
drone.token: <YOUR_API_TOKEN>
查询数据源
插件允许查询仓库和构建数据。
获取仓库列表
获取仓库数据不需要任何参数。插件只返回Drone中活跃的仓库并过滤掉不活跃的仓库。
获取特定仓库的数据
当选择 Repo Info
动作时,您还需要从下拉列表中选择必填的仓库参数,下拉列表仅包括活跃的仓库。
获取构建列表
Build List
动作返回指定仓库最近构建的数据,您需要从下拉列表中选择。下拉列表仅包含活跃的仓库。
获取特定构建数据
此操作类似于构建列表操作,但只返回单个构建的数据。您将需要从下拉列表中提供必填的Repository
和Build number
参数。Build number
参数将在您选择了仓库后出现。
注意
Build number
下拉列表最多包含100个最近的构建,但您仍然可以输入列表中没有的构建编号,插件将返回该构建的数据。
模板和变量
要添加新的Drone数据源查询变量,请参阅添加查询变量。将您的Drone数据源用作数据源并在查询构建器中填写字段。
创建变量后,您可以使用变量语法在Drone查询中使用它。有关变量的更多信息,请参阅模板和变量。
示例:
您可以使用一个变量包含所有仓库,创建变量时使用 slug
字段作为变量值,使用 name
作为变量标签。然后您可以在需要仓库参数的Drone数据源查询中使用创建的变量(例如,获取特定仓库的数据或获取特定仓库的构建)。
注释
您可以使用注释在仪表板上可视化Drone数据(例如构建)与其他数据之间的关系。有关如何使用注释的通用信息,请参阅文档。
内置仪表板
插件具有一个内置仪表板,其中包含仓库变量并可视化选定仓库的一些统计数据。它仅用于展示插件的功能。您可以自由导入仪表板并根据需要更改它。
要查看预制的Drone仪表板列表,请执行以下操作
- 转到侧边栏菜单中的 连接。
- 在“连接”下,单击 数据源。
- 在搜索栏中键入
Drone
并选择Drone数据源。 - 转到 仪表板 选项卡以查看预制的仪表板列表。
已知限制
构建列表
动作当前仅返回最新100个构建,而不是所有构建。- 目前插件不支持警报。
了解更多
- 添加 转换。