TODO List:
- Project config generator
- More organizations domain
- Custom dashboard for missing visualizations
A collection of useful settings and scripts for SkyWalking stakeholders to setup CHAOSS GrimoireLab in seconds.
Collects Git, GitHub data from 30 SkyWalking Ecosystem projects(please open a PR if more projects come in).
Apache Official | SkyAPM | Others |
---|---|---|
skywalking | SkyAPM-dotnet | sourceplusplus-SourceMarker |
skywalking-rocketbot-ui | SkyAPM-go2sky | |
skywalking-website | SkyAPM-go2sky-plugins | |
skywalking-nginx-lua | SkyAPM-php-sdk | |
skywalking-kong | SkyAPM-cpp2sky | |
skywalking-python | SkyAPM-java-plugin-extensions | |
skywalking-nodejs | SkyAPM-uranus | |
skywalking-client-js | SkyAPM-nodejs | |
skywalking-rust | SkyAPM-mini-program-monitor | |
skywalking-satellite | ||
skywalking-cli | ||
skywalking-kubernetes | ||
skywalking-swck | ||
skywalking-docker | ||
skywalking-data-collect-protocol | ||
skywalking-query-protocol | ||
skywalking-goapi | ||
skywalking-agent-test-tool | ||
skywalking-infra-e2e | ||
skywalking-eyes | ||
skywalking-java | ||
skywalking-banyandb | ||
skywalking-showcase |
For the SkyWalking ecosystem, major data sources are
- Git for commit logs - timezone, code, developer
- GitHub for
- GitHub repo metadata - star, fork, watcher
- GitHub PRs - efficiency, timing, backlog
- GitHub Issues - efficiency, backlog, timing
- GitHub comments - collaboration network, count,
- GitHub events - issue labels
- mail list (RSS) - sentiment analysis, count
- IRC channels - Slack + QQ - nlp task, count
- Social media - Twitter - social impact
- Q&A platforms - StackExchange - user generated data
From the above data sources, we can conduct quantitative and qualitative analysis.
Note the affliation analysis is based on a email domains, which wrongly identifies qq.com and vip.qq.com
as Tencent employees.
So the provided version removes this chunk from organizations.json in default-grimoirelab-settings
.
"Tencent": [
{
"domain": "qq.com",
"is_top": true
},
{
"domain": "vip.qq.com",
"is_top": true
}
],
Example Screenshot from Dashboard -
-
Download the latest release from GrimoireLab repository, unzip/untar.
-
Copy the
projects.json
to thedefault-grimoirelab-settings
folder. -
You may wish to set more than one GitHub access token in
setup.cfg
given hourly GitHub API limits. -
You will need to increase the
max_map_count
for Elasticsearch before bringing up the ES container, else it will fail.
WSL2 on Windows machine-
wsl ^
sudo sysctl -w vm.max_map_count=262144
Linux
sudo sysctl -w vm.max_map_count=262144
MacOS
$ screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
(then run:) sysctl -w vm.max_map_count=262144
- Start the docker containers
docker-compose up -d
- After the initialization step, go to
localhost:5601
to view the kibana dashboard of GrimoireLab.
Note the data will not appear in a short time if your access to GitHub is slow/ unstable, try to use FastGitHub to accelerate the process, else it could take you hours before the projects are fully collected.