---
name: "pmdaelasticsearch"
section: "1"
platform: "linux"
package: "pcp"
version: "7.2.2-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/pmdaelasticsearch"
---

# pmdaelasticsearch(1)

elasticsearch performance metrics domain agent (PMDA)

## 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)](/pmcd/1.md) and should never be executed directly. The Install and Remove scripts notify [*pmcd*(1)](/pmcd/1.md) when the agent is installed or removed.

## FILES

- **$PCP\_PMDAS\_DIR/elasticsearch/elasticsearch.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)](/pcp.conf/5.md).

## SEE ALSO

[**PCPIntro**(1)](/PCPIntro/1.md) and [**pmcd**(1)](/pmcd/1.md).