文档 插件 适用于Grafana的Azure Devops数据源

适用于Grafana的Azure DevOps数据源

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

开始之前

• 确保您有一个Azure Devops账户和个人访问令牌。
• 确保您拥有以下账户类型之一
  • Graphana Cloud：专业客户、高级客户或已启用企业插件附加组件的专业试用用户
  • Graphana企业版：拥有已激活的许可证和拥有Graphana服务器或组织管理权限的用户
• 确保已启用企业插件附加组件。

已知限制

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

涵盖的功能

安装Azure DevOps数据源插件

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

从Azure DevOps获取个人访问令牌

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

为您的API令牌设置必要的read权限。这包括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 插件包含可以从插件配置页面“仪表板”选项卡导入的示例预制仪表板。这些仪表板仅用于演示目的，可能无法满足您的所有需求。

充分利用插件

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