Skip to content

Commit d7a72be

Browse files
jdgwartneyjdgwartney
committed
Rewrite README
1 parent 8fef423 commit d7a72be

1 file changed

Lines changed: 50 additions & 49 deletions

File tree

‎README.md‎

Lines changed: 50 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
Boundary PostgreSQL Plugin
2-
==========================
3-
2+
--------------------------
43
**Awaiting Certification**
54

5+
Extracts metrics from a PostgreSQL database instance.
6+
7+
8+
69
Prerequisites
710
-------------
811
The following items are required on the host platform in addition to the Boundary Premium [relay](http://premium-support.boundary.com/customer/portal/articles/1635550-plugins---how-to).
9-
* Python 2.6.6 or later
10-
* PsycoPG2 module which the requires the following to install using pip
11-
-- PostreSQL libpq-dev
12-
-- PythonDev
12+
- Python 2.6.6 or later
13+
- PsycoPG2 module
14+
- PostreSQL development packages: postgresql-devel
15+
- Python development packages: python-devel
16+
17+
### Plugin Setup
1318

14-
### Installation of the PsycoPG2 library using pip:
19+
#### Installation of the PsycoPG2 Library Using `pip`
1520

1621
1. Install [pip](http://pip.readthedocs.org/en/latest/installing.html) if not already installed
1722

@@ -25,48 +30,44 @@ The following items are required on the host platform in addition to the Boundar
2530
$ pip install psycopg2
2631
```
2732

28-
## Metrics
29-
The plugin currently provides the below indicated metrics below, but can easily be extended to provide per database metrics or custom metrics if required.
30-
31-
### Lock Stats
32-
The following collects regarding database wide locks.
33-
34-
|Metric Name |Metric Identifier |Description |
35-
|:----------------------------------------------|:--------------------------------------------|:----------------------------------------------|
36-
|PostgreSQL - Locks Access Share |POSTGRESQL\_ACCESS\_SHARE\_LOCKS |PostgreSQL - Locks Access Share |
37-
|PostgreSQL - Locks Exclusive |POSTGRESQL\_EXCLUSIVE\_LOCKS |PostgreSQL - Locks Exclusive |
38-
|PostgreSQL - Locks Row Exclusive |POSTGRESQL\_ROW\_EXCLUSIVE\_LOCKS |PostgreSQL - Locks Row Exclusive |
39-
|PostgreSQL - Locks Share Row Exclusive |POSTGRESQL\_SHARE\_ROW\_EXCLUSIVE\_LOCKS |PostgreSQL - Locks Share Row Exclusive |
40-
|PostgreSQL - Locks Share Update Exclusive Locks|POSTGRESQL\_SHARE\_UPDATE\_EXCLUSIVE\_LOCKS |PostgreSQL - Locks Share Update Exclusive Locks|
41-
|PostgreSQL - Locks Share |POSTGRESQL\_SHARE\_LOCKS |PostgreSQL - Locks Share |
42-
43-
44-
### Checkpoint/Background Writer Stats
33+
### Plugin Configuration Fields
34+
|Field Name|Description |
35+
|:-------|:-------------------------------------------------|
36+
|host |database host name or IP |
37+
|port |PostgreSQL Port |
38+
|database|database name |
39+
|username|PostgreSQL username |
40+
|password|PostgreSQL Password (if not required put anything)|
41+
|source |display name |
4542

46-
|Metric Name |Metric Identifier |Description |
47-
|:----------------------------------------------|:--------------------------------------------|:----------------------------------------------|
48-
|PostgreSQL - Buffers Allocated |POSTGRESQL\_BUFFERS\_ALLOCATED |PostgreSQL Buffers Allocated |
49-
|PostgreSQL - Buffers Backend Fsync |POSTGRESQL\_BUFFERS\_BACKEND\_FSYNC |PostgreSQL - Buffers Backend Fsync |
50-
|PostgreSQL - Buffers Backend |POSTGRESQL\_BUFFERS\_BACKEND |PostgreSQL - Buffers Backend |
51-
|PostgreSQL - Buffers Clean |POSTGRESQL\_BUFFERS\_CLEAN |PostgreSQL - Buffers Clean |
52-
|PostgreSQL - Checkpoints Timed |POSTGRESQL\_CHECKPOINTS\_TIMED |PostgreSQL - Checkpoints Timed |
53-
|PostgreSQL - Checkpoint Write Time |POSTGRESQL\_CHECKPOINT\_WRITE\_TIME |PostgreSQL Checkpoint Write Time |
54-
|PostgreSQL - Checkpoint Synchronization Time |POSTGRESQL\_CHECKPOINT\_SYNCHRONIZATION\_TIME|PostgreSQL - Checkpoint Synchronization Time |
55-
|PostgreSQL - Checkpoints Requested |POSTGRESQL\_CHECKPOINTS\_REQUESTED |PostgreSQL - Checkpoints Requested |
56-
|PostgreSQL - Maximum Written Clean |POSTGRESQL\_MAXIMUM\_WRITTEN\_CLEAN |PostgreSQL - Maximum Written Clean |
43+
### Metrics Collected
5744

58-
### Global Database Stats
45+
|Metric Name |Description |
46+
|:----------------------------------------------|:----------------------------------------------|
47+
|PostgreSQL - Locks Exclusive |PostgreSQL - Locks Exclusive |
48+
|PostgreSQL - Locks Row Exclusive |PostgreSQL - Locks Row Exclusive |
49+
|PostgreSQL - Locks Share Row Exclusive |PostgreSQL - Locks Share Row Exclusive |
50+
|PostgreSQL - Locks Share Update Exclusive Locks|PostgreSQL - Locks Share Update Exclusive Locks|
51+
|PostgreSQL - Locks Share |PostgreSQL - Locks Share |
52+
|PostgreSQL - Locks Access Share |PostgreSQL - Locks Access Share |
53+
|PostgreSQL - Checkpoint Write Time |PostgreSQL Checkpoint Write Time |
54+
|PostgreSQL - Checkpoints Timed |PostgreSQL - Checkpoints Timed |
55+
|PostgreSQL - Buffers Allocated |PostgreSQL Buffers Allocated |
56+
|PostgreSQL - Buffers Clean |PostgreSQL - Buffers Clean |
57+
|PostgreSQL - Buffers Backend Fsync |PostgreSQL - Buffers Backend Fsync |
58+
|PostgreSQL - Checkpoint Synchronization Time |PostgreSQL - Checkpoint Synchronization Time |
59+
|PostgreSQL - Checkpoints Requested |PostgreSQL - Checkpoints Requested |
60+
|PostgreSQL - Buffers Backend |PostgreSQL - Buffers Backend |
61+
|PostgreSQL - Maximum Written Clean |PostgreSQL - Maximum Written Clean |
62+
|PostgreSQL - Buffers Checkpoint |PostgreSQL - Buffers Checkpoint |
63+
|PostgreSQL - Blocks Read |PostgreSQL - Blocks Read |
64+
|PostgreSQL - Disk Size |PostgreSQL - Disk Size |
65+
|PostgreSQL - Transaction Committed |PostgreSQL - Transaction Committed |
66+
|PostgreSQL - Transactions Rolledback |PostgreSQL - Transactions Rolledback |
67+
|PostgreSQL - Blocks Hit |PostgreSQL - Blocks Hit |
68+
|PostgreSQL - Tuples Deleted |PostgreSQL - Tuples Deleted |
69+
|PostgreSQL - Tuples Fetched |PostgreSQL - Tuples Fetched |
70+
|PostgreSQL - Tuples Inserted |PostgreSQL - Tuples Inserted |
71+
|PostgreSQL - Tuples Returned |PostgreSQL - Tuples Returned |
72+
|PostgreSQL - Tuples Updated |PostgreSQL - Tuples Updated |
5973

60-
|Metric Name |Metric Identifier |Description |
61-
|:----------------------------------------------|:--------------------------------------------|:----------------------------------------------|
62-
|PostgreSQL - Blocks Hit |POSTGRESQL\_BLOCKS\_HIT |PostgreSQL - Blocks Hit |
63-
|PostgreSQL - Blocks Read |POSTGRESQL\_BLOCKS\_READ |PostgreSQL - Blocks Read |
64-
|PostgreSQL - Buffers Checkpoint |POSTGRESQL\_BUFFERS\_CHECKPOINT |PostgreSQL - Buffers Checkpoint |
65-
|PostgreSQL - Disk Size |POSTGRESQL\_DISK\_SIZE |PostgreSQL - Disk Size |
66-
|PostgreSQL - Transaction Committed |POSTGRESQL\_TRANSACTIONS\_COMMITTED |PostgreSQL - Transaction Committed |
67-
|PostgreSQL - Transactions Rolledback |POSTGRESQL\_TRANSACTIONS\_ROLLEDBACK |PostgreSQL - Transactions Rolledback |
68-
|PostgreSQL - Tuples Deleted |POSTGRESQL\_TUPLES\_DELETED |PostgreSQL - Tuples Deleted |
69-
|PostgreSQL - Tuples Fetched |POSTGRESQL\_TUPLES\_FETCHED |PostgreSQL - Tuples Fetched |
70-
|PostgreSQL - Tuples Inserted |POSTGRESQL\_TUPLES\_INSERTED |PostgreSQL - Tuples Inserted |
71-
|PostgreSQL - Tuples Returned |POSTGRESQL\_TUPLES\_RETURNED |PostgreSQL - Tuples Returned |
72-
|PostgreSQL - Tuples Updated |POSTGRESQL\_TUPLES\_UPDATED |PostgreSQL - Tuples Updated |

0 commit comments

Comments
 (0)