pmdaelasticsearch(1) - Linux manual page

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

PMDAELASTICSEARCH(1)       General Commands Manual      PMDAELASTICSEARCH(1)

NAME         top

       pmdaelasticsearch  -  elasticsearch  performance metrics domain agent
       (PMDA)

DESCRIPTION         top

       pmdaelasticsearch is a Performance Metrics Domain Agent (PMDA) which
       exports performance metrics from elasticsearch.

INSTALLATION         top

       This PMDA requires that elasticsearch is running on the local host
       and is accepting queries on TCP port 9200.

       Install the elasticsearch PMDA by using the Install script as root:

             # cd $PCP_PMDAS_DIR/elasticsearch
             # ./Install

       To uninstall, do the following as root:

             # cd $PCP_PMDAS_DIR/elasticsearch
             # ./Remove

       pmdaelasticsearch 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/elasticsearch/es.conf
           optional configuration file for pmdaelasticsearch

       $PCP_PMDAS_DIR/elasticsearch/Install
           installation script for the pmdaelasticsearch agent

       $PCP_PMDAS_DIR/elasticsearch/Remove
           undo installation script for the pmdaelasticsearch agent

       $PCP_LOG_DIR/pmcd/elasticsearch.log
           default log file for error messages from pmdaelasticsearch

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

       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
       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                PMDAELASTICSEARCH(1)