Skip to main content
Version: v0.15

Configuring GitLab

Visit config-ui: http://localhost:4000.

Step 1 - Add Data Connections​

gitlab-add-data-connections

Connection Name​

Name your connection.

Endpoint URL​

This should be a valid REST API endpoint.

  • If you are using gitlab.com, the endpoint will be https://gitlab.com/api/v4/
  • If you are self-hosting GitLab, the endpoint will look like https://gitlab.example.com/api/v4/ The endpoint URL should end with /.

Auth Token(s)​

GitLab personal access tokens are required to add a connection. Learn about how to create a GitLab personal access token.

GitLab personal access tokens​

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.

  1. Go to the Project information -> Members page of the GitLab projects you wish to collect.
  2. Check your role in this project from the Max role column. Make sure you are not the Guest role, otherwise, you will not be able to collect data from this project.

Proxy URL (Optional)​

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

Fixed Rate Limit (Optional)​

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.

Test and Save Connection​

Click Test Connection, if the connection is successful, click Save Connection to add the connection.

Step 2 - Setting Data Scope​

gitlab-set-data-scope

Projects​

Choose the Gitlab projects to collect. Limited by GitLab API, You need to type more than 2 characters to search.

  • If you want to collect public repositories in GitLab, please uncheck "Only search my repositories" to search all repositories.

Data Entities​

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.

  • Issue Tracking: GitLab issues, issue comments, issue labels, etc.
  • Source Code Management: GitLab repos, refs, commits, etc.
  • Code Review: GitLab MRs, MR comments and reviews, etc.
  • CI/CD: GitLab pipelines, jobs, etc.
  • Cross Domain: GitLab accounts, etc.

Step 3 - Adding Transformation Rules (Optional)​

CI/CD​

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:

  • Deployment: A GitLab CI job with a name that matches the given regEx will be considered as a deployment.
  • Production: A GitLab CI job with a name that matches the given regEx will be considered a job in the production environment.

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.

Step 4 - Setting Sync Frequency​

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.

Troubleshooting​

If you run into any problem, please check the Troubleshooting or create an issue