1
1
About
2
2
===
3
- PgHealth is the ultimate open-source PostgreSQL database healthcheck utility.
3
+ PgHealth is the ultimate open-source PostgreSQL database health check utility.
4
4
5
5
It checks PostgreSQL settings, configs and Linux postgres-related environment
6
6
with series of checks.
@@ -14,18 +14,26 @@ It also helps to detect a lot of issues with postgres instances.
14
14
Example
15
15
===
16
16
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
+
17
21
``` 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
19
23
```
20
24
21
25
``` bash
22
26
./check -h db2 -p 5432 --username postgres --dbname postgres --project my-site_org-slony -e 1
23
27
```
24
28
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 `
26
30
project directory as epoch of check ` 1 ` . Epoch is a numerical sign of current iteration.
27
31
For example: in half a year we can switch to "epoch number ` 2 ` ".
28
32
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
+
29
37
As a result of health-check we have got two directories with .json files and .md files:
30
38
31
39
``` bash
@@ -36,6 +44,14 @@ As a result of health-check we have got two directories with .json files and .md
36
44
Each of generated files contains information about "what we check" and collected data for
37
45
all instances of the postgres cluster ` my-site_org-slony ` .
38
46
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
+
39
55
Requirements
40
56
===
41
57
0 commit comments