PMDANGINX(1)

✨ PMDANGINX ✨

okay so bestie, welcome to the pmdanginx page — that's section 1 of the General Commands Manual, iykyk 💅

---

💖 NAME 💖

pmdanginx — it's the nginx performance metrics domain agent, aka the PMDA. Say it with me: Performance Metrics Domain Agent. Slay.

---

🌸 DESCRIPTION 🌸

So pmdanginx is a Performance Metrics Domain Agent (PMDA), and what it does is literally export performance metrics straight out of nginx(8) 🦋

And what even is nginx(8)? Bestie. It's an HTTP and reverse proxy server, a mail proxy server, and a generic TCP proxy server. Main character energy fr fr 👑

---

🎀 INSTALLATION 🎀

Okay so this PMDA has one requirement, and it's non-negotiable: the nginx stub_status module has to be active and available at http://localhost/nginx_status. No stub_status, no vibes. 😭

To enable that module, the "server" section of your nginx.conf configuration file should contain exactly this:

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

✨ Now let's verify the instrumentation is actually available. There are two checks — compile-time, then run-time:

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

Then install the nginx PMDA by running the Install script as root:

# cd $PCP_PMDAS_DIR/nginx
# ./Install

And to uninstall, the following must be done as root too:

# cd $PCP_PMDAS_DIR/nginx
# ./Remove

🫶 Heads up bestie: pmdanginx is launched by pmcd(1) and should never be executed directly. Like, ever. The Install and Remove scripts are the ones that notify pmcd(1) when the agent is installed or removed, so let them do their job. 💅

---

🌈 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. And the $PCP_CONF variable may be used to specify an alternative configuration file, as described in pcp.conf(5). Periodt. 💜

---

⭐ SEE ALSO ⭐

PCPIntro(1), pmcd(1) and nginx(8) — go read those next, bestie, they're iconic 🦋

---

This whole thing is brought to you by Performance Co-Pilot — that's PCP, the source, and it's the PMDANGINX(1) page, mwah 💖 bye bestie, go watch your metrics ✨