Grafana GitHub数据源

GitHub数据源允许GitHub API数据直观地反映在Grafana仪表板。

Github API V4 (graphql)

这个数据源使用githubv4包,目前正在积极开发之中。

特性

后端

• [x]发布
• [x]提交
• [x]存储库
• [x]问题
• [x]组织
• [x]标签
• [x]的里程碑
• [x]响应缓存
• [x]项目
• []部署

前端

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

缓存

在这个插件缓存总是启用。

配置

选项:

设置	要求
访问令牌	真正的
默认的组织	假
默认存储库	真正的
Github企业网址	假

创建一个新的访问令牌,导航个人访问令牌并创建一个点击“生成新的令牌。”

供应

可以使用配置文件配置数据源Grafana准备系统。

与prom-operator

promop: grafana: additionalDataSources:名称:GitHub回购见解类型:grafana-github-datasource jsonData:老板:“存储库:“secureJsonData: accessToken:“< GitHub api牌>”

注释

在一个图表注释覆盖事件。

使用注释,您可以显示:

• 提交
• 问题
• 把请求
• 释放
• 标签

在图。

所有注释要求您选择一个字段来显示注释,和一个字段表示事件发生的时间。

变量

变量允许您替换值在一组预定义的值。

你可以引用他们内部查询,比如允许用户配置参数查询或存储库。

宏

你可以使用以下宏查询

宏的名字	语法	描述	例子
multiVar	美元__multiVar(前缀,$ var)	一个多值变量展开成github查询字符串	美元__multiVar(标签,标签美元)将扩大到标签:first-label标签:second-label
		当使用所有在多变量,使用*作为自定义所有的价值

访问令牌的权限

所有存储库:

• public_repo
• 回购:状态
• repo_deployment
• 读:包
• 用户:读
• 用户:电子邮件

Github项目:

• 读:组织
• 读:项目

需要额外的设置私人存储库

• 回购(完全控制私人存储库)

示例指示板

对文档导入仪表板,查看文档www.tubolov.com

这个示例指示板可以获得来自两个地方。

1. 从Grafana仪表板页面坐落在这里

2. 从这个库

如果从这个存储库加载它,打开Grafana并单击“进口仪表板”。

复制的JSON. / src /仪表板/ dashboard.json通过面板,并粘贴到“进口json”框。

常见问题

• 我使用GitHub OAuth Grafana。我的用户可以请求他们个人GitHub账户而不是共享access_token吗?

不。这需要改变Grafana第一。看到这个问题在Grafana项目。

• 为什么它有时需要5分钟给我新的拉请求/问题/新提交出现吗?

我们有积极的缓存启用由于GitHub的速率限制政策。当选择一个时间范围“最后时刻”,每个小组的查询和缓存的时间范围是暂时的。

• 为什么会有两个选择的选项把请求和问题时候创建注释吗?

有两次,影响一个注释:

• 仪表板或面板的时间范围
• 的时间应该用于显示图形上的事件

第一个选择是用来过滤事件,显示在图。例如,如果您选择“关闭”,只“封闭”的事件在仪表板的时间范围将被显示在图。

第二个选择是用来确定图上的事件应该显示。

通常,这些将是相同的,但是有些情况下,你可能希望他们是不同的。