Merge branch 'docs-aqualls-redis-exporter' into 'master'

Tone and style updates See merge request gitlab-org/gitlab!33884

Merge branch 'docs-aqualls-redis-exporter' into 'master'
Tone and style updates See merge request gitlab-org/gitlab!33884
f65a1ef3 · Craig Norris · 22cd1f4d · 1ff3c406 · f65a1ef3 · f65a1ef3
Commit f65a1ef3 authored Jun 04, 2020 by Craig Norris
2 changed files
--- a/doc/administration/monitoring/prometheus/postgres_exporter.md
+++ b/doc/administration/monitoring/prometheus/postgres_exporter.md
@@ -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:**
+   NOTE: **Note:**
-If PostgreSQL Server Exporter is configured on a separate node, make sure that the local
+   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
+   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.
+   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
+In most cases, PostgreSQL Server Exporter works with the defaults and you should not
-need to change anything.
+need to change anything. To further customize the PostgreSQL Server Exporter,
+use the following configuration options:
-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.
+   # The name of the database to connect to.
-   postgres_exporter['user'] = 'gitlab-psql'           # The user to sign in as.
+   postgres_exporter['dbname'] = 'pgbouncer'
-   postgres_exporter['password'] = ''                  # The user's password.
+   # The user to sign in as.
-   postgres_exporter['host'] = 'localhost'             # The host to connect to. Values that start with '/' are for unix domain sockets (default is 'localhost').
+   postgres_exporter['user'] = 'gitlab-psql'
-   postgres_exporter['port'] = 5432                    # The port to bind to (default is '5432').
+   # The user's password.
-   postgres_exporter['sslmode'] = 'require'            # Whether or not to use SSL. Valid options are:
+   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-ca' (always use SSL and verify that the certificate presented by
-                                                    #   '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).
+   #   the server was signed by a trusted CA),
-   postgres_exporter['fallback_application_name'] = '' # An application_name to fall back to if one isn't provided.
+   #   'verify-full' (always use SSL and verify that the certification presented
-   postgres_exporter['connect_timeout'] = ''           # Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
+   #   by the server was signed by a trusted CA and the server host name matches
-   postgres_exporter['sslcert'] = 'ssl.crt'            # Cert file location. The file must contain PEM encoded data.
+   #   the one in the certificate).
-   postgres_exporter['sslkey'] = 'ssl.key'             # Key file location. The file must contain PEM encoded data.
+   postgres_exporter['sslmode'] = 'require'
-   postgres_exporter['sslrootcert'] = 'ssl-root.crt'   # The location of the root certificate file. The file must contain PEM encoded data.
+   # 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.
+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)
--- a/doc/administration/monitoring/prometheus/redis_exporter.md
+++ b/doc/administration/monitoring/prometheus/redis_exporter.md
@@ -6,19 +6,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 # Redis exporter
->**Note:**
+The [Redis exporter](https://github.com/oliver006/redis_exporter) enables you to measure
-Available since [Omnibus GitLab 8.17](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/1118).
+various [Redis](https://redis.io) metrics. For more information on what is exported,
-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,
 [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. [Enable Prometheus](index.md#configuring-prometheus).
-1. Edit `/etc/gitlab/gitlab.rb`
+1. Edit `/etc/gitlab/gitlab.rb`.
-1. Add or find and uncomment the following line, making sure it's set to `true`:
+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
+Prometheus will now begin collecting performance data from
-the Redis exporter exposed under `localhost:9121`.
+the Redis exporter exposed at `localhost:9121`.
-[← Back to the main Prometheus page](index.md)