插件 〉GitHub

开发者
Grafana Labs
资源

注册以接收偶尔的产品新闻和更新

最新网络研讨会
在 Grafana Cloud 中扩展和保护您的 Prometheus 指标
在 Grafana Cloud 中扩展和保护您的 Prometheus 指标
Grafana 指标入门：Prometheus、Grafana Mimir 及其他
Grafana 指标入门：Prometheus、Grafana Mimir 及其他
使用 Grafana Loki 扩展和保护您的日志
使用 Grafana Loki 扩展和保护您的日志
数据源
grafana

GitHub

文档 →

Grafana GitHub 数据源

GitHub 数据源允许在 Grafana 仪表盘中以可视化的方式呈现 GitHub API 数据。

文档

有关插件文档，请访问 插件文档网站。

GitHub API V4 (GraphQL)

此数据源使用 githubv4 包，该包处于积极开发中。

功能

后端

  • 版本
  • 提交
  • 仓库
  • Stargazers
  • 问题
  • 组织
  • 标签
  • 里程碑
  • 响应缓存
  • 项目
  • 工作流
  • 部署

前端

  • 可视化查询
  • 模板变量
  • 注释

缓存

此插件始终启用缓存。

配置

选项

设置必填
访问令牌true
默认组织false
默认仓库true
GitHub 企业版 URLfalse

要创建新的访问令牌，请导航到 个人访问令牌 并按下**生成新令牌**。

供应

可以使用配置文件和 Grafana 的供应系统配置数据源.

使用 prom-operator

promop:
  grafana:
    additionalDataSources:
      - name: GitHub Repo Insights
        type: grafana-github-datasource
        jsonData:
          owner: ''
          repository: ''
        secureJsonData:
          accessToken: '<github api token>'

注释

注释在图表上覆盖事件。

Annotations on a graph

使用注释，您可以显示

  • 提交
  • 问题
  • 拉取请求
  • 版本
  • 标签

在图表上。

所有注释都需要您选择一个要在注释中显示的字段，以及一个表示事件发生时间的字段。

Annotations editor

变量

变量 允许您使用预定义的值替换面板中的值。

Creating Variables

您可以在查询中引用它们，允许用户配置参数，例如Query 或Repository。

Using Variables inside queries

宏

您可以在查询中使用以下宏

宏名称语法描述示例
multiVar$__multiVar(prefix,$var)将多值变量扩展为 github 查询字符串$__multiVar(label,$labels) 将扩展为 label:first-label label:second-label
在使用多变量中的全部时，请使用*作为自定义全部值
天$__toDay(diff)根据 UTC 时间返回日期，可以添加日期差2022-01-17 上的created:$__toDay(-7) 将扩展为 created:2022-01-10

访问令牌权限

对于所有仓库

  • public_repo
  • repo:status
  • repo_deployment
  • read:packages
  • read:user
  • user:email

对于 Github 项目

  • read:org
  • read:project

私有仓库需要额外的设置。

  • 仓库（对私有仓库拥有完全控制权）

示例仪表盘

有关导入仪表盘的文档，请查看grafana.com上的文档。

示例仪表盘可以从以下两个地方获取。

  1. 从Grafana仪表盘页面此处获取

  2. 从这个仓库获取

如果从该仓库加载，请打开Grafana并点击“导入仪表盘”。

复制./src/dashboards/dashboard.json中的JSON，并将其粘贴到“通过面板JSON导入”框中。

常见问题

  • 我在Grafana上使用GitHub OAuth。我的用户可以使用他们自己的GitHub账户而不是共享的access_token发出请求吗？

不可以。这需要先在Grafana中进行更改。请查看Grafana项目中的此问题。

  • 为什么我的新拉取请求/新问题/新提交有时需要长达5分钟才能显示？

由于GitHub的限速策略，我们启用了积极的缓存。当选择像“最近一小时”这样的时间范围时，每个面板的查询和时间范围的组合会暂时被缓存。

  • 创建注释时，为什么有两个用于拉取请求和问题时间的选项？

有两个时间会影响注释

  • 仪表盘或面板的时间范围
  • 用于在图表上显示事件的时间

第一个选项用于过滤在图表上显示的事件。例如，如果选择“关闭时间”，则只有在仪表盘时间范围内“关闭”的事件才会显示在图表上。

第二个选项用于确定事件在图表上的显示位置。

通常情况下，这两个选项是相同的，但在某些情况下，您可能希望它们不同。

在Grafana Cloud上安装GitHub

有关更多信息，请访问有关插件安装的文档。

更改日志

[1.8.2]

  • 杂项 - 将grafana-plugin-sdk-go更新至v0.247.0

[1.8.1]

  • 杂项 - 将micromatch从4.0.5更新至4.0.8
  • 杂项 - 将webpack从5.91.0更新至5.94.0
  • 杂项 - 将grafana-plugin-sdk-go更新至v0.245.0

[1.8.0]

  • 功能 - 在拉取请求查询的结果中添加额外的用户字段
  • 杂项 - 更新文档，新的和更新的文档可在官方网站上获取

[1.7.4]

  • 杂项 - 更新文档

[1.7.3]

  • 修复 - 修复包查询中的错误，该错误在最初未选择任何包类型时发生
  • 杂项 - 更新文档
  • 杂项 - 将grafana-plugin-sdk-go更新至v0.241.0
  • 杂项 - 标记下游错误

[1.7.2]

  • 杂项 - 将grafana-plugin-sdk-go更新至v0.240.0

[1.7.1]

  • 杂项 - 将配置文件夹添加到.gitignore
  • 杂项 - 将错误来源添加到错误响应

[1.7.0]

  • 功能 - 在问题查询的结果中添加updated_at字段
  • 功能 - 在问题查询的查询选项中添加UpdatedAt字段
  • 修复 - 修复在模板化中响应数据包含空数组时的错误
  • 修复 - 将工作流查询中的每页限制修复为100，因为这是最大支持值
  • 修复 - 删除漏洞查询中的查询输入，因为API不支持它
  • 杂项 - 将e2e从cypress迁移到playwright
  • 杂项 - 更新依赖项

[1.6.0]

  • 功能 - 在提交查询中添加message字段
  • 功能 - 在工作流状态查询中添加name字段
  • 修复 - 变量编辑器支持所有查询类型

[1.5.7]

  • 杂项 - 更新依赖项

[1.5.6]

  • 杂项 - 使用go 1.22.2构建
  • 杂项 - 将grafana-plugin-sdk-go更新至v0.220.0（最新版本）
  • 错误修复 - 防止在更改查询类型时部分查询运行

[1.5.5]

  • 杂项 - 使用go 1.22构建
  • 修复 - 通过使用github-datasource存储库而不是grafana来加快健康检查速度

[1.5.4]

  • 杂项 - 将grafana-plugin-sdk-go更新至v0.198.0（最新版本）
  • 错误修复 - 修复标签查询也返回提交的问题
  • 错误修复 - 修复配置页面中重置URL的问题

[1.5.3]

  • 杂项 - 将grafana-plugin-sdk-go更新至最新版本
  • 杂项 - 添加lint github工作流
  • 杂项 - 删除旧版表单样式

[1.5.2]

  • 错误修复 - 修复配置页面与Grafana < 10.1的后向兼容性

[1.5.1] - 2023-10-10

  • 功能 - 更新配置页面
  • 杂项 - 更新功能跟踪使用情况以提高性能

[1.5.0] - 2023-09-13

  • 功能 - 问题查询：允许仓库为可选

[1.4.7] - 2023-08-03

  • 功能 - 添加查询工作流和工作流使用情况的功能

[1.4.6] - 2023-07-14

  • 错误修复 - 修复一个错误，该错误导致禁用的查询仍在执行

[1.4.5] - 2023-05-04

  • 杂项 - 后端二进制文件现在使用golang 1.20.4编译

[1.4.4] - 2023-04-19

  • 杂项 - 将go版本更新至1.20

[1.4.3] - 2023-03-07

  • 杂项 - 将grafana-plugin-sdk-go更新至v0.155.0以修复此插件的内容与其签名不匹配错误

[1.4.2] - 2023-03-06

  • 杂项 - 迁移到创建插件并升级依赖项

[1.4.1] - 2023-03-01

  • 功能 - 在漏洞查询中添加RepositoryVulnerabilityAlertState字段

[1.4.0] - 2023-02-03

  • 功能 - 添加stargazers查询类型
  • 杂项 - 较小的文档更新

[1.3.3] - 2023-01-09

  • 杂项 - 删除angular依赖项：迁移注释编辑器

[1.3.2] - 下一个版本

  • 功能 添加$__toDay()宏支持

[1.3.1] 2022-12-21

  • 杂项 - 将go版本更新至最新版本（1.19.4）
  • 杂项 - 更新后端grafana依赖项
  • 杂项 - 添加拼写检查

[1.3.0] 2022-11-3

  • 功能 - Github项目 - 查询项目、用户项目
  • 杂项 - 更新构建以使用go 1.19.3

[1.2.0] 2022-10-20

  • 功能 - Github项目

[1.1.0] - 下一个版本

  • 更新grafana所需的最低运行时版本到8.4.7

[1.0.15] 2022-05-05

  • 修复变量插值

[1.0.14] 2022-04-25

  • 添加$__multiVar()宏支持

[1.0.13] 2021-12-01

  • 修复仪表盘变量无法正确设置的错误

[1.0.12] 2021-12-01

  • 在注释查询中添加refId

[1.0.11] 2021-05-17

  • 在响应中添加存储库字段

[1.0.10] 2021-04-01

  • 修复某些时间值渲染不正确的问题

[1.0.9] 2021-04-01

  • 修复仪表盘路径不正确的问题

[1.0.8] 2020-12-10

  • 修复grafana.com上屏幕截图未渲染的问题（感谢@mjseaman）

[1.0.7] 2020-12-07

  • 在AnnotationsQueryEditor中添加标签到可查询资源列表中（感谢@nazzzzz）

[1.0.6] 2020-09-24

  • 在健康检查成功状态中添加消息（感谢@vladimirdotk）
  • 为GitHub企业用户添加URL选项（感谢@bmike78）

[1.0.5] 2020-09-15

  • 将拉取请求ID（编号）、URL和存储库名称添加到拉取请求响应中（修复#60）
  • 添加使用org:搜索词在组织中搜索所有拉取请求的功能（修复#61）
  • 删除存储库列表中的限制（修复#59）

[1.0.3] 2020-09-11

  • 添加禁用拉取请求时间字段过滤的功能（修复#57）

[1.0.1] 2020-09-11

  • 添加查询存储库以获取变量的功能（修复#52）
  • 修复重复面板的范围变量（修复#51）
  • 现在显示拉取请求的默认时间字段（关闭时间），而不是空下拉列表

[1.0.0] 2020-09-10

  • 初始版本

未找到
博客文章
如何使用 k6、GitHub Actions 和 Grafana 将性能测试构建到您的 CI 管道中
未找到
博客文章
了解如何使用 Jira、ServiceNow、GitHub 和 GitLab 插件以提高 Grafana 中软件开发的可视性
未找到
博客文章
我们如何使用 Grafana GitHub 插件跟踪未完成的 Pull Request
未找到
博客文章
使用 Elasticsearch 和 Grafana 分析您的 GitHub 项目
未找到
文档
使用 AngularJS 的插件
未找到
博客文章
视频：如何开始使用 MongoDB 和 Grafana
未找到
博客文章
推出改进后的 Grafana BigQuery 插件
未找到
博客文章
使用 Grafana、Databricks 和 Sqlyze 插件监控废水中 COVID-19 病毒水平
未找到
博客文章
视频：Grafana Enterprise 版的新 Relic 数据源插件的 3 大功能
未找到
博客文章
Grafana Cloud 的合成监控插件中的 Traceroute 如何帮助进行网络故障排除
未找到
博客文章
视频：如何在 Grafana 中构建 Prometheus 查询
未找到
博客文章
视频：如何在 Grafana 中设置 Prometheus 数据源
未找到
博客文章
不要错过我们关于 Grafana Tempo、Grafana Enterprise Traces 和新的 Sentry 插件的网络研讨会
未找到
博客文章
Grafana 2021：年度回顾
未找到
博客文章
使用新的 Amazon Redshift 数据源插件在 Grafana 中监控所有 Redshift 集群