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

# pmdanginx(1)

nginx performance metrics domain agent (PMDA)

## NAME

**pmdanginx** - nginx performance metrics domain agent (PMDA)

## DESCRIPTION

**pmdanginx** is a Performance Metrics Domain Agent (PMDA) which exports performance metrics from [**nginx**(8)](/nginx/8.md) - an HTTP and reverse proxy server, a mail proxy server, and a generic TCP proxy server.

## INSTALLATION

This PMDA requires that the **nginx** stub\_status module is active and available at **http://localhost/nginx\_status**.

In order to enable this module, the "server" section of the *nginx.conf* configuration file should contain the following.

```
location /nginx_status {
    stub_status on;
    access_log off;
    allow 127.0.0.1;
    allow ::1;
    deny all;
}
```

Instrumentation availability can be verified using these commands (compile-time then run-time checks):

```
# nginx -V 2>&1 | grep -o with-http_stub_status_module
# curl http://localhost/nginx_status
```

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

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

To uninstall, the following must be done as root:

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

**pmdanginx** 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/nginx/nginx.conf**

  optional configuration file for **pmdanginx**

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

  installation script for the **pmdanginx** agent

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

  undo installation script for the **pmdanginx** agent

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

  default log file for error messages from **pmdanginx**

## 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), [**pmcd**(1)](/pmcd/1.md) and [**nginx**(8)](/nginx/8.md).