Skip to content

Commit 5410092

Browse files
authored
[*] misc updates to docs (#1016)
* Minor improvements to typing style * Mention custom metrics as SQL-based * Improve statement clarity. * "Mention `/grafana` as source of truth for a full list of all dashboards"
1 parent d4850f3 commit 5410092

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

docs/gallery/dashboards.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Dashboards are a collection of visualizations that are displayed in a single page. They are useful for monitoring and analyzing data.
44

5+
The complete list of available dashboards can be found in the official repository under
6+
[/grafana](https://github.com/cybertec-postgresql/pgwatch/tree/master/grafana).
7+
58
## 0. Health Check
69

710
![Health Check](0_health_check.png){data-gallery="dashboards"}

docs/gallery/webui.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Web User Interface
22

3-
The Web User Interface (WebUI) allows you to interact with the pgwatch and control monitored sources, metrics and presets
4-
definitions, and view logs.
3+
The Web User Interface (WebUI) allows you to interact with pgwatch to control monitored sources, update metrics and presets definitions, and view logs.
54

65
Sources
76
![Sources](webui_sources_grid.png){data-gallery="webui"}
@@ -13,4 +12,4 @@ Presets
1312
![Presets](webui_presets_grid.png){data-gallery="webui"}
1413

1514
Logs
16-
![Logs](webui_logs.png){data-gallery="webui"}
15+
![Logs](webui_logs.png){data-gallery="webui"}

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In the world of database management, **monitoring** plays a crucial role in ensu
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

1717
- **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**.
18+
- **Patroni Clusters**: Monitor the health and performance of high-availability cluster members managed by **Patroni**.
1919
- **Connection Poolers (PgPool, PgBouncer)**: pgwatch provides insights into connection pooling with both **PgPool** and **PgBouncer**.
2020
- **Backup solutions**: Track the performance and status of **PgBackRest** and **WAL-G** backups, ensuring that your backups are executed correctly.
2121

@@ -34,7 +34,7 @@ pgwatch provides out-of-the-box support for almost all essential **PostgreSQL me
3434
- CPU and memory consumption
3535
- Locks, waits, and more
3636

37-
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.
37+
In addition to the standard metrics, pgwatch can be easily extended to monitor **custom SQL-based metrics** based on your specific needs. The solution offers flexibility to fine-tune monitoring details and the aggressiveness of data collection.
3838

3939
## Where?
4040

docs/intro/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ title: List of main features
1818
gRPC-based custom storage integration
1919
- Multiple deployment options - PostgreSQL configuration DB, YAML or
2020
ENV configuration
21-
- Possible to monitoring all, single or a subset (list or regex) of
21+
- Possibility to monitor all, single or a subset (list or regex) of
2222
databases of a PostgreSQL instance
2323
- Global or per DB configuration of metrics and metric fetching
2424
intervals

docs/intro/project_background.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,4 @@ Cybertec also provides commercial 9-to-5 and 24/7 support for pgwatch.
3636
# Project feedback
3737

3838
For feature requests or troubleshooting assistance please open an issue
39-
on project's [Github
40-
page](https://github.com/cybertec-postgresql/pgwatch).
39+
on the project's [Github repo](https://github.com/cybertec-postgresql/pgwatch).

0 commit comments

Comments
 (0)