Skip to content

Commit f87a5b4

Browse files
committed
Add newlines to pgmonitor docs
1 parent 78a96b7 commit f87a5b4

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

docs/content/tutorial/monitoring.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,23 @@ draft: false
55
weight: 90
66
---
77

8-
While having [high availability]({{< relref "tutorial/high-availability.md" >}}) and [disaster recovery]({{< relref "tutorial/disaster-recovery.md" >}}) systems in place helps in the event of something going wrong with your PostgreSQL cluster, monitoring helps you anticipate problems before they happen. Additionally, monitoring can help you diagnose and resolve issues that may cause degraded performance rather than downtime.
8+
While having [high availability]({{< relref "tutorial/high-availability.md" >}}) and
9+
[disaster recovery]({{< relref "tutorial/disaster-recovery.md" >}}) systems in place helps in the
10+
event of something going wrong with your PostgreSQL cluster, monitoring helps you anticipate
11+
problems before they happen. Additionally, monitoring can help you diagnose and resolve issues that
12+
may cause degraded performance rather than downtime.
913

1014
Let's look at how PGO allows you to enable monitoring in your cluster.
1115

1216
## Adding the Exporter Sidecar
1317

14-
Let's look at how we can add the Crunchy PostgreSQL Exporter sidecar to your cluster using the `kustomize/postgres` example in the [Postgres Operator examples](https://github.com/CrunchyData/postgres-operator-examples/fork) repository.
18+
Let's look at how we can add the Crunchy PostgreSQL Exporter sidecar to your cluster using the
19+
`kustomize/postgres` example in the [Postgres Operator examples] repository.
1520

16-
Monitoring tools are added using the `spec.monitoring` section of the custom resource. Currently, the only monitoring tool supported is the Crunchy PostgreSQL Exporter configured with [pgMonitor].
21+
Monitoring tools are added using the `spec.monitoring` section of the custom resource. Currently,
22+
the only monitoring tool supported is the Crunchy PostgreSQL Exporter configured with [pgMonitor].
1723

18-
The only required attribute for adding the Exporter sidecar is to set `spec.monitoring.pgmonitor.exporter.image`. In the `kustomize/postgres/postgres.yaml` file, add the following YAML to the spec:
24+
In the `kustomize/postgres/postgres.yaml` file, add the following YAML to the spec:
1925

2026
```
2127
monitoring:
@@ -30,11 +36,17 @@ Save your changes and run:
3036
kubectl apply -k kustomize/postgres
3137
```
3238

33-
PGO will detect the change and add the Exporter sidecar to all Postgres Pods that exist in your cluster. PGO will also do the work to allow the Exporter to connect to the database and gather metrics that can be accessed using the [PGO Monitoring] stack.
39+
PGO will detect the change and add the Exporter sidecar to all Postgres Pods that exist in your
40+
cluster. PGO will also do the work to allow the Exporter to connect to the database and gather
41+
metrics that can be accessed using the [PGO Monitoring] stack.
42+
3443

3544
## Accessing the Metrics
3645

37-
Once the Crunchy PostgreSQL Exporter has been enabled in your cluster, follow the steps outlined in [PGO Monitoring] to install the monitoring stack. This will allow you to deploy a [pgMonitor] configuration of [Prometheus], [Grafana], and [Alertmanager] monitoring tools in Kubernetes. These tools will be set up by default to connect to the Exporter containers on your Postgres Pods.
46+
Once the Crunchy PostgreSQL Exporter has been enabled in your cluster, follow the steps outlined in
47+
[PGO Monitoring] to install the monitoring stack. This will allow you to deploy a [pgMonitor]
48+
configuration of [Prometheus], [Grafana], and [Alertmanager] monitoring tools in Kubernetes. These
49+
tools will be set up by default to connect to the Exporter containers on your Postgres Pods.
3850

3951
## Next Steps
4052

@@ -45,3 +57,4 @@ Now that we can monitor our cluster, let's explore how [connection pooling]({{<
4557
[Prometheus]: https://prometheus.io/
4658
[Alertmanager]: https://prometheus.io/docs/alerting/latest/alertmanager/
4759
[PGO Monitoring]: {{< relref "installation/monitoring/_index.md" >}}
60+
[Postgres Operator examples]: https://github.com/CrunchyData/postgres-operator-examples/fork

0 commit comments

Comments
 (0)