Grafana的Azure DevOps数据源

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

在开始之前

  • 确保您有一个Azure devops帐户和一个个人访问令牌。
  • 确保您拥有以下帐户类型之一:
    • Grafana云:启用企业插件的专业用户、高级用户或专业试用用户
    • Grafana企业:有激活许可证以及具有Grafana服务器或组织管理的用户权限
  • 确保启用了Enterprise插件。

已知的限制

  • 模板变量不能多选择;只支持单一选择。
  • 只有以下特性集作为插件的一部分提供

功能覆盖

服务 API 参考文档
核心 计划-一览表 API
Git 资料库-列表 API
拉请求-列表 API
构建 构建-列表 API
定义-列表 API
管道 管道-一览表 API
跑步-列表 API
释放 定义-列表 API
部署-列表 API
新闻稿-一览表 API

安装Azure DevOps数据源插件

要安装数据源,请参见安装

从Azure DevOps获取个人访问令牌

要获取个人访问令牌,请参见Azure DevOps文档-个人访问令牌部分

设置必要的你的API令牌的权限。这包括workItems.readcode.readcode.statusbuild.readrelease.readtest.read而且packaging.read.如果不使用特定功能,可以跳过特定权限。

在Grafana中配置数据源

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

描述
URL 你的Azure DevOps实例的URL。例子:https://dev.azure.com/xxxxxx
帕特牌 Azure DevOps个人访问令牌。参考上一节了解如何生成一个。
项目限制 要检索的项目数。默认为100。当组织中有超过100个项目时非常有用

用供应配置数据源

您可以在Grafana的供应系统中使用配置文件配置数据源。要阅读有关配置如何工作的更多信息,包括数据源设置的完整列表,请参阅供应Grafana

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来过滤特定于存储库的pull请求。
  • 底层API是通过项目获得拉请求

构建

  • 查看指定项目的生成列表。
  • 项目ID是一个必填字段。
  • 查询响应的范围是仪表板的时间范围。maxTime而且minTime参数根据仪表板时间范围自动传递给API。
  • 底层API是构建-列表

构建的定义

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

管道

  • 查看指定项目的管道列表。
  • 项目ID是一个必填字段
  • 底层API是管道-一览表

管道运行

  • 获取指定管道的前10000次运行
  • “Project ID”和“Pipeline ID”为必填字段
  • 底层API是管道运行-列表

释放

  • 获取指定项目的版本列表
  • 项目ID是一个必填字段
  • 查询响应的范围将限定在仪表板的时间范围内。maxCreatedTime而且minCreatedTime参数根据仪表板时间范围自动传递给API
  • 底层API是新闻稿-一览表

释放的定义

  • 获取指定项目的版本定义列表
  • 项目ID是一个必填字段
  • 底层API是版本定义-列表

版本部署

  • 获取指定项目的版本部署列表
  • 项目ID是一个必填字段
  • 底层API是发布部署—列表

模板和变量

要添加一个新的Azure DevOps查询变量,请参考添加一个查询变量.使用Azure devops数据源作为以下可用查询的数据源:

查询类型 描述
项目 返回项目id列表。项目ID将是一个值。项目名称被用作显示值
存储库 返回存储库id的列表。存储库ID将是值。存储库名称用作显示值。您还可以指定项目,以便只针对特定的项目筛选存储库

注意:你不能在变量编辑器中通过项目/回购名称应用正则表达式。此外,该插件不支持多变量

充分利用插件