Skip to content

Latest commit

 

History

History
 
 

README.md

Gitlab Integration

Overview

Integration that allows to:

  • Visualize and monitor metrics collected via Gitlab through Prometheus

See the Gitlab documentation for more information about Gitlab and its integration with Prometheus

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The Gitlab check is included in the Datadog Agent package, so you don't need to install anything else on your Gitlab servers.

Configuration

Edit the gitlab.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory, to point to the Gitlab's Prometheus metrics endpoint. See the sample gitlab.d/conf.yaml for all available configuration options.

Note: The allowed_metrics item in the init_config section allows to specify the metrics that should be extracted.

Log collection

Available for Agent >6.0

  1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

      logs_enabled: true
  2. Next, edit gitlab.d/conf.yaml by uncommenting the logs lines at the bottom. Update the logs path with the correct path to your Gitlab log files.

      logs:
        - type: file
          path: /var/log/gitlab/gitlab-rails/production_json.log
          service: <SERVICE_NAME>
          source: gitlab
        - type: file
          path: /var/log/gitlab/gitlab-rails/production.log
          service: <SERVICE_NAME>
          source: gitlab
        - type: file
          path: /var/log/gitlab/gitlab-rails/api_json.log
          service: <SERVICE_NAME>
          source: gitlab
    
  3. Restart the Agent.

Validation

Run the Agent's status subcommand and look for gitlab under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Events

The Gitlab check does not include any events.

Service Checks

The Gitlab check includes a readiness and a liveness service check. Moreover, it provides a service check to ensure that the local Prometheus endpoint is available.

Troubleshooting

Need help? Contact Datadog support.