postgresql_transactions: use perldoc documentation header

This commit is contained in:
Lars Kruse 2018-06-10 14:06:48 +02:00
parent 3c10c360cd
commit e93a46bc76
1 changed files with 35 additions and 21 deletions

View File

@ -1,25 +1,39 @@
#!/bin/sh
#
# Plugin to monitor PostgreSQL Commits and Rollbacks in Transactions
#
# Author:
# Guilherme Augusto da Rocha Silva <gars.dba@gmail.com>
#
# Created:
# 9th of november 2007
#
# Usage:
# Place in /etc/munin/plugins/ (or link it there using ln -s)
#
# Parameters:
# config (required)
#
# General info:
# Require permission for database access and read (no writes are processed).
# Recommended user is PostgreSQL database owner (default: postgres).
#
# Log info:
#
: <<=cut
=head1 NAME
postgresql_transactions - Plugin to monitor PostgreSQL Commits and Rollbacks in Transactions
=head1 USAGE
Usage:
Place in /etc/munin/plugins/ (or link it there using ln -s)
General info:
Requires permission for database read access (no writes are processed).
Recommended user is PostgreSQL database owner (default: postgres).
=head1 CONFIGURATION
The following configuration directives may be placed below /etc/munin/plugin-conf.d/ (optional):
[postgresql_transactions]
user postgres
env.dbuser postgres
env.dbhost localhost
=head1 AUTHOR
Guilherme Augusto da Rocha Silva <gars.dba@gmail.com>
Copyright (C) 2007 Guilherme Augusto da Rocha Silva <gars.dba@gmail.com>
=cut
dbhost=${dbhost:-localhost}
dbuser=${dbuser:-postgres}