博客/工程

我们如何使用Grafana和普罗米修斯监控的交通多GitHub库

2021年9月20日 3分钟

如果你想了解你的GitHub库的流行,知道恒星的数量是不够的。GitHub理解这一点,这就是为什么团队发布的交通的见解

任何推动访问存储库可以查看这些信息,其中包括:完整的克隆,游客从过去14天,指网站,和受欢迎的内容流量图。看到数据一样容易会回购的主页,点击见解(在存储库名称),然后点击流量(在左侧边栏)。

瞧!您应当会看到类似这样的:

的意。

但是如果你有很多回购?

转k6,我们有大量的开源库集成、扩展、示例和文档。和数量继续上升。

我们希望有一种方法来理解的流行和使用存储库,而不需要手动收集这些数据,他们一个接一个,和做笔记。

引入GitHub的交通工具

我们设计并建造GitHub的交通工具,它以编程方式超过我们所有的存储库,得到了流量数据,暴露数据作为普罗米修斯指标。这个工具让我们的组织的所有存储库,以及所有我们需要的流量数据,我们使用了REST api由GitHub提供。

最酷的这种方法,我们可以把这个工具和其他服务。我们可以依靠我们当前舰队Grafana特工刮这些指标,并运送到我们的Grafana云普罗米修斯实例。

但在所有这些指标是不够的。我们需要一种方法来可视化他们!所以我们创建了一个小仪表板工作的:

酷,酷,酷,但是…,仪表板,你有意见,克隆,和星星…上面提到网站的列表在哪里?为每个回购和最受欢迎的内容吗?

好赶上!:)

第一个版本,我们试图保持范围小,只有可用数据的一个子集。将来,我们可能会添加缺失的数据和更多的东西。

如何你能做到吗

是的。这个工具是完全开源软件,它是可用的grafana / github-traffic存储库。

使用它一样容易创建一个小的.env像这样的文件:

美元猫.env GITHUB_TOKEN = your-github-token-goes-here ORG_NAME = the-name-of-your-organization-goes-here

和发射一个新的容器:

码头工人运行——美元env-file .env - - p 8001:8001 ghcr。io / grafana github-traffic水平= INFO味精=“Github交通运行!”水平= INFO味精=“收集见解”回购=“转k6”观点= 163克隆unique_views = 90 = 406 unique_clones = 13805 = INFO味精= = 109颗恒星“收集见解”回购=“postman-to-k6”观点= 3 unique_views = 1 = 2克隆unique_clones = 238 = INFO味精= = 1恒星“收集见解”回购=“jmeter-to-k6”观点= 1克隆unique_views = 1 = 2 unique_clones = 2星= 44……

一旦完成,您应该能够感受欢乐的暴露指标去http://localhost: 8001 /指标

在存储库中,您可以找到更多关于支持的文档配置选项。我们也发表了一份Grafana仪表板可以作为一个起点,想象所有这些新普罗米修斯指标。

让我们知道你的想法

请继续关注未来的内容如何紧密集成Grafana和GitHub。和告诉我们你想见!一个好地方到达我们的问题GitHub回购,或者Grafana社区松弛

最后,如果你喜欢这篇文章,我鼓励你去看看我们GitHub插件Grafana,阅读博客。”我们如何使用Grafana GitHub插件跟踪优秀把请求吗”。

Grafana云是最简单的方法开始使用指标、日志、痕迹和仪表板。我们有一个慷慨的永远免费的层和每个用例的计划。现在免费注册!