2020-05-07 17:09:26 -04:00
---
stage: Monitor
2021-03-18 11:09:04 -04:00
group: Monitor
2020-11-26 01:09:20 -05:00
info: 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
2020-05-07 17:09:26 -04:00
---
2021-01-28 01:08:59 -05:00
# GitLab exporter **(FREE SELF)**
2017-02-08 09:44:56 -05:00
2020-02-06 10:09:11 -05:00
>- Available since [Omnibus GitLab 8.17 ](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/1132 ).
>- Renamed from `GitLab monitor exporter` to `GitLab exporter` in [GitLab 12.3 ](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16511 ).
2017-02-08 09:44:56 -05:00
2020-07-02 20:09:23 -04:00
The [GitLab exporter ](https://gitlab.com/gitlab-org/gitlab-exporter ) enables you to
measure various GitLab metrics pulled from Redis and the database in Omnibus GitLab
2019-10-11 02:06:27 -04:00
instances.
2017-02-08 09:44:56 -05:00
2020-07-02 20:09:23 -04:00
For installations from source you must install and configure it yourself.
2019-10-11 02:06:27 -04:00
To enable the GitLab exporter in an Omnibus GitLab instance:
2017-02-08 09:44:56 -05:00
2020-07-02 20:09:23 -04:00
1. [Enable Prometheus ](index.md#configuring-prometheus ).
1. Edit `/etc/gitlab/gitlab.rb` .
1. Add, or find and uncomment, the following line, making sure it's set to `true` :
2017-02-08 09:44:56 -05:00
2019-07-10 14:23:55 -04:00
```ruby
2019-09-18 10:02:45 -04:00
gitlab_exporter['enable'] = true
2019-07-10 14:23:55 -04:00
```
2017-02-08 09:44:56 -05:00
2019-10-11 02:06:27 -04:00
1. Save the file and [reconfigure GitLab ](../../restart_gitlab.md#omnibus-gitlab-reconfigure )
2020-07-02 20:09:23 -04:00
for the changes to take effect.
2017-02-08 09:44:56 -05:00
2020-07-02 20:09:23 -04:00
Prometheus automatically begins collecting performance data from
the GitLab exporter exposed at `localhost:9168` .
2021-01-19 04:10:32 -05:00
## Use a different Rack server
>- Introduced in [Omnibus GitLab 13.8 ](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/4896 ).
>- WEBrick is now the default Rack server instead of Puma.
By default, the GitLab exporter runs on [WEBrick ](https://github.com/ruby/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` .
1. Add, or find and uncomment, the following line, and set it to `puma` :
```ruby
gitlab_exporter['server_name'] = 'puma'
```
1. Save the file and [reconfigure GitLab ](../../restart_gitlab.md#omnibus-gitlab-reconfigure )
for the changes to take effect.
The supported Rack servers are `webrick` and `puma` .