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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

56 lines
2.1 KiB
Markdown
Raw Normal View History

2020-05-24 23:13:21 +05:30
---
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2021-02-22 17:27:13 +05:30
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-24 23:13:21 +05:30
---
2021-03-11 19:13:27 +05:30
# GitLab exporter **(FREE SELF)**
2017-08-17 22:00:37 +05:30
2021-11-11 11:23:49 +05:30
> Renamed from `GitLab monitor exporter` to `GitLab exporter` in [GitLab 12.3](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16511).
2017-08-17 22:00:37 +05:30
2020-07-28 23:09:34 +05:30
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-12-21 20:55:43 +05:30
instances.
2017-08-17 22:00:37 +05:30
2020-07-28 23:09:34 +05:30
For installations from source you must install and configure it yourself.
2019-12-21 20:55:43 +05:30
To enable the GitLab exporter in an Omnibus GitLab instance:
2017-08-17 22:00:37 +05:30
2020-07-28 23:09:34 +05:30
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-08-17 22:00:37 +05:30
2019-09-30 21:07:59 +05:30
```ruby
2019-12-04 20:38:33 +05:30
gitlab_exporter['enable'] = true
2019-09-30 21:07:59 +05:30
```
2017-08-17 22:00:37 +05:30
2019-12-21 20:55:43 +05:30
1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure)
2020-07-28 23:09:34 +05:30
for the changes to take effect.
2017-08-17 22:00:37 +05:30
2020-07-28 23:09:34 +05:30
Prometheus automatically begins collecting performance data from
the GitLab exporter exposed at `localhost:9168`.
2021-03-08 18:12:59 +05:30
## Use a different Rack server
2021-11-11 11:23:49 +05:30
> - 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.
2021-03-08 18:12:59 +05:30
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`.