Author: Łukasz Gryglicki lgryglicki@cncf.io
This is a toolset to visualize GitHub archives using Grafana dashboards.
GHA2DB stands for GitHub Archives to DashBoards.
We want to create a toolset for visualizing various metrics for the Kubernetes community (and also for all CNCF projects).
Everything is open source so that it can be used by other CNCF and non-CNCF open source projects.
The only requirement is that project must be hosted on a public GitHub repository/repositories.
This toolset uses only Open Source tools: GitHub archives, git, Postgres databases, InfluxDB time-series databases and multiple Grafana instances. It is written in Go, and can be forked and installed by anyone.
Contributions and PRs are welcome. If you see a bug or want to add a new metric please create an issue and/or PR.
To work on this project locally please fork the original repository, and:
- Compiling and running on macOS.
- Compiling and running on Linux Ubuntu 16 LTS.
- Compiling and running on Linux Ubuntu 17.
- Compiling and running on FreeBSD.
Please see Development for local development guide.
For more detailed description of all environment variables, tools, switches etc, please see Usage.
We want to support all kind of metrics, including historical ones. Please see requested metrics to see what kind of metrics are needed. Many of them cannot be computed based on the data sources currently used.
There are some groups of repositories that are grouped together as a repository groups. They are defined in scripts/kubernetes/repo_groups.sql.
To setup default repository groups:
PG_PASS=pwd ./kubernetes/setup_repo_groups.sh.
This is a part of kubernetes/psql.sh script and kubernetes psql dump already has groups configured.
In an 'All' project (https://all.cncftest.io) repository groups are mapped to individual CNCF projects scripts/all/repo_groups.sql:
We also want to have per company statistics. To implement such metrics we need a mapping of developers and their employers.
There is a project that attempts to create such mapping cncf/gitdm.
DevStats has an import tool that fetches company affiliations from cncf/gitdm and allows to create per company metrics/statistics.
If you see errors in the company affiliations, please open a pull request on cncf/gitdm and the updates will be reflected on https://k8s.devstats.cncf.io a couple days after the PR has been accepted. Note that gitdm supports mapping based on dates, to account for developers moving between companies.
For architecture details please see architecture file.
Detailed usage is here
Please see metrics to see how to add new metrics.
To add new project follow adding new project instructions.
Please see dashboards to see list of already defined Grafana dashboards.
Please see exporting.
The servers to run devstats are generously provided by Packet bare metal hosting as part of CNCF's Community Infrastructure Lab.
- Use
GHA2DB_PROJECTS_OVERRIDE="+cncf,+all" IDB_HOST="localhost" IDB_PASS=pwd PG_PASS=pwd devstats. - Or add this command using
crontab -eto run every hour HH:10.
- Use:
PG_PASS=... PG_DB=allprj ./devel/activity.sh '1 month,,' > all.txt. - Example results here - all CNCF project activity during January 2018, excluding bots.