Skip to content

Commit

Permalink
Update documentation to 2.3beta1
Browse files Browse the repository at this point in the history
  • Loading branch information
frost242 committed Sep 20, 2017
1 parent fb378a2 commit aafa810
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 19 deletions.
37 changes: 24 additions & 13 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -281,10 +281,10 @@ check_pgactivity
Critical and Warning thresholds are optional. They accept a list of
'status_label=value' separated by a comma. Available labels are
"idle", "idle_xact", "aborted_xact", "fastpath", "active" and
"waiting". Values are raw numbers and empty lists are forbidden.
Here is an example:
"waiting". Values are raw numbers or time units and empty lists are
forbidden. Here is an example:

-w 'waiting=5,idle_xact=10' -c 'waiting=20,idle_xact=30'
-w 'waiting=5,idle_xact=10' -c 'waiting=20,idle_xact=30,active=1d'

Perfdata contains the number of backends for each status and the
oldest one for each of them, for 8.2+.
Expand Down Expand Up @@ -343,9 +343,10 @@ check_pgactivity
perfdata. This list contains the fully qualified bloated index name,
the estimated bloat size, the index size and the bloat percentage.

This service will work with PostgreSQL 10+ without superuser privileges
if you grant SELECT on table pg_statistic to the pg_monitor role, in
each database of the cluster : GRANT SELECT ON pg_statistic TO pg_monitor;
This service will work with PostgreSQL 10+ without superuser
privileges if you grant SELECT on table pg_statistic to the
pg_monitor role, in each database of the cluster : "GRANT SELECT ON
pg_statistic TO pg_monitor;"

commit_ratio (all)
Check the commit and rollback rate per second since last call.
Expand Down Expand Up @@ -418,6 +419,8 @@ check_pgactivity
hit_ratio (all)
Check the cache hit ratio on the cluster.

This service uses the status file (see "--status-file" parameter).

Perfdata returns the cache hit ratio per database. Template
databases and databases that do not allow connections will not be
checked, nor will the databases which have never been accessed.
Expand Down Expand Up @@ -747,8 +750,15 @@ check_pgactivity
--slave 'slave1 192.168.1.11' --slave 'slave2 192.168.1.12'
--slave 'slave1 192.168.1.11','slave2 192.168.1.12'

Perfdata returns the data delta in bytes between the master and all
standbys found and the number of slaves connected.
This service supports a "--exclude REGEX" parameter to exclude every
result matching the given regular expression on application_name or
address ip fields.

You can use multiple "--exclude REGEX" parameters.

Perfdata returns the data delta in bytes between the master and
every standbies found, the number of standbies connected and the
number of excluded standbies.

Critical and Warning thresholds are optional. They can take one or
two values separated by a comma. If only one value is supplied, it
Expand Down Expand Up @@ -817,9 +827,10 @@ check_pgactivity
perfdata. This list contains the fully qualified bloated table name,
the estimated bloat size, the table size and the bloat percentage.

This service will work with PostgreSQL 10+ without superuser privileges
if you grant SELECT on table pg_statistic to the pg_monitor role, in
each database of the cluster : GRANT SELECT ON pg_statistic TO pg_monitor;
This service will work with PostgreSQL 10+ without superuser
privileges if you grant SELECT on table pg_statistic to the
pg_monitor role, in each database of the cluster : "GRANT SELECT ON
pg_statistic TO pg_monitor;"

temp_files (8.1+)
Check the number and size of temp files.
Expand Down Expand Up @@ -923,13 +934,13 @@ check_pgactivity
check_pgactivity -p 5433 -h slave --service hit_ratio --dbinclude importantone -w 90% -c 80%

VERSION
check_pgactivity version 2.2, released on Fri Apr 28 2017.
check_pgactivity version 2.3_beta1, released on Wed Sep 20 2017.

LICENSING
This program is open source, licensed under the PostgreSQL license. For
license terms, see the LICENSE provided with the sources.

AUTHORS
Author: Open PostgreSQL Monitoring Development Group Copyright: (C)
2012-2017 Open PostgreSQL Development Group
2012-2017 Open PostgreSQL Monitoring Development Group

19 changes: 13 additions & 6 deletions README.pod
Original file line number Diff line number Diff line change
Expand Up @@ -319,9 +319,9 @@ You can use multiple C<--exclude REGEX> arguments.
Critical and Warning thresholds are optional. They accept a list of
'status_label=value' separated by a comma. Available labels are C<idle>,
C<idle_xact>, C<aborted_xact>, C<fastpath>, C<active> and C<waiting>. Values
are raw numbers and empty lists are forbidden. Here is an example:
are raw numbers or time units and empty lists are forbidden. Here is an example:

-w 'waiting=5,idle_xact=10' -c 'waiting=20,idle_xact=30'
-w 'waiting=5,idle_xact=10' -c 'waiting=20,idle_xact=30,active=1d'

Perfdata contains the number of backends for each status and the oldest one for
each of them, for 8.2+.
Expand Down Expand Up @@ -456,6 +456,8 @@ This service supports both C<--dbexclude> and C<--dbinclude> parameters.

Check the cache hit ratio on the cluster.

This service uses the status file (see C<--status-file> parameter).

Perfdata returns the cache hit ratio per database. Template databases and
databases that do not allow connections will not be checked, nor will the
databases which have never been accessed.
Expand Down Expand Up @@ -789,8 +791,13 @@ Either of the two following examples will check for the presence of two slaves:
--slave 'slave1 192.168.1.11' --slave 'slave2 192.168.1.12'
--slave 'slave1 192.168.1.11','slave2 192.168.1.12'

Perfdata returns the data delta in bytes between the master and all standbys
found and the number of slaves connected.
This service supports a C<--exclude REGEX> parameter to exclude every result
matching the given regular expression on application_name or address ip fields.

You can use multiple C<--exclude REGEX> parameters.

Perfdata returns the data delta in bytes between the master and every standbies
found, the number of standbies connected and the number of excluded standbies.

Critical and Warning thresholds are optional. They can take one or two values
separated by a comma. If only one value is supplied, it applies to both flushed
Expand Down Expand Up @@ -968,7 +975,7 @@ B<It has to be executed locally on the monitored server.>

=head2 VERSION

check_pgactivity version 2.2, released on Fri Apr 28 2017.
check_pgactivity version 2.3_beta1, released on Wed Sep 20 2017.

=head2 LICENSING

Expand All @@ -978,5 +985,5 @@ For license terms, see the LICENSE provided with the sources.
=head2 AUTHORS

Author: Open PostgreSQL Monitoring Development Group
Copyright: (C) 2012-2017 Open PostgreSQL Development Group
Copyright: (C) 2012-2017 Open PostgreSQL Monitoring Development Group

0 comments on commit aafa810

Please sign in to comment.