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

# pmdaapache(1)

Apache2 web server performance metrics domain agent (PMDA)

## NAME

**pmdaapache** - Apache2 web server performance metrics domain agent (PMDA)

## SYNOPSIS

**$PCP\_PMDAS\_DIR/apache/pmdaapache** \[**-D** *debug*\] \[**-d** *domain*\] \[**-l** *logfile*\] \[**-U** *username*\] \[**-S** *server*\] \[**-P** *port*\] \[**-L** *location*\]

## DESCRIPTION

**pmdaapache** is a Performance Metrics Domain Agent (PMDA) which extracts performance metrics describing the state of an Apache web server.

The **apache** PMDA exports metrics that measure the request rate, cumulative request sizes, uptime and various connection states for active clients.

This information is obtained by performing a HTTP request to the server status URL, which must be enabled in the *httpd.conf* configuration file.

```
ExtendedStatus on
<Location /server-status>
SetHandler server-status
Order deny,allow
Deny from all
Allow from localhost
</Location>
```

A brief description of the **pmdaapache** command line options follows:

- **-d**

  It is absolutely crucial that the performance metrics *domain* number specified here is unique and consistent. That is, *domain* should be different for every PMDA on the one host, and the same *domain* number should be used for the same PMDA on all hosts.

- **-l**

  Location of the log file.  By default, a log file named *apache.log* is written in the current directory of [**pmcd**(1)](/pmcd/1.md) when **pmdaapache** is started, i.e. **$PCP\_LOG\_DIR/pmcd .** If the log file cannot be created or is not writable, output is written to the standard error instead.

- **-S**

  Query the Apache status information from the named *server* rather than the local host.

- **-P**

  Query the Apache status information from the given *port* rather than the default (80).

- **-L**

  Specify an alternative *location* for finding the server-status page.

- **-U**

  User account under which to run the agent. The default is the unprivileged "pcp" account in current versions of PCP, but in older versions the superuser account ("root") was used by default.

## INSTALLATION

If you want access to the names, help text and values for the apache performance metrics, do the following as root:

```
# cd $PCP_PMDAS_DIR/apache
# ./Install
```

If you want to undo the installation, do the following as root:

```
# cd $PCP_PMDAS_DIR/apache
# ./Remove
```

**pmdaapache** 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\_PMCDCONF\_PATH**

  command line options used to launch **pmdaapache**

- **$PCP\_PMDAS\_DIR/apache/help**

  default help text file for the apache metrics

- **$PCP\_PMDAS\_DIR/apache/Install**

  installation script for the **pmdaapache** agent

- **$PCP\_PMDAS\_DIR/apache/Remove**

  undo installation script for the **pmdaapache** agent

- **$PCP\_LOG\_DIR/pmcd/apache.log**

  default log file for error messages and other information from **pmdaapache**

## 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).

## DEBUGGING OPTIONS

The **-D** or **--debug** option enables the output of additional diagnostics on *stderr* to help triage problems, although the information is sometimes cryptic and primarily intended to provide guidance for developers rather than for end-users. *debug* is a comma separated list of debugging options; use [**pmdbg**(1)](/pmdbg/1.md) with the **-l** option to obtain a list of the available debugging options and their meaning.

Debugging options specific to **pmdaapache** are as follows:

| | |
| --- | --- |
| Option | Description |
| appl0 | trace each refreshData() call |
| appl1 | report badness detected in refreshData() |
| appl2 | dump internal data after each refreshData() call |

## SEE ALSO

[**PCPIntro**(1)](/PCPIntro/1.md), [**httpd**(8)](/httpd/8.md), [**pmcd**(1)](/pmcd/1.md), [**pcp.conf**(5)](/pcp.conf/5.md) and [**pcp.env**(5)](/pcp.env/5.md).
