NAME¶

pmdaelasticsearch - elasticsearch performance metrics domain agent (PMDA)

DESCRIPTION¶

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

INSTALLATION¶

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¶

$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¶

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¶

pmcd(1).