Files
gitlab-foss/doc/administration/monitoring/prometheus/gitlab_exporter.md
2025-03-05 00:07:35 +00:00

2.1 KiB

stage, group, info, title
stage group info title
Systems Cloud Connector To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments GitLab exporter

{{< details >}}

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab Self-Managed

{{< /details >}}

Monitor your GitLab instance's performance metrics with GitLab exporter. For a Linux package installation, GitLab exporter takes metrics from Redis and the database and provides insights into bottlenecks, resource consumption patterns, and potential areas for optimization.

For self-compiled installations, you must install and configure it yourself.

Enable GitLab exporter

To enable the GitLab exporter in a Linux package instance:

  1. Enable Prometheus.

  2. Edit /etc/gitlab/gitlab.rb.

  3. Add, or find and uncomment, the following line, making sure it's set to true:

    gitlab_exporter['enable'] = true
    
  4. Save the file and reconfigure GitLab for the changes to take effect.

Prometheus automatically begins collecting performance data from the GitLab exporter exposed at localhost:9168.

Use a different Rack server

By default, the GitLab exporter runs on WEBrick, a single-threaded Ruby web server. You can choose a different Rack server that better matches your performance needs. For instance, in multi-node setups that contain a large number of Prometheus scrapers but only a few monitoring nodes, you may decide to run a multi-threaded server such as Puma instead.

To change the Rack server to Puma:

  1. Edit /etc/gitlab/gitlab.rb.

  2. Add, or find and uncomment, the following line, and set it to puma:

    gitlab_exporter['server_name'] = 'puma'
    
  3. Save the file and reconfigure GitLab for the changes to take effect.

The supported Rack servers are webrick and puma.