pmdadbping(1) — Linux manual page

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

PMDADBPING(1)            General Commands Manual           PMDADBPING(1)

NAME         top

       pmdadbping - database response time and availability PMDA

DESCRIPTION         top

       pmdadbping is a database response time measurement PMDA.

       pmdadbping runs dbprobe(1), and exports the performance
       measurements it makes available as PCP metrics.

       dbprobe(1) should be configured to use the type of DBI
       appropriate for the local database, which includes: RDBMS
       flavour, user/password, delay between "ping" requests, and the
       SQL statement to use.

INSTALLATION         top

       Configure dbprobe(1) - it uses a configuration file from (in this
       order):

       •   /etc/pcpdbi.conf

       •   $PCP_PMDAS_DIR/dbping/dbprobe.conf

       This file can contain overridden values (Perl code) for the
       settings listed at the start of dbprobe.pl, namely:

       •   database name (see DBI(3) for details)

       •   database user name

       •   database pass word

       •   SQL statement to measure (probe)

       •   delay between probes

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

           # cd $PCP_PMDAS_DIR/dbping
           # ./Install

       To uninstall, the following must be done as root:

           # cd $PCP_PMDAS_DIR/dbping
           # ./Remove

       pmdadbping 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

       $PCP_PMDAS_DIR/dbping/dbprobe.conf
           probe configuration file for dbprobe(1), used indirectly by
           pmdadbping

       $PCP_PMDAS_DIR/dbping/Install
           installation script for the pmdadbping agent

       $PCP_PMDAS_DIR/dbping/Remove
           undo installation script for the pmdadbping agent

       $PCP_LOG_DIR/pmcd/dbping.log
           default log file for error messages from pmdadbping

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), pmcd(1), dbprobe(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 2023-12-22.
       (At that time, the date of the most recent commit that was found
       in the repository was 2023-12-16.)  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                     PMDADBPING(1)

Pages that refer to this page: dbprobe(1)pmdamysql(1)pmdaoracle(1)