插件 〉GitHub
GitHub
Grafana GitHub 数据源
Grafana 的 GitHub 数据源插件允许您在 Grafana 中查询 GitHub API,以便可视化您的 GitHub 仓库和项目。
文档
关于插件文档,请访问插件文档网站。
视频教程
观看此视频,了解如何设置 Grafana GitHub 数据源插件
[!TIP]
使用 Grafana Play 试用一下
通过 Grafana Play,您可以探索并了解其工作原理,从实际示例中学习,从而加速您的开发。此功能可在GitHub 数据源插件演示中查看。
GitHub API V4 (GraphQL)
此数据源使用 githubv4
包,该包正在积极开发中。
常见问题
- 为什么我的新拉取请求/新问题/新提交有时需要长达 5 分钟才能显示?
由于 GitHub 的速率限制策略,我们启用了激进的缓存。当选择“最近一小时”等时间范围时,每个面板的查询与时间范围的组合会暂时缓存。
- 创建注释时,为什么拉取请求和问题时间有两个选择选项?
有两个时间会影响注释
- 仪表盘或面板的时间范围
- 应用于在图表上显示事件的时间
第一个选择用于过滤显示在图表上的事件。例如,如果选择“关闭时间”,则只有在仪表盘时间范围内“关闭”的事件才会显示在图表上。
第二个选择用于确定事件应显示在图表上的哪个位置。
通常这两个时间是相同的,但在某些情况下您可能希望它们不同。
在 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 主菜单访问,新安装的数据源可以在数据源部分立即添加。
接下来,点击右上角的“添加数据源”按钮。该数据源将在类型选择框中可用。
要查看已安装的数据源列表,请点击主菜单中的插件项。核心数据源和已安装的数据源都将显示。
更新日志
2.1.5
补丁变更
🐛 更新 golang-jwt/jwt 依赖到 v4.5.2 🐛 从 plugin-sdk-go 获取默认 http 传输
[2.1.4]
- **修复** - Workflow 运行 - 日期筛选器现在按时间筛选
- **修复** - 项目查询中的 Panic
- **安全** - 将 prismjs 升级到 1.30.0
[2.1.3]
- **修复** - 添加互斥锁保护以防止数据源缓存中的数据竞争
- **杂项** - 添加包类型的验证
[2.1.2]
- **修复** - GitHub Enterprise URL 缺少 /api/v3
[2.1.1]
- **修复** - 使用应用认证时 GitHub Enterprise URL 错误
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 升级到 0.268.1
[2.1.0]
- **功能** - 添加新查询以检索 Workflow 运行
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 升级到 0.266.0
- **杂项** - 将 dompurify 升级到 3.2.4
[2.0.2]
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 升级到 0.265.0
[2.0.1]
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 从 0.260.3 升级到 0.261.0
[2.0.0]
- **杂项**:插件现在需要 Grafana 10.4.8 或更高版本
[1.9.2]
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 从 0.255.0 升级到 0.258.0
- **杂项** - 更新 uplot 依赖到 1.6.31
[1.9.1]
- **文档** - 在 README 中添加视频教程
- **文档** - 更新权限和配置文档
- **文档** - 更新插件设置文档
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 从 0.252.0 升级到 0.255.0
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 从 0.251.0 升级到 0.252.0
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 从 0.250.0 升级到 0.251.0
[1.9.0]
- **功能** - 添加对 GitHub App 认证的支持
- **修复** - 修复 saml 错误和限制错误的错误源
- **修复** - 隐藏 GraphQL API 不支持的包类型
- **杂项** - 更新 GitHub 的拼写
- **杂项** - 将 github.com/grafana/grafana-plugin-sdk-go 从 0.247.0 升级到 0.250.0
- **杂项** - 将 path-to-regexp 从 1.8.0 升级到 1.9.0
[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]
- **功能** - 在
Pull Request
查询结果中添加额外的用户字段 - **杂项** - 更新文档,新的和更新的文档可在官方网站获取
[1.7.4]
- **杂项** - 更新文档
[1.7.3]
- **修复** - 修复
Packages
查询中最初未选择包类型时的错误 - **杂项** - 更新文档
- **杂项** - 将 grafana-plugin-sdk-go 升级到 v0.241.0
- **杂项** - 标记下游错误
[1.7.2]
- **杂项** - 将 grafana-plugin-sdk-go 升级到 v0.240.0
[1.7.1]
- **杂项** - 将 provisioning 文件夹添加到 .gitignore
- **杂项** - 将错误源添加到错误响应
[1.7.0]
- **功能** - 在
Issue
查询结果中添加updated_at
字段 - **功能** - 在
Issue
查询选项中添加UpdatedAt
字段 - **修复** - 修复模板中响应数据为空数组时的错误
- **修复** - 修复
Workflows
查询中每页限制为 100,因为这是支持的最大值 - **修复** - 移除
Vulnerabilities
查询中的查询输入,因为 API 不支持此功能 - **杂项** - 将 e2e 从 cypress 迁移到 playwright
- **杂项** - 更新依赖项
[1.6.0]
- **功能** - 在
Commit
查询中添加message
字段 - **功能** - 在
Workflow status
查询中添加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 workflow
- **杂项** - 移除旧式表单样式
[1.5.2]
- **错误修复** - 修复配置页与 Grafana < 10.1 的向后兼容性问题
[1.5.1] - 2023-10-10
- **功能** - 更新配置页面
- **杂项** - 更新功能使用跟踪以提高性能
[1.5.0] - 2023-09-13
- **功能** - 问题查询:允许仓库为可选
[1.4.7] - 2023-08-03
- **功能** - 添加查询 Workflow 和 Workflow 使用情况的功能
[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
字段到Vulnerabilities
查询
[1.4.0] - 2023-02-03
- **功能** - 添加 stargazers 查询类型
- **杂项** - 次要文档更新
[1.3.3] - 2023-01-09
- **杂项** - 移除 angular 依赖:迁移了 annotation 编辑器
[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
- 在 annotation 查询中添加了 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 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
- 初次发布