Drone CI Grafana 数据源
注意
Drone 的企业版数据源目前处于 公开预览。Grafana Labs 提供有限支持,且在正式发布前可能会发生重大更改。
Drone 数据源插件允许您从 Drone 实例中检索仓库和构建数据。
要求
此插件有以下要求
- 可工作的 Drone 实例
- 任何免费或付费的 Grafana Cloud 计划,或者 激活的本地 Grafana Enterprise 许可证。合同云客户应参考其协议。
安装数据源
要安装数据源,请参考 安装。
在 Grafana 中配置数据源
添加数据源,填写以下信息
连接
URL
这是您的 Drone 实例 URL。您应该包含协议(例如 https://
)并移除尾部的 /
。您可以参考以下示例。
URL | 是否正确? |
---|---|
https://drone.company.com | ✅ 正确 |
https://company.com/drone | ✅ 正确 |
drone.company.com | ❌ 不正确 - 缺少 https:// |
https://drone.company.com/ | ❌ 不正确 - 包含尾部的 / |
身份验证
API Token
该插件支持 API Token 身份验证。您可以在 Drone 实例的 <YOUR_DRONE_URL>/account
页面找到您的 API Token。
使用 Provisioning 配置数据源
可以使用 Grafana 的 Provisioning 系统通过配置文件配置数据源。要了解其工作原理,请参考 Provisioning Grafana 数据源。
以下是使用 API Token 身份验证配置此数据源的 Provisioning 示例
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 数据源。 - 转到 仪表盘 选项卡以查看预制仪表盘列表。
已知限制
Build List
操作目前仅返回最多 100 个最新构建,而不是所有构建。- 目前,插件不支持告警。
了解更多
- 添加 转换。