Drone CI Grafana 数据源
注意
Drone 企业版数据源目前处于 公开预览 状态。Grafana Labs 提供有限支持,并且在功能正式发布之前可能会出现重大更改。
Drone 数据源插件允许您从 Drone 实例检索存储库和构建数据。
要求
此插件具有以下要求
- 工作的 Drone 实例
- 任何免费或付费的 Grafana Cloud 计划或已 激活的本地 Grafana 企业版许可证。签约的 Cloud 客户应参考其协议。
安装数据源
要安装数据源,请参阅 安装。
在 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 数据源。 - 转到**仪表板**选项卡以查看预制仪表板列表。
已知限制
Build List
操作目前仅返回最新的 100 个构建,而不是所有构建。- 目前,插件不支持警报。
了解更多
- 添加 转换。