文档 插件 Grafana 的 Azure DevOps 数据源

Azure DevOps 数据源用于 Grafana

Azure DevOps 数据源插件允许您在 Grafana 中查询和可视化 Azure DevOps 数据。

开始之前

• 确保您拥有 Azure DevOps 帐户和个人访问令牌。
• 确保您拥有以下其中一种帐户类型
  • **Grafana Cloud**：专业版客户、高级版客户或启用了企业版插件附加组件的专业版试用用户
  • **Grafana 企业版**：拥有已激活的许可证的客户，以及拥有 Grafana 服务器或组织管理权限的用户
• 确保已启用企业版插件附加组件。

已知限制

• 模板变量不能是多选；仅支持单选。
• 插件仅提供以下功能集

涵盖的功能

安装 Azure DevOps 数据源插件

要安装数据源，请参阅安装。

从 Azure DevOps 获取个人访问令牌

要获取个人访问令牌，请参阅Azure DevOps 文档 - 个人访问令牌部分。

为您的 API 令牌设置必要的读取权限。这包括workItems.read、code.read、code.status、build.read、release.read、test.read和packaging.read。如果您未使用特定功能，可以跳过特定权限。

在 Grafana 中配置数据源

通过填写以下字段添加数据源

使用配置进行数据源配置

您可以使用 Grafana 的配置系统使用配置文件配置数据源。要详细了解配置的工作原理，包括数据源设置的完整列表，请参阅配置 Grafana。

yaml 复制

apiVersion: 1
datasources:
  - name: Azure Devops
    type: grafana-azuredevops-datasource
    version: 1
    orgId: 1
    uid: azure_devops_001
    basicAuth: false
    editable: false
    isDefault: false
    jsonData:
      url: https://dev.azure.com/xxxxxxxx
      projectsLimit: 100
    secureJsonData:
      patToken: xxxxxxxxxxxxxxxxxxxxxxxxx

查询数据源

查询编辑器允许您从 Azure DevOps 查询不同的数据集。根据查询编辑器中选择的查询类型，您可以从不同的 API 检索数据。

项目

• 查看数据源有权访问的组织中的所有项目列表。
• 底层 API 是项目 - 列表。

仓库

• 检索数据源有权访问的组织中的 Git 仓库列表。
• (可选) 您可以指定项目 ID 以筛选指定项目的仓库。
• 底层 API 为 存储库 - 列表。

拉取请求

• 检索指定项目的拉取请求列表。
• （可选）您可以指定存储库 ID 以筛选特定于该存储库的拉取请求。
• 底层 API 为 按项目获取拉取请求

构建

• 查看指定项目的构建列表。
• 项目 ID 是必填字段。
• 查询响应范围限定为仪表板的时间范围。maxTime 和 minTime 参数会根据仪表板时间范围自动传递到 API。
• 底层 API 为 构建 - 列表

构建定义

• 查看指定项目的构建定义列表。
• 项目 ID 是必填字段。
• 底层 API 为 构建定义 - 列表。

管道

• 查看指定项目的流水线列表。
• 项目 ID 是必填字段
• 底层 API 为 流水线 - 列表

流水线运行

• 获取指定流水线的排名前 10000 次运行。
• 项目 ID 和流水线 ID 是必填字段
• 底层 API 为 流水线运行 - 列表

发布

• 获取指定项目的发布列表。
• 项目 ID 是必填字段
• 查询响应将范围限定为仪表板的时间范围。maxCreatedTime 和 minCreatedTime 参数会根据仪表板时间范围自动传递到 API。
• 底层 API 为 发布 - 列表

发布定义

• 获取指定项目的发布定义列表。
• 项目 ID 是必填字段
• 底层 API 为 发布定义 - 列表

发布部署

• 获取指定项目的发布部署列表。
• 项目 ID 是必填字段
• 底层 API 为 发布部署 - 列表

模板和变量

要添加新的 Azure DevOps 查询变量，请参考 添加查询变量。使用您的 Azure devops 数据源作为以下可用查询的数据源

注意：您无法在变量编辑器中通过项目/存储库名称应用正则表达式。此外，插件中不支持多变量。

示例仪表板

Azure DevOps 插件包含可以从插件配置页面“仪表板”选项卡导入的示例预制仪表板。这些仪表板用于演示目的，可能无法满足您的所有需求。

充分利用插件

• 添加 注释。
• 配置和使用 模板和变量。
• 添加 转换。
• 不支持 警报。