metrixio / github-public
此工具帮助开发者了解他们的代码受欢迎程度以及如何被使用。它与 Prometheus 和 Grafana 一起工作,从 Github 获取数据并创建酷炫的视觉效果。您可以使用 Grafana 过滤和自定义收集的指标。我们希望这对您有帮助!
1.0.0
2022-12-26 21:14 UTC
Requires
- php: >=8.1
- ext-mbstring: *
- nesbot/carbon: ^2.63
- spiral/framework: ^3.5
- spiral/roadrunner-bridge: ^2.1
Requires (Dev)
- phpunit/phpunit: ^9.5
- spiral/testing: ^2.2
- symfony/var-dumper: ^6.1
- vimeo/psalm: dev-master
This package is auto-updated.
Last update: 2024-08-27 01:21:28 UTC
README
此工具帮助开发者了解他们的代码受欢迎程度以及如何被使用。
它与 Prometheus 和 Grafana 一起收集 Github 数据,存储在 Prometheus 中,并使用 Grafana 创建可视化。您可以使用 Grafana 自定义收集的数据并创建满足您需求的仪表板。
仪表板
用法
要开始使用此包,您需要创建一个 Github API 令牌。一旦您有了它,您就可以开始收集指标数据。
# Gitgub API token GITHUB_TOKEN= # Github repositories to follow (comma separated) GITHUB_REPOSITORIES=
Docker
version: "3.7" services: twitter-metrics: image: ghcr.io/metrixio/github-public:latest environment: GITHUB_TOKEN: ... GITHUB_REPOSITORIES: ... restart: on-failure prometheus: image: prom/prometheus volumes: - ./runtime/prometheus:/prometheus restart: always grafana: image: grafana/grafana depends_on: - prometheus ports: - 3000:3000 volumes: - ./runtime/grafana:/var/lib/grafana restart: always
本地服务器
composer create-project metrixio/github-public
在 .env
文件中定义您想要跟踪的仓库
# Gitgub API token GITHUB_TOKEN=xxx # Github repositories to follow (comma separated) GITHUB_REPOSITORIES=spiral/framework,...
一旦项目安装和配置完成,您就可以开始应用程序服务器
./rr serve
指标将在 http://127.0.0.1:2112 上可用。
注意:要修复无法打开指标页面的问题,请将 RoadRunner 配置文件中的指标地址更改为
127.0.0.1:2112
。
此包使用了一些最好的 PHP 工具构建。它由Spiral 框架提供支持,使其非常快速和高效,并使用RoadRunner作为服务器,这是一个用于收集 Prometheus 指标数据的真正优秀工具。