debian-mirror-gitlab/doc/administration/monitoring/prometheus/gitlab_exporter.md

stage	group	info
Monitor	Health	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

GitLab exporter (FREE SELF)

• Available since Omnibus GitLab 8.17.
• Renamed from GitLab monitor exporter to GitLab exporter in GitLab 12.3.

The GitLab exporter enables you to measure various GitLab metrics pulled from Redis and the database in Omnibus GitLab instances.

For installations from source you must install and configure it yourself.

To enable the GitLab exporter in an Omnibus GitLab 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

• Introduced in Omnibus GitLab 13.8.
• WEBrick is now the default Rack server instead of Puma.

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.