TODO List:

1. Project config generator
2. More organizations domain
3. 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).

For the SkyWalking ecosystem, major data sources are

1. Git for commit logs - timezone, code, developer
2. 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
3. mail list (RSS) - sentiment analysis, count
4. IRC channels - Slack + QQ - nlp task, count
5. Social media - Twitter - social impact
6. Q&A platforms - StackExchange - user generated data

From the above data sources, we can conduct quantitative and qualitative analysis.

CHAOSS Metrics

GrimoireLab

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 -

1. Download the latest release from GrimoireLab repository, unzip/untar.

2. Copy the projects.json to the default-grimoirelab-settings folder.

3. You may wish to set more than one GitHub access token in setup.cfg given hourly GitHub API limits.

4. 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

5. Start the docker containers

docker-compose up -d

6. 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.