pmdapostgresql(1) - Linux manual page

NAME | DESCRIPTION | INSTALLATION | FILES | PCP ENVIRONMENT | SEE ALSO | COLOPHON

PMDAPOSTGRESQL(1)          General Commands Manual         PMDAPOSTGRESQL(1)

NAME         top

       pmdapostgresql - PostgreSQL database PMDA

DESCRIPTION         top

       pmdapostgresql is a Performance Co-Pilot PMDA which extracts live
       performance data from a running PostgreSQL database.

       Many of the staticstics available from a PostgreSQL server may not be
       enabled by default.  Refer to the online documentation at
       https://www.postgresql.org/docs/current/static/monitoring-stats.html 
       which describes each of the available parameters related to
       statistics collection and how to enable them.

INSTALLATION         top

       pmdapostgresql uses a configuration file from (in this order):
       ·   /etc/pcpdbi.conf
       ·   $PCP_PMDAS_DIR/postgresql/postgresql.conf
       ·   ./postgresql.conf

       This file can contain overridden values (Perl code) for the settings
       listed at the start of pmdapostgresql.pl, for example:
       ·   $database - database access method and database name, [default:
           'dbi:Pg:dbname=postgres'] (see DBI(3) for details)
       ·   $username - username to connect to the database [default:
           'postgres']
       ·   $password - password to connect to the database [default: '']
       ·   $os_user - operating system username (PMDA will run with the
           corresponding user id) [default: $username]

       Once this is setup, you can access the names and values for the
       postgresql performance metrics by doing the following as root:

             # cd $PCP_PMDAS_DIR/postgresql
             # ./Install

       To uninstall, do the following as root:

             # cd $PCP_PMDAS_DIR/postgresql
             # ./Remove

       pmdapostgresql is launched by pmcd(1) and should never be executed
       directly. The Install and Remove scripts notify pmcd(1) when the
       agent is installed or removed.

FILES         top

       /etc/pcpdbi.conf
           configuration file for all PCP database monitors
       $PCP_PMDAS_DIR/postgresql/postgresql.conf
           configuration file for pmdapostgresql
       $PCP_PMDAS_DIR/postgresql/Install
           installation script for the pmdapostgresql agent
       $PCP_PMDAS_DIR/postgresql/Remove
           undo installation script for the pmdapostgresql agent
       $PCP_LOG_DIR/pmcd/postgresql.log
           default log file for error messages from pmdapostgresql

PCP ENVIRONMENT         top

       Environment variables with the prefix PCP_ are used to parameterize
       the file and directory names used by PCP. On each installation, the
       file /etc/pcp.conf contains the local values for these variables.
       The $PCP_CONF variable may be used to specify an alternative
       configuration file, as described in pcp.conf(5).

SEE ALSO         top

       PCPIntro(1), pmdadbping(1) and DBI(3).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨http://www.pcp.io/⟩.
       If you have a bug report for this manual page, send it to
       pcp@groups.io.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩ on
       2018-02-02.  (At that time, the date of the most recent commit that
       was found in the repository was 2018-02-02.)  If you discover any
       rendering problems in this HTML version of the page, or you believe
       there is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

Performance Co-Pilot                 PCP                   PMDAPOSTGRESQL(1)