pmdaredis(1) — Linux manual page

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

PMDAREDIS(1)             General Commands Manual            PMDAREDIS(1)

NAME         top

       pmdaredis - Redis performance metrics domain agent (PMDA)

DESCRIPTION         top

       This PMDA extracts performance data from sending the INFO command
       to a Redis (redis.io) server, which includes:

       • General information about the Redis server

       • Client connections

       • Memory consumption

       • Persistence statistics

       • Replication statistics

       • CPU consumption statistics

       • Redis command statistics

       • Redis Cluster statistics

       • Database related statistics

       The hostname (localhost), port (6379 by default) and other
       configuration information must be specified in the
       $PCP_PMDAS_DIR/redis/redis.conf file.

           # cd $PCP_PMDAS_DIR/redis
           # [ edit redis.conf ]
             host=localhost.localdomain:6379

       To uninstall, the following must be done as root:

           # cd $PCP_PMDAS_DIR/redis
           # ./Remove

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

           # cd $PCP_PMDAS_DIR/redis
           # ./Install

       To uninstall, the following must be done as root:

           # cd $PCP_PMDAS_DIR/redis
           # ./Remove

       pmdaredis 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/redis/redis.conf
           mandatory configuration file listing monitored redis
           instances

       $PCP_PMDAS_DIR/redis/Install
           installation script for the pmdaredis agent

       $PCP_PMDAS_DIR/redis/Remove
           undo installation script for the pmdaredis agent

       $PCP_LOG_DIR/pmcd/redis.log
           default log file for error messages from pmdaredis

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) and pmcd(1).

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 [email protected].  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  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
       [email protected]

Performance Co-Pilot               PCP                      PMDAREDIS(1)

Pages that refer to this page: pmdanutcracker(1)