.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Munin::Plugin::Pgsql 3pm" .TH Munin::Plugin::Pgsql 3pm 2024-02-28 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Munin::Plugin::Pgsql \- Base module for PostgreSQL plugins for Munin .SH SYNOPSIS .IX Header "SYNOPSIS" The Munin::Plugin::Pgsql module provides base functionality for all PostgreSQL Munin plugins, including common configuration parameters. .SH CONFIGURATION .IX Header "CONFIGURATION" All configuration is done through environment variables. .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" All plugins based on Munin::Plugin::Pgsql accepts all the environment variables that libpq does. The most common ones used are: .PP .Vb 4 \& PGHOST hostname to connect to, or path to Unix socket \& PGPORT port number to connect to \& PGUSER username to connect as \& PGPASSWORD password to connect with, if a password is required .Ve .PP The plugins will by default connect to the 'template1' database, except for wildcard per-database plugins. This can be overridden using the PGDATABASE variable, but this is usually a bad idea. .PP If you are using plugin for several postgres instances, you can customize graph title with the environment variable PGLABEL. .PP Warning and critical can be customized by setting "warning" and "critical" env variables per plugin. .SS Example .IX Subsection "Example" .Vb 4 \& [postgres_*] \& user postgres \& env.PGUSER postgres \& env.PGPORT 5433 \& \& [postgres_connections_ALL] \& env.warning :450 \& env.critical :500 .Ve .SH "WILDCARD MATCHING" .IX Header "WILDCARD MATCHING" Wildcard plugins based on this module will match on whatever type of object specifies for a filter, usually a database. If the object name ALL is used (for example, a symlink to postgres_connections_ALL), the filter will not be applied, and the plugin behaves like a non-wildcard one. .SH REQUIREMENTS .IX Header "REQUIREMENTS" The module requires DBD::Pg to work. .SH TODO .IX Header "TODO" Support for using psql instead of DBD::Pg, to remove dependency. .SH BUGS .IX Header "BUGS" No known bugs at this point. .SH "SEE ALSO" .IX Header "SEE ALSO" DBD::Pg .SH AUTHOR .IX Header "AUTHOR" Magnus Hagander , Redpill Linpro AB .SH COPYRIGHT/License. .IX Header "COPYRIGHT/License." Copyright (c) 2009 Magnus Hagander, Redpill Linpro AB .PP All rights reserved. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 dated June, 1991. .SH "API DOCUMENTATION" .IX Header "API DOCUMENTATION" The following functions are available to plugins using this module. .SS Initialization .IX Subsection "Initialization" .Vb 5 \& use Munin::Plugin::Pgsql; \& my $pg = Munin::Plugin::Pgsql\->new( \& parameter=>value, \& parameter=>value \& ); .Ve .PP \fIParameters\fR .IX Subsection "Parameters" .PP .Vb 10 \& minversion Minimum PostgreSQL version required, formatted like 8.2. If the \& database is an older version than this, the plugin will exit \& with an error. \& category The category for this plugin. Copied directly to the config \& output. Default \*(AqPostgreSQL\*(Aq. \& title The title for this plugin. Copied directly to the config output. \& info The info for this plugin. Copied directly to the config output. \& vlabel The vertical label for the graph. Copied directly to the config \& output. \& basename For wildcard plugins, this is the base name of the plugin, \& including the trailing underscore. \& basequery SQL query run to get the plugin values. The query should return \& two columns, one being the name of the counter and the second \& being the current value for the counter. \& pivotquery Set to 1 to indicate that the query in basequery returns a single \& row, with one field for each counter. The name of the counter is \& taken from the returned column name, and the value from the \& first row in the result. \& configquery SQL query run to generate the configuration information for the \& plugin. The query should return at least two columns, which are \& the name of the counter and the label of the counter. If \& a third column is present, it will be used as the info \& parameter. \& suggestquery SQL query to run to generate the list of suggestions for a \& wildcard plugin. Don\*(Aqt forget to include ALL if the plugin \& supports aggregate statistics. \& autoconfquery SQL query to run as the last step of "autoconf", to determine \& if the plugin should be run on this machine. Must return a single \& row, two columns columns. The first one is a boolean field \& representing yes or no, the second one a reason for "no". \& warning The warning low and/or high thresholds. \& critical The critical low and/or high thresholds. \& graphdraw The draw parameter for the graph. The default is LINE1. \& graphtype The type parameter for the graph. The default is GAUGE. \& graphperiod The period for the graph. Copied directly to the config output. \& graphmin The min parameter for the graph. The default is no minimum. \& graphmax The max parameter for the graph. The default is no maximum. \& stack If set to 1, all counters except the first one will be written \& with a draw type of STACK. \& base Used for graph_args \-\-base. Default is 1000, set to 1024 when \& returning sizes in Kb for example. \& wildcardfilter The SQL to substitute for when a wildcard plugin is run against \& a specific entity, for example a database. All occurrences of \& the string %%FILTER%% will be replaced with this string, and \& for each occurrence a parameter with the value of the filtering \& condition will be added to the DBI statement. \& paramdatabase Makes the plugin connect to the database in the first parameter \& (wildcard plugins only) instead of \*(Aqtemplate1\*(Aq. \& defaultdb Makes the plugin connect to the database specified in this \& parameter instead of \*(Aqtemplate1\*(Aq. \& extraconfig This string is copied directly into the configuration output \& when the plugin is run in config mode, allowing low\-level \& customization. \& postprocess A function that\*(Aqs called with the result of the base query, \& and can post\-process the result and return a new resultset. \& postconfig A function that\*(Aqs called with the result of the config query, \& and can post\-process the result and return a new resultset. \& postautoconf A function that\*(Aqs called with the result of the autoconf query, \& and can post\-process the result and return a new resultset. \& postsuggest A function that\*(Aqs called with the result of the suggest query, \& and can post\-process the result and return a new resultset. .Ve .PP \fISpecifying queries\fR .IX Subsection "Specifying queries" .PP Queries specified in one of the parameters above can take one of two forms. The easiest one is a simple string, which will then always be executed, regardless of server version. The other form is an array, looking like this: [ "SELECT 'default',... FROM ...", [ "8.3", "SELECT 'query for 8.3 or earlier',... FROM ...", "8.1", "SELECT 'query for 8.1 or earlier',... FROM ..." ] ] This array is parsed from top to bottom, so the entries must be in order of version number. The *last* value found where the version specified is higher than or equal to the version of the server will be used (yes, it counts backwards). .SS Processing .IX Subsection "Processing" .Vb 1 \& $pg\->Process(); \& \& This command executes the plugin. It will automatically parse the ARGV array \& for commands given by Munin. .Ve