GitLab

·

Collect GitLab operation data and report it to TrueWatch in the form of metrics.

Configuration¶

Collector Configuration¶

First, you need to open the data collection function of GitLab service and set the white list. See the following sections for specific operations.

After the GitLab setup is complete, configure the DataKit. Note that the data collected may vary depending on the GitLab version and configuration.

[[inputs.gitlab]]
    ## set true if you need to collect metric from url below
    enable_collect = true

    ## param type: string - default: http://127.0.0.1:80/-/metrics
    prometheus_url = "http://127.0.0.1:80/-/metrics"

    ## param type: string - optional: time units are "ms", "s", "m", "h" - default: 10s
    interval = "10s"

    ## datakit can listen to gitlab ci data at /v1/gitlab when enabled
    enable_ci_visibility = true

    ## Set true to enable election
    election = true

    ## Bearer token file for authentication
    bearer_token_file = ""

    ## HTTP headers
    [inputs.gitlab.http_headers]
    # X-Custom-Header = "custom-value"

    ## TLS configuration
    # tls_ca = "/path/to/ca.pem"
    # tls_cert = "/path/to/cert.pem"
    # tls_key = "/path/to/key.pem"
    # insecure_skip_verify = false

    ## extra tags for gitlab-ci data.
    ## these tags will not overwrite existing tags.
    [inputs.gitlab.ci_extra_tags]
    # some_tag = "some_value"
    # more_tag = "some_other_value"

    ## extra tags for gitlab metrics
    [inputs.gitlab.tags]
    # some_tag = "some_value"
    # more_tag = "some_other_value"

GitLab Turns on Data Collection¶

GitLab needs to turn on the Prometheus data collection function as follows (taking English page as an example):

• Log in to your GitLab page as an administrator account
• Go to Admin Area > Settings > Metrics and profiling
• Select Metrics - Prometheus, click Enable Prometheus Metrics and save change
• Restart the GitLab service

See official configuration doc.

Configure Data Access Whitelist¶

It is not enough to turn on the data collection function. GitLab is very strict with data management, so it is necessary to configure the white list on the access side. The opening mode is as follows:

• Modify the GitLab configuration file /etc/gitlab/gitlab.rb, find gitlab_rails['monitoring_whitelist'] = ['::1/128'] and add the access IP of the DataKit to the array (typically the IP of the host where the DataKit resides, if the GitLab is running in a container, depending on the actual situation)
• Restart the GitLab service

See official configuration doc.

Turn on GitLab CI Visualization¶

By configuring GitLab Webhook, GitLab CI visualization can be achieved. On DataKit, the default URL for receiving GitLab Webhook is http://DataKit-IP:9529/v1/gitlab.

In the left sidebar of GitLab, go to Settings ➔ Webhooks, configure the URL as the address above, check the Job events and Pipeline events options in Trigger configuration, and click Add webhook to confirm addition.

Metric¶

For all of the following data collections, the global election tags will added automatically, we can add extra tags in [inputs.gitlab.tags] if needed:

 [inputs.gitlab.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...

We can specify additional tags for Gitlab CI data in the configuration by [inputs.gitlab.ci_extra_tags]:

 [inputs.gitlab.ci_extra_tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...

Note: To ensure that GitLab CI functions properly, the extra tags specified for GitLab CI data do not overwrite tags already in its data (see below for a list of GitLab CI tags).

gitlab¶

GitLab runtime metrics

gitlab_base¶

GitLab programming language level metrics

gitlab_http¶

GitLab HTTP metrics

Logging¶

gitlab_pipeline¶

GitLab Pipeline event metrics

gitlab_job¶

GitLab Job Event metrics