插件 〉GitHub
GitHub
Grafana GitHub 数据源
Grafana 的 GitHub 数据源插件允许您在 Grafana 中查询 GitHub API,以便可视化您的 GitHub 仓库和项目。
文档
有关插件文档,请访问插件文档网站。
视频教程
观看此视频,详细了解如何设置 Grafana GitHub 数据源插件
[!TIP]
在 Grafana Play 中试用
使用 Grafana Play,您可以探索并了解其工作原理,从实际示例中学习,加速您的开发。此功能可以在GitHub 数据源插件演示中看到。
GitHub API V4 (GraphQL)
此数据源使用githubv4
包,该包正在积极开发中。
常见问题解答
- 为什么我的新拉取请求/新 issue/新提交有时需要长达 5 分钟才能显示出来?
由于 GitHub 的速率限制策略,我们启用了积极的缓存。当选择“Last hour”(过去一小时)之类的时间范围时,每个面板的查询和时间范围的组合会临时缓存。
- 为什么在创建注释时,拉取请求和 Issue 时间有两个选择选项?
有两个时间会影响注释
- 仪表板或面板的时间范围
- 应该用于在图表上显示事件的时间
第一个选择用于过滤在图表上显示的事件。例如,如果您选择“closed at”(关闭时间),则仅在仪表板时间范围内“关闭”的事件将显示在图表上。
第二个选择用于确定事件应显示在图表上的位置。
通常,这些选择是相同的,但是,在某些情况下,您可能希望它们有所不同。
在 Grafana Cloud 上安装 GitHub
在 Grafana Cloud 实例上安装插件只需一键安装;更新也是如此。很酷,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键安装;更新也是如此。很酷,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键安装;更新也是如此。很酷,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键安装;更新也是如此。很酷,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键安装;更新也是如此。很酷,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键安装;更新也是如此。很酷,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键安装;更新也是如此。很酷,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示出来。
有关更多信息,请访问关于插件安装的文档。
在本地 Grafana 上安装
对于本地实例,插件通过简单的 CLI 命令安装和更新。插件不会自动更新,但是,当更新可用时,您将在 Grafana 中收到通知。
1. 安装数据源
使用 grafana-cli 工具从命令行安装 GitHub
grafana-cli plugins install
该插件将安装到您的 grafana 插件目录中;默认目录为 /var/lib/grafana/plugins。有关 cli 工具的更多信息。
2. 配置数据源
从 Grafana 主菜单访问,新安装的数据源可以立即在“Data Sources”(数据源)部分中添加。
接下来,单击右上角的“Add data source”(添加数据源)按钮。该数据源将在“Type”(类型)选择框中可用。
要查看已安装数据源的列表,请单击主菜单中的“Plugins”(插件)项。核心数据源和已安装的数据源都将出现。
变更日志
[2.0.2]
- Chore - Bump github.com/grafana/grafana-plugin-sdk-go 至 0.265.0
[2.0.1]
- Chore - Bump github.com/grafana/grafana-plugin-sdk-go 从 0.260.3 至 0.261.0
[2.0.0]
- Chore:插件现在需要 Grafana 10.4.8 或更高版本
[1.9.2]
- Chore - Bump github.com/grafana/grafana-plugin-sdk-go 从 0.255.0 至 0.258.0
- Chore - 更新 uplot 依赖项至 1.6.31
[1.9.1]
- Docs - 将视频教程添加到 README
- Docs - 更新关于权限和配置的文档
- Docs - 更新文档插件设置
- Chore - Bump github.com/grafana/grafana-plugin-sdk-go 从 0.252.0 至 0.255.0
- Chore - Bump github.com/grafana/grafana-plugin-sdk-go 从 0.251.0 至 0.252.0
- Chore - Bump github.com/grafana/grafana-plugin-sdk-go 从 0.250.0 至 0.251.0
[1.9.0]
- Feature - 添加对 GitHub App 身份验证的支持
- Fix - 修复 saml 错误和限制错误的错误来源
- Fix - 隐藏 GraphQL API 不支持的包类型
- Chore - 更新 GitHub 的拼写
- Chore - Bump github.com/grafana/grafana-plugin-sdk-go 从 0.247.0 至 0.250.0
- Chore - Bump path-to-regexp 从 1.8.0 至 1.9.0
[1.8.2]
- Chore - Bump grafana-plugin-sdk-go 至 v0.247.0
[1.8.1]
- Chore - Bump micromatch 从 4.0.5 至 4.0.8
- Chore - Bump webpack 从 5.91.0 至 5.94.0
- Chore - Bump grafana-plugin-sdk-go 至 v0.245.0
[1.8.0]
- Feature - 在
Pull Request
查询中向结果添加额外的用户字段 - Chore - 更新文档,官方网站上提供了新的和更新的文档
[1.7.4]
- Chore - 更新文档
[1.7.3]
- Fix - 修复
Packages
查询中最初未选择任何包类型时出现的错误 - Chore - 更新文档
- Chore - Bump grafana-plugin-sdk-go 至 v0.241.0
- Chore - 标记下游错误
[1.7.2]
- Chore - Bump grafana-plugin-sdk-go 至 v0.240.0
[1.7.1]
- Chore - 将配置文件夹添加到 .gitignore
- Chore - 将错误来源添加到错误响应
[1.7.0]
- Feature - 在
Issue
查询中向结果添加updated_at
字段 - Feature - 在
Issue
查询中向查询选项添加UpdatedAt
字段 - Fix - 修复响应在模板化中包含空数组的数据时出现的错误
- Fix - 修复
Workflows
查询中每页限制为 100,因为这是最大支持值 - Fix - 移除
Vulnerabilities
查询中的查询输入,因为 API 不支持它 - Chore - 将 e2e 从 cypress 迁移到 playwright
- Chore - 更新依赖项
[1.6.0]
- Feature - 向
Commit
查询添加message
字段 - Feature - 向
Workflow status
查询添加name
字段 - Fix - 变量编辑器以支持所有查询类型
[1.5.7]
- Chore - 更新依赖项
[1.5.6]
- Chore - 使用 go 1.22.2 构建
- Chore - Bump grafana-plugin-sdk-go 至 v0.220.0 (最新)
- Bug Fix - 阻止在更改查询类型时运行部分查询
[1.5.5]
- Chore - 使用 go 1.22 构建
- Fix - 通过使用 github-datasource 仓库而不是 grafana 来加快运行状况检查速度
[1.5.4]
- Chore - Bump grafana-plugin-sdk-go 至 v0.198.0 (最新)
- Bug Fix - 修复标签查询以也返回提交
- Bug Fix - 修复配置页面中重置 URL 的问题
[1.5.3]
- Chore - Bump grafana-plugin-sdk-go 至最新版本
- Chore - 添加了 lint GitHub 工作流程
- Chore - 移除旧式表单样式
[1.5.2]
- BugFix - 修复配置页面与 Grafana < 10.1 的向后兼容性
[1.5.1] - 2023-10-10
- Feature - 更新配置页面
- Chore - 更新功能跟踪使用情况以提高性能
[1.5.0] - 2023-09-13
- Feature - Issues 查询:允许仓库为可选
[1.4.7] - 2023-08-03
- Feature - 添加查询工作流和工作流使用情况的功能
[1.4.6] - 2023-07-14
- Bugfix - 修复了禁用查询仍被执行的错误
[1.4.5] - 2023-05-04
- Chore - 后端二进制文件现在使用 golang 1.20.4 编译
[1.4.4] - 2023-04-19
- Chore - 将 go 版本更新至 1.20
[1.4.3] - 2023-03-07
- Chore - 更新 grafana-plugin-sdk-go 至 v0.155.0,以修复
The content of this plugin does not match its signature
错误
[1.4.2] - 2023-03-06
- Chore - 迁移到 create plugin 并升级依赖项
[1.4.1] - 2023-03-01
- Feature - 向
Vulnerabilities
查询添加RepositoryVulnerabilityAlertState
字段
[1.4.0] - 2023-02-03
- Feature - 添加了 stargazers 查询类型
- Chore - 少量文档更新
[1.3.3] - 2023-01-09
- Chore - 移除 angular 依赖项:迁移了注释编辑器
[1.3.2] - next
- Feature 添加了
$__toDay()
宏支持
[1.3.1] 2022-12-21
- Chore - 将 go 版本更新至最新 (1.19.4)
- Chore - 更新了后端 grafana 依赖项
- Chore - 添加了拼写检查
[1.3.0] 2022-11-3
- Feature - GitHub 项目 - 查询项目、用户项目
- Chore - 更新了构建以使用 go 1.19.3
[1.2.0] 2022-10-20
- Feature - GitHub 项目
[1.1.0] - next
- 更新了 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
- 修复了某些时间值呈现不正确的 issue
[1.0.9] 2021-04-01
- 修复了仪表板路径不正确的 issue
[1.0.8] 2020-12-10
- 修复了屏幕截图未在 grafana.com 上呈现的 issue(感谢 @mjseaman)
[1.0.7] 2020-12-07
- 向 AnnotationsQueryEditor 中可查询资源列表添加了标签(感谢 @nazzzzz)
[1.0.6] 2020-09-24
- 向运行状况检查成功状态添加了消息(感谢 @vladimirdotk)
- 为 GitHub Enterprise 用户添加了 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
- 初始版本