Plugin:PostgreSQL

From collectd Wiki

Jump to: navigation, search
PostgreSQL plugin
Type: read
Callbacks: config, init, read, shutdown
Status: supported
First version: 4.5
Copyright: 2008–2012 Sebastian Harl
2009 Florian Forster
License: BSD (revised)
Manpage: collectd.conf(5)
List of Plugins

The PostgreSQL plugin connects to and executes SQL statements on a PostgreSQL database. It then reads back the results and, depending on the configuration, the returned values are then converted into collectd “value lists” (the data structure used internally to pass statistics around). This plugin is a generic plugin, i.e. it cannot work without configuration, because there is no reasonable default behavior. Please read the Plugin postgresql section of the collectd.conf(5) manual page for an in-depth description of the plugin's configuration.

The configuration syntax of the PostgreSQL, DBI, and Oracle plugins is very similar, because the configuration of those plugins is handled by the same module. Also, we tried to keep the syntax similar to that of the SNMP plugin. So if you use any of those plugins already, most of the following will look familiar.

Contents

Synopsis

<Plugin postgresql>
  <Query magic>
    Statement "SELECT magic FROM wizard WHERE host = $1;"
    Param hostname
    <Result>
      Type gauge
      InstancePrefix "magic" 
      ValuesFrom magic
    </Result>
  </Query>

  <Query rt36_tickets>
    Statement "SELECT COUNT(type) AS count, type \
                      FROM (SELECT CASE \
                                   WHEN resolved = 'epoch' THEN 'open' \
                                   ELSE 'resolved' END AS type \
                                   FROM tickets) type \
                      GROUP BY type;"
    <Result>
      Type counter 
      InstancePrefix "rt36_tickets"
      InstancesFrom "type"
      ValuesFrom "count" 
    </Result>
  </Query>

  <Database foo>
    Host "hostname"
    Port "5432"
    User "username"
    Password "secret"
    SSLMode "prefer"
    KRBSrvName "kerberos_service_name"
    Query magic
  </Database>

  <Database bar>
    Service "service_name"
    Query backend # predefined
    Query rt36_tickets
  </Database>
</Plugin>

Example graphs

Image:Plugin-postgresql-idx_tup_fetch.png

Dependencies

  • libpq
    (The PostgreSQL C client library.)

See also