Skip to content
This repository was archived by the owner on Jul 6, 2021. It is now read-only.

Commit 5901a1c

Browse files
committed
Update README.md
1 parent 7d2b624 commit 5901a1c

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
About
22
===
3-
PgHealth is the ultimate open-source PostgreSQL database healthcheck utility.
3+
PgHealth is the ultimate open-source PostgreSQL database health check utility.
44

55
It checks PostgreSQL settings, configs and Linux postgres-related environment
66
with series of checks.
@@ -14,18 +14,26 @@ It also helps to detect a lot of issues with postgres instances.
1414
Example
1515
===
1616

17+
Let's make a report for a project named `my-site_org-slony`:
18+
Cluster `slony` contains two servers - `db1` and `db2`.
19+
PgHealth automatically detects which one is a master:
20+
1721
```bash
18-
./check -h db1 -p 5432 --username postgres --dbname postgres --project my-site_org-slony -e 1
22+
./check -h db1 -p 5432 --username postgres --dbname postgres --project my-site_org-slony
1923
```
2024

2125
```bash
2226
./check -h db2 -p 5432 --username postgres --dbname postgres --project my-site_org-slony -e 1
2327
```
2428

25-
Which literaly means: "connect to server with given credentials, save data into `my-site_org-slony`
29+
Which literally means: "connect to the server with given credentials, save data into `my-site_org-slony`
2630
project directory as epoch of check `1`. Epoch is a numerical sign of current iteration.
2731
For example: in half a year we can switch to "epoch number `2`".
2832

33+
At the first run we can skip `-e 1` because default epoch is `1`, but at the second argument `-e`
34+
must exist: we don't want to overwrite historical results.
35+
36+
2937
As a result of health-check we have got two directories with .json files and .md files:
3038

3139
```bash
@@ -36,6 +44,14 @@ As a result of health-check we have got two directories with .json files and .md
3644
Each of generated files contains information about "what we check" and collected data for
3745
all instances of the postgres cluster `my-site_org-slony`.
3846

47+
Human-readable report can be found at:
48+
49+
```bash
50+
./artifacts/my-site_org-slony/full_report.md
51+
```
52+
53+
Open it with your favorite Markdown files viewer or just upload to a service such as gist.github.com.
54+
3955
Requirements
4056
===
4157

0 commit comments

Comments
 (0)