summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrien Kohlbecker <adrien.kohlbecker@gmail.com>2019-08-16 14:56:24 +0200
committerAdrien Kohlbecker <adrien.kohlbecker@gmail.com>2019-08-29 14:13:23 +0200
commitd6eca71766c22575da7cafc2f1302930085168de (patch)
tree9502c6b140ecbcb781be04da05e4f2b6ec01c887
parentce84140e8b878ce6e7c4d298c7202ff38170e3ac (diff)
downloadgitlab-ce-ak/rename-gitlab-monitor.tar.gz
Rename gitlab-monitor -> gitlab-exporterak/rename-gitlab-monitor
As part of https://gitlab.com/gitlab-org/gitlab-ce/issues/61704 we want to rename gitlab-monitor to gitlab-exporter, to be less confusing and better align with naming conventions in the community.
-rw-r--r--changelogs/unreleased/ak-rename-gitlab-monitor.yml5
-rw-r--r--doc/administration/geo/replication/high_availability.md2
-rw-r--r--doc/administration/high_availability/database.md2
-rw-r--r--doc/administration/high_availability/monitoring_node.md2
-rw-r--r--doc/administration/high_availability/redis.md2
-rw-r--r--doc/administration/monitoring/prometheus/gitlab_exporter.md (renamed from doc/administration/monitoring/prometheus/gitlab_monitor_exporter.md)12
-rw-r--r--doc/administration/monitoring/prometheus/index.md16
-rw-r--r--doc/development/architecture.md24
8 files changed, 35 insertions, 30 deletions
diff --git a/changelogs/unreleased/ak-rename-gitlab-monitor.yml b/changelogs/unreleased/ak-rename-gitlab-monitor.yml
new file mode 100644
index 00000000000..faf5f6c6918
--- /dev/null
+++ b/changelogs/unreleased/ak-rename-gitlab-monitor.yml
@@ -0,0 +1,5 @@
+---
+title: Update docs to reflect the rename of gitlab-monitor to gitlab-exporter
+merge_request: 31901
+author:
+type: other
diff --git a/doc/administration/geo/replication/high_availability.md b/doc/administration/geo/replication/high_availability.md
index c737fa37077..b55493f51cd 100644
--- a/doc/administration/geo/replication/high_availability.md
+++ b/doc/administration/geo/replication/high_availability.md
@@ -179,7 +179,7 @@ Configure the tracking database.
alertmanager['enable'] = false
consul['enable'] = false
gitaly['enable'] = false
- gitlab_monitor['enable'] = false
+ gitlab_exporter['enable'] = false
gitlab_workhorse['enable'] = false
nginx['enable'] = false
node_exporter['enable'] = false
diff --git a/doc/administration/high_availability/database.md b/doc/administration/high_availability/database.md
index 7c9e02d889e..e38cb8a6427 100644
--- a/doc/administration/high_availability/database.md
+++ b/doc/administration/high_availability/database.md
@@ -67,7 +67,7 @@ deploy the bundled PostgreSQL.
alertmanager['enable'] = false
pgbouncer_exporter['enable'] = false
redis_exporter['enable'] = false
- gitlab_monitor['enable'] = false
+ gitlab_exporter['enable'] = false
postgresql['listen_address'] = '0.0.0.0'
postgresql['port'] = 5432
diff --git a/doc/administration/high_availability/monitoring_node.md b/doc/administration/high_availability/monitoring_node.md
index b2750603c74..0b04e48f74a 100644
--- a/doc/administration/high_availability/monitoring_node.md
+++ b/doc/administration/high_availability/monitoring_node.md
@@ -53,7 +53,7 @@ Omnibus:
gitlab_rails['auto_migrate'] = false
alertmanager['enable'] = false
gitaly['enable'] = false
- gitlab_monitor['enable'] = false
+ gitlab_exporter['enable'] = false
gitlab_workhorse['enable'] = false
nginx['enable'] = true
postgres_exporter['enable'] = false
diff --git a/doc/administration/high_availability/redis.md b/doc/administration/high_availability/redis.md
index 1b79dde9476..c7f3d79e2b9 100644
--- a/doc/administration/high_availability/redis.md
+++ b/doc/administration/high_availability/redis.md
@@ -64,7 +64,7 @@ Omnibus:
prometheus['enable'] = false
alertmanager['enable'] = false
pgbouncer_exporter['enable'] = false
- gitlab_monitor['enable'] = false
+ gitlab_exporter['enable'] = false
gitaly['enable'] = false
redis['bind'] = '0.0.0.0'
diff --git a/doc/administration/monitoring/prometheus/gitlab_monitor_exporter.md b/doc/administration/monitoring/prometheus/gitlab_exporter.md
index 9aa4dfa5ab7..cfd9f55acc3 100644
--- a/doc/administration/monitoring/prometheus/gitlab_monitor_exporter.md
+++ b/doc/administration/monitoring/prometheus/gitlab_exporter.md
@@ -1,30 +1,30 @@
-# GitLab monitor exporter
+# GitLab exporter
>**Note:**
Available since [Omnibus GitLab 8.17][1132]. For installations from source
you'll have to install and configure it yourself.
-The [GitLab monitor exporter] allows you to measure various GitLab metrics, pulled from Redis and the database.
+The [GitLab exporter] allows you to measure various GitLab metrics, pulled from Redis and the database.
-To enable the GitLab monitor exporter:
+To enable the GitLab exporter:
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`:
```ruby
- gitlab_monitor['enable'] = true
+ gitlab_exporter['enable'] = true
```
1. Save the file and [reconfigure GitLab][reconfigure] for the changes to
take effect
Prometheus will now automatically begin collecting performance data from
-the GitLab monitor exporter exposed under `localhost:9168`.
+the GitLab exporter exposed under `localhost:9168`.
[← Back to the main Prometheus page](index.md)
[1132]: https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests/1132
-[GitLab monitor exporter]: https://gitlab.com/gitlab-org/gitlab-monitor
+[GitLab exporter]: https://gitlab.com/gitlab-org/gitlab-exporter
[prometheus]: https://prometheus.io
[reconfigure]: ../../restart_gitlab.md#omnibus-gitlab-reconfigure
diff --git a/doc/administration/monitoring/prometheus/index.md b/doc/administration/monitoring/prometheus/index.md
index c8968c51393..9228ebf4fed 100644
--- a/doc/administration/monitoring/prometheus/index.md
+++ b/doc/administration/monitoring/prometheus/index.md
@@ -97,9 +97,9 @@ To use an external Prometheus server:
1. Set each bundled service's [exporter](#bundled-software-metrics) to listen on a network address, for example:
```ruby
- gitlab_monitor['listen_address'] = '0.0.0.0'
+ gitlab_exporter['listen_address'] = '0.0.0.0'
sidekiq['listen_address'] = '0.0.0.0'
- gitlab_monitor['listen_port'] = '9168'
+ gitlab_exporter['listen_port'] = '9168'
node_exporter['listen_address'] = '0.0.0.0:9100'
redis_exporter['listen_address'] = '0.0.0.0:9121'
postgres_exporter['listen_address'] = '0.0.0.0:9187'
@@ -163,17 +163,17 @@ To use an external Prometheus server:
static_configs:
- targets:
- 1.1.1.1:8082
- - job_name: gitlab_monitor_database
+ - job_name: gitlab_exporter_database
metrics_path: "/database"
static_configs:
- targets:
- 1.1.1.1:9168
- - job_name: gitlab_monitor_sidekiq
+ - job_name: gitlab_exporter_sidekiq
metrics_path: "/sidekiq"
static_configs:
- targets:
- 1.1.1.1:9168
- - job_name: gitlab_monitor_process
+ - job_name: gitlab_exporter_process
metrics_path: "/process"
static_configs:
- targets:
@@ -263,11 +263,11 @@ The PgBouncer exporter allows you to measure various PgBouncer metrics.
[➔ Read more about the PgBouncer exporter.](pgbouncer_exporter.md)
-### GitLab monitor exporter
+### GitLab exporter
-The GitLab monitor exporter allows you to measure various GitLab metrics, pulled from Redis and the database.
+The GitLab exporter allows you to measure various GitLab metrics, pulled from Redis and the database.
-[➔ Read more about the GitLab monitor exporter.](gitlab_monitor_exporter.md)
+[➔ Read more about the GitLab exporter.](gitlab_exporter.md)
## Configuring Prometheus to monitor Kubernetes
diff --git a/doc/development/architecture.md b/doc/development/architecture.md
index 2adca2dae28..0c8ce1cf484 100644
--- a/doc/development/architecture.md
+++ b/doc/development/architecture.md
@@ -78,11 +78,11 @@ graph TB
PgBouncerExporter[PgBouncer Exporter] --> PgBouncer
Prometheus -- TCP 9187 --> PostgreSQLExporter
Prometheus -- TCP 9100 --> NodeExporter[Node Exporter]
- Prometheus -- TCP 9168 --> GitLabMonitor[GitLab Monitor]
+ Prometheus -- TCP 9168 --> GitLabExporter[GitLab Exporter]
Prometheus -- TCP 9127 --> PgBouncerExporter
- GitLabMonitor --> PostgreSQL
- GitLabMonitor --> GitLabShell
- GitLabMonitor --> Sidekiq
+ GitLabExporter --> PostgreSQL
+ GitLabExporter --> GitLabShell
+ GitLabExporter --> Sidekiq
PgBouncer --> Consul
PostgreSQL --> Consul
PgBouncer --> PostgreSQL
@@ -147,7 +147,7 @@ Component statuses are linked to configuration documentation for each component.
| [Redis Exporter](#redis-exporter) | Prometheus endpoint with Redis metrics | [✅][redis-exporter-omnibus] | [✅][redis-exporter-charts] | [✅][redis-exporter-charts] | [✅](https://about.gitlab.com/handbook/engineering/monitoring/) | ❌ | ❌ | CE & EE |
| [Postgres Exporter](#postgres-exporter) | Prometheus endpoint with PostgreSQL metrics | [✅][postgres-exporter-omnibus] | [✅][postgres-exporter-charts] | [✅][postgres-exporter-charts] | [✅](https://about.gitlab.com/handbook/engineering/monitoring/) | ❌ | ❌ | CE & EE |
| [PgBouncer Exporter](#pgbouncer-exporter) | Prometheus endpoint with PgBouncer metrics | [⚙][pgbouncer-exporter-omnibus] | [❌][pgbouncer-exporter-charts] | [❌][pgbouncer-exporter-charts] | [✅](https://about.gitlab.com/handbook/engineering/monitoring/) | ❌ | ❌ | CE & EE |
-| [GitLab Monitor](#gitlab-monitor) | Generates a variety of GitLab metrics | [✅][gitlab-monitor-omnibus] | [✅][gitlab-monitor-charts] | [✅][gitlab-monitor-charts] | [✅](https://about.gitlab.com/handbook/engineering/monitoring/) | ❌ | ❌ | CE & EE |
+| [GitLab Exporter](#gitlab-exporter) | Generates a variety of GitLab metrics | [✅][gitlab-exporter-omnibus] | [✅][gitlab-exporter-charts] | [✅][gitlab-exporter-charts] | [✅](https://about.gitlab.com/handbook/engineering/monitoring/) | ❌ | ❌ | CE & EE |
| [Node Exporter](#node-exporter) | Prometheus endpoint with system metrics | [✅][node-exporter-omnibus] | [❌][node-exporter-charts] | [❌][node-exporter-charts] | [✅](https://about.gitlab.com/handbook/engineering/monitoring/) | ❌ | ❌ | CE & EE |
| [Mattermost](#mattermost) | Open-source Slack alternative | [⚙][mattermost-omnibus] | [⤓][mattermost-charts] | [⤓][mattermost-charts] | [⤓](../user/project/integrations/mattermost.md) | ❌ | ❌ | CE & EE |
| [MinIO](#minio) | Object storage service | [⤓][minio-omnibus] | [✅][minio-charts] | [✅][minio-charts] | [✅](https://about.gitlab.com/handbook/engineering/infrastructure/production-architecture/#storage-architecture) | ❌ | [⚙][minio-gdk] | CE & EE |
@@ -228,14 +228,14 @@ Gitaly is a service designed by GitLab to remove our need for NFS for Git storag
- Configuration: [Omnibus][geo-omnibus], [Charts][geo-charts], [GDK][geo-gdk]
- Layer: Core Service (Processor)
-#### GitLab Monitor
+#### Gitlab Exporter
-- [Project page](https://gitlab.com/gitlab-org/gitlab-monitor)
-- Configuration: [Omnibus][gitlab-monitor-omnibus], [Charts][gitlab-monitor-charts]
+- [Project page](https://gitlab.com/gitlab-org/gitlab-exporter)
+- Configuration: [Omnibus][gitlab-exporter-omnibus], [Charts][gitlab-exporter-charts]
- Layer: Monitoring
-- Process: `gitlab-monitor`
+- Process: `gitlab-exporter`
-GitLab Monitor is a process designed in house that allows us to export metrics about GitLab application internals to Prometheus. You can read more [in the project's readme](https://gitlab.com/gitlab-org/gitlab-monitor).
+GitLab Exporter is a process designed in house that allows us to export metrics about GitLab application internals to Prometheus. You can read more [in the project's readme](https://gitlab.com/gitlab-org/gitlab-exporter).
#### GitLab Pages
@@ -684,8 +684,8 @@ We've also detailed [our architecture of GitLab.com](https://about.gitlab.com/ha
[postgres-exporter-charts]: https://github.com/helm/charts/tree/master/stable/postgresql
[pgbouncer-exporter-omnibus]: ../administration/monitoring/prometheus/pgbouncer_exporter.md
[pgbouncer-exporter-charts]: https://docs.gitlab.com/charts/installation/deployment.html#postgresql
-[gitlab-monitor-omnibus]: ../administration/monitoring/prometheus/gitlab_monitor_exporter.md
-[gitlab-monitor-charts]: https://docs.gitlab.com/charts/charts/gitlab/gitlab-monitor/index.html
+[gitlab-exporter-omnibus]: ../administration/monitoring/prometheus/gitlab_exporter.md
+[gitlab-exporter-charts]: https://docs.gitlab.com/charts/charts/gitlab/gitlab-exporter/index.html
[node-exporter-omnibus]: ../administration/monitoring/prometheus/node_exporter.md
[node-exporter-charts]: https://gitlab.com/charts/gitlab/issues/1332
[mattermost-omnibus]: https://docs.gitlab.com/omnibus/gitlab-mattermost/