Skip to content

G
gitlab-ce
Commit 1ff3c406 authored by Amy Qualls's avatar Amy Qualls
Browse files
Options

Tone and style updates 

Update two of the exporter pages for tone and style. Remove mentions
of outdated versions of GitLab. Shift the comments on a code block
to separate lines, rather than the end of each line, for legibility.
parent 0a180d2d
Hide whitespace changes
Inline Side-by-side
Showing with 52 additions and 43 deletions
doc/administration/monitoring/prometheus/postgres_exporter.md
View file @ 1ff3c406
......@@ -6,12 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# PostgreSQL Server Exporter
>**Note:**
Available since [Omnibus GitLab 8.17](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/1131).
For installations from source you will have to install and configure it yourself.
The [PostgreSQL Server Exporter](https://github.com/wrouesnel/postgres_exporter) allows you to export various PostgreSQL metrics.
NOTE: **Note:**
For installations from source you will have to install and configure it yourself.
To enable the PostgreSQL Server Exporter:
1. [Enable Prometheus](index.md#configuring-prometheus).
......@@ -21,10 +20,10 @@ To enable the PostgreSQL Server Exporter:
postgres_exporter['enable'] = true
```
NOTE: **Note:**
If PostgreSQL Server Exporter is configured on a separate node, make sure that the local
address is [listed in `trust_auth_cidr_addresses`](../../high_availability/database.md#network-information) or the
exporter will not be able to connect to the database.
NOTE: **Note:**
If PostgreSQL Server Exporter is configured on a separate node, make sure the local
address is [listed in `trust_auth_cidr_addresses`](../../high_availability/database.md#network-information), or the
exporter can't connect to the database.
1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to
take effect.
......@@ -34,31 +33,44 @@ the PostgreSQL Server Exporter exposed under `localhost:9187`.
## Advanced configuration
In most cases, PostgreSQL Server Exporter will work with the defaults and you should not
need to change anything.
To further customize the PostgreSQL Server Exporter, use the following configuration options:
In most cases, PostgreSQL Server Exporter works with the defaults and you should not
need to change anything. To further customize the PostgreSQL Server Exporter,
use the following configuration options:
1. Edit `/etc/gitlab/gitlab.rb`:
```ruby
postgres_exporter['dbname'] = 'pgbouncer' # The name of the database to connect to.
postgres_exporter['user'] = 'gitlab-psql' # The user to sign in as.
postgres_exporter['password'] = '' # The user's password.
postgres_exporter['host'] = 'localhost' # The host to connect to. Values that start with '/' are for unix domain sockets (default is 'localhost').
postgres_exporter['port'] = 5432 # The port to bind to (default is '5432').
postgres_exporter['sslmode'] = 'require' # Whether or not to use SSL. Valid options are:
# 'disable' (no SSL),
# 'require' (always use SSL and skip verification, this is the default value),
# 'verify-ca' (always use SSL and verify that the certificate presented by the server was signed by a trusted CA),
# 'verify-full' (always use SSL and verify that the certification presented by the server was signed by a trusted CA and the server host name matches the one in the certificate).
postgres_exporter['fallback_application_name'] = '' # An application_name to fall back to if one isn't provided.
postgres_exporter['connect_timeout'] = '' # Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
postgres_exporter['sslcert'] = 'ssl.crt' # Cert file location. The file must contain PEM encoded data.
postgres_exporter['sslkey'] = 'ssl.key' # Key file location. The file must contain PEM encoded data.
postgres_exporter['sslrootcert'] = 'ssl-root.crt' # The location of the root certificate file. The file must contain PEM encoded data.
# The name of the database to connect to.
postgres_exporter['dbname'] = 'pgbouncer'
# The user to sign in as.
postgres_exporter['user'] = 'gitlab-psql'
# The user's password.
postgres_exporter['password'] = ''
# The host to connect to. Values that start with '/' are for unix domain sockets
# (default is 'localhost').
postgres_exporter['host'] = 'localhost'
# The port to bind to (default is '5432').
postgres_exporter['port'] = 5432
# Whether or not to use SSL. Valid options are:
# 'disable' (no SSL),
# 'require' (always use SSL and skip verification, this is the default value),
# 'verify-ca' (always use SSL and verify that the certificate presented by
# the server was signed by a trusted CA),
# 'verify-full' (always use SSL and verify that the certification presented
# by the server was signed by a trusted CA and the server host name matches
# the one in the certificate).
postgres_exporter['sslmode'] = 'require'
# An application_name to fall back to if one isn't provided.
postgres_exporter['fallback_application_name'] = ''
# Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
postgres_exporter['connect_timeout'] = ''
# Cert file location. The file must contain PEM encoded data.
postgres_exporter['sslcert'] = 'ssl.crt'
# Key file location. The file must contain PEM encoded data.
postgres_exporter['sslkey'] = 'ssl.key'
# The location of the root certificate file. The file must contain PEM encoded data.
postgres_exporter['sslrootcert'] = 'ssl-root.crt'
```
1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
[← Back to the main Prometheus page](index.md)
1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect.
doc/administration/monitoring/prometheus/redis_exporter.md
View file @ 1ff3c406
......@@ -6,19 +6,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Redis exporter
>**Note:**
Available since [Omnibus GitLab 8.17](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/1118).
For installations from source you'll have to install and configure it yourself.
The [Redis exporter](https://github.com/oliver006/redis_exporter) allows you to measure
various [Redis](https://redis.io) metrics. For more information on what's exported,
The [Redis exporter](https://github.com/oliver006/redis_exporter) enables you to measure
various [Redis](https://redis.io) metrics. For more information on what is exported,
[read the upstream documentation](https://github.com/oliver006/redis_exporter/blob/master/README.md#whats-exported).
NOTE: **Note:**
For installations from source you'll have to install and configure it yourself.
To enable the Redis 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`:
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
redis_exporter['enable'] = true
......@@ -27,7 +26,5 @@ To enable the Redis exporter:
1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure)
for the changes to take effect.
Prometheus will now automatically begin collecting performance data from
the Redis exporter exposed under `localhost:9121`.
[← Back to the main Prometheus page](index.md)
Prometheus will now begin collecting performance data from
the Redis exporter exposed at `localhost:9121`.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7