Skip to content

Commit 4841980

Browse files
committed
[-] rewrite "Custom installation" tutorial, fixes #602
1 parent 68ac020 commit 4841980

File tree

6 files changed

+252
-240
lines changed

6 files changed

+252
-240
lines changed

docs/concept/components.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: Components
33
---
44

5+
6+
## Component diagram
7+
58
The main development idea around pgwatch was to do the minimal work
69
needed and not to reinvent the wheel - meaning that pgwatch is mostly
710
just about gluing together already some proven pieces of software for
@@ -11,6 +14,14 @@ pgwatch metrics collector. Note that most components are not mandatory
1114
and for tasks like metrics storage there are many components to choose
1215
from.
1316

17+
[![pgwatch typical deployment architecture diagram](../gallery/pgwatch_architecture.jpg)](../gallery/pgwatch_architecture.jpg)
18+
19+
All components are *loosely coupled*, thus for non-pgwatch components
20+
(pgwatch components are only the metrics collector)
21+
you can decide to make use of an already existing installation of
22+
Postgres, Grafana or Prometheus and run additionally just the pgwatch
23+
collector.
24+
1425
## The metrics gathering daemon
1526

1627
The metrics collector, written in Go, is the only mandatory and most
@@ -89,12 +100,3 @@ always want to customize some aspects though, so it's not meant as a
89100
one-size-fits-all solution. Also as metrics are stored in a DB, they can
90101
be visualized or processed in any other way.
91102

92-
## Component diagram
93-
94-
[![pgwatch typical deployment architecture diagram](../gallery/pgwatch_architecture.jpg)](../gallery/pgwatch_architecture.jpg)
95-
96-
All components are *loosely coupled*, thus for non-pgwatch components
97-
(pgwatch components are only the metrics collector)
98-
you can decide to make use of an already existing installation of
99-
Postgres, Grafana or Prometheus and run additionally just the pgwatch
100-
collector.

docs/concept/installation_options.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ also choose how is the monitoring configuration
99
## Configuration database based operation
1010

1111
This is the original central pull mode depicted on the
12-
[architecture diagram](../gallery/pgwatch_architecture.png).
12+
[architecture diagram](components.md#component-diagram).
1313
It requires a small schema to be rolled out on any Postgres
1414
database accessible to the metrics gathering daemon, which will hold the
1515
connect strings, metric definition SQLs and preset configurations and
@@ -24,10 +24,10 @@ One can deploy the gatherer daemon(s) decentralized with
2424
*sources to be monitored* defined in simple YAML files. In that case there
2525
is no need for the central Postgres configuration database. See the
2626
[sample.sources.yaml](https://github.com/cybertec-postgresql/pgwatch/blob/master/internal/sources/sample.sources.yaml)
27-
config file for an example.
27+
config file for an example.
2828

2929
!!! Note
30-
In this mode you also may want, but not forced, to point out the path to
30+
In this mode you also may want, but not forced, to point out the path to
3131
metric definition YAML file when starting the
3232
gatherer. Also note that the configuration system supports multiple
3333
YAML files in a folder so that you could easily programmatically manage

docs/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ In the world of database management, **monitoring** plays a crucial role in ensu
1414

1515
pgwatch is designed specifically for monitoring **PostgreSQL databases** and related infrastructure. It covers a wide range of components crucial for PostgreSQL ecosystems, including:
1616

17-
- **PostgreSQL Databases**: pgwatch monitors the core performance and health metrics of your PostgreSQL instances.
18-
- **Patroni Clusters**: Monitor the health and performance of high-availability clusters members managed by **Patroni**.
19-
- **Connection Poolers (PgPool, PgBouncer)**: pgwatch provides insights into connection pooling with both **PgPool** and **PgBouncer**.
20-
- **Backup solutions**: Track the performance and status of **PgBackRest** and **WAL-G** backups, ensuring that your backups are executed correctly.
17+
- **PostgreSQL Databases**: pgwatch monitors the core performance and health metrics of your PostgreSQL instances.
18+
- **Patroni Clusters**: Monitor the health and performance of high-availability clusters members managed by **Patroni**.
19+
- **Connection Poolers (PgPool, PgBouncer)**: pgwatch provides insights into connection pooling with both **PgPool** and **PgBouncer**.
20+
- **Backup solutions**: Track the performance and status of **PgBackRest** and **WAL-G** backups, ensuring that your backups are executed correctly.
2121

2222
This extended monitoring capability allows you to gain a comprehensive view of not only your PostgreSQL databases but also the surrounding infrastructure that supports and enhances your database operations.
2323

@@ -27,12 +27,12 @@ This extended monitoring capability allows you to gain a comprehensive view of n
2727

2828
pgwatch provides out-of-the-box support for almost all essential **PostgreSQL metrics**, including:
2929

30-
- Database health checks
31-
- Query performance
32-
- Index usage
33-
- Disk I/O
34-
- CPU and memory consumption
35-
- Locks, waits, and more
30+
- Database health checks
31+
- Query performance
32+
- Index usage
33+
- Disk I/O
34+
- CPU and memory consumption
35+
- Locks, waits, and more
3636

3737
In addition to the standard metrics, pgwatch can be easily extended to monitor **custom metrics** based on your specific needs. The solution offers flexibility to fine-tune monitoring details and the aggressiveness of data collection.
3838

0 commit comments

Comments
 (0)