Visit Config UI: http://localhost:4000
.
Give your connection a unique name to help you identify it in the future.
Select if you use GitLab Cloud or GitLab Server (v11+).
This should be a valid REST API endpoint.
https://gitlab.com/api/v4/
.https://gitlab.example.com/api/v4/
. Please note: the endpoint URL should end with /
.Your GitLab personal access token (PAT) is required to add a connection. Learn about how to create a GitLab personal access token.
At least one of the following permissions is required to collect data from repositories:
api
read_api
You also have to double-check your GitLab user permission settings.
If you are behind a corporate firewall or VPN you may need to utilize a proxy server. Enter a valid proxy server address on your network, e.g. http://your-proxy-server.com:1080
DevLake uses a dynamic rate limit at around 12,000 requests/hour to collect GitLab data. You can adjust the rate limit if you want to increase or lower the speed.
The maximum rate limit for GitLab Cloud is ** 120,000 requests/hour**. Tokens under the same IP address share the rate limit, so the actual rate limit for your token will be lower than this number.
For self-managed GitLab rate limiting, please contact your GitLab admin to get or set the maximum rate limit of your GitLab instance. Please do not use a rate that exceeds this number.
Click Test Connection
, if the connection is successful, click Save Connection
to add the connection.
Choose the GitLab projects to collect. Limited by GitLab API, You need to type more than 2 characters to search.
Usually, you don‘t have to modify this part. However, if you don’t want to collect certain GitLab entities, you can unselect some entities to accerlerate the collection speed.
This set of configurations is used for calculating DORA metrics.
If you're using GitLab CI to conduct deployments
, please select “Detect Deployment from Jobs in GitLab CI”, and input the RegEx in the following fields:
By the above two fields, DevLake can identify a production deployment among massive CI jobs.
You can also select “Not using Jobs in GitLab CI as Deployments” if you're not using GitLab CI to conduct deployments.
You can choose how often you would like to sync your data in this step by selecting a sync frequency option or enter a cron code to specify your prefered schedule.
If you run into any problem, please check the Troubleshooting or create an issue