| commit | b591ea56de97abfa6171c13eeed38ecdf932bb9a | [log] [tgz] |
|---|---|---|
| author | Startrekzky <louis.s4372121@gmail.com> | Mon Sep 13 13:48:11 2021 +0800 |
| committer | Startrekzky <louis.s4372121@gmail.com> | Mon Sep 13 14:16:24 2021 +0800 |
| tree | 58256c80ee78d18fa8c5a22213d60ee675924b8f | |
| parent | 2001530945688e04028d34ede9edb55b62b222dd [diff] |
feat(grafana dashboard): add PR review rounds 1.add charts PR review rounds 2.change the calculation method of PR review time 3.updated the icons
Dev Lake is the one-stop solution that integrates, analyzes, and visualizes software development data throughout the software development life cycle (SDLC) for engineering teams.
| Section | Description | Documentation Link |
|---|---|---|
| Data Sources | Links to specific plugin usage & details | View Section |
| Grafana | How to visualize the data | View Section |
| Requirements | Underlying software used | View Section |
| Setup | Steps to setup the project | View Section |
| Migrations | Commands for running migrations | View Section |
| Tests | Commands for running tests | View Section |
| ⚠️ (WIP) Build a Plugin | Details on how to make your own | Link |
| ⚠️ (WIP) Add Plugin Metrics | Guide to adding plugin metrics | Link |
| Contributing | How to contribute to this repo | Link |
Below is a list of data source plugins used to collect & enrich data from specific sources. Each have a README.md file with basic setup, troubleshooting and metrics info.
For more information on building a new data source plugin see Build a Plugin.
| Section | Section Info | Docs |
|---|---|---|
| Jira | Metrics, Generating API Token, Find Project/Board ID | Link |
| Gitlab | Metrics, Generating API Token | Link |
| Jenkins | Metrics | Link |
We use Grafana as a visualization tool to build charts for the data stored in our database. Using SQL queries we can add panels to build, save, and edit customized dashboards.
All the details on provisioning, and customizing a dashboard can be found in the Grafana Doc
sudo apt-get install build-essentialNOTE: If you only plan to run the product, this is the only section you should need NOTE: Commands written like this are to be run in your terminal
NOTE: After installing docker, you may need to run the docker application and restart your terminal
Create a directory and download files
git clone https://github.com/merico-dev/lake.git devlake cd devlake git checkout go-main cp .env.example .env
Open .env file with your editor, fill the values in Jira, Gitlab and Jenkins sections with your deployments.
For more info on how to configure plugins, please refer to the data source plugins section
Launch docker-compose
docker-compose up
Create a http request to trigger data collect tasks, please replace your gitlab projectId and jira boardId in the request body. This can take up to 20 minutes for large projects. (gitlab 10k+ commits or jira 5k+ issues)
curl -XPOST 'http://localhost:8080/task' \ -H 'Content-Type: application/json' \ -d '[ { "plugin": "gitlab", "options": { "projectId": 8967944 } }, { "plugin": "jira", "options": { "boardId": 8 } }, { "plugin": "jenkins", "options": {} } ]'
Navigate to grafana dashboard http://localhost:3002 (username: admin, password: admin).
Commonly, we have requirement to synchorize data periodly. We providered a tool called lake-cli to meet that requirement. Check lake-cli usage at here.
Otherwise, if you just want to use the cron job, please check docker-compose version at here
Navigate to where you would like to install this project and clone the repository
git clone https://github.com/merico-dev/lake.git cd lake
Install go packages
make install
Copy sample config files to new local file
cp .env.example .env
Start the docker containers
Make sure the docker application is running before this step
make compose
Run the project
make dev
You can now post to /task to create a jira task. This will collect data from Jira
curl -XPOST 'localhost:8080/task' \
-H 'Content-Type: application/json' \
-d '[{
"plugin": "jira",
"options": {
"boardId": 8
}
}]'
Collect & enrich data from selected sources and plugins
These plugins can be selected from the above list (View List), and options for them will be outlined in their specific document.
Example:
curl -XPOST 'localhost:8080/source' \ -H 'Content-Type: application/json' \ -d '[{ "plugin": "Jira", "options": {} }]'
Visualize the data in the Grafana Dashboard
From here you can see existing data visualized from collected & enriched data
admin, password: admin)lake<><><>Sample tests can be found in /test/example
To run the tests: make test
Message us on Discord