PMDAMONGODB(1)

💅 PMDAMONGODB(1) — the pmdamongodb page, but make it make sense

okay bestie, sit down, hydrate, because we're talking about pmdamongodb — a manual page from the General Commands Manual section, and it's literally the group chat between your MongoDB server and Performance Co-Pilot. no cap. 🦋

---

✨ NAME ✨

pmdamongodb — MongoDB database metrics. that's it, that's the whole vibe check. 💖

---

🌸 DESCRIPTION 🌸

so pmdamongodb is a Performance Co-Pilot (PCP) Performance Metrics Domain Agent (PMDA) — say that five times fast, I dare you — and what it does is extract live performance data from a running MongoDB database server. like, it's the nosy bestie who reads your server's diary in real time and reports back with receipts. 🔥

---

🎀 CONFIGURATION 🎀

first things first, bestie: pmdamongodb requires installation of the pymongo support packages — that's a general purpose Python module for querying MongoDB. no pymongo, no metrics. periodt.

next up, pmdamongodb reads an optional ini-style configuration file:

$PCP_PMDAS_DIR/mongodb/mongodb.conf

and rn this file allows for two sections: one for configuring the MongoDB socket connection, and the other for authentication. two sections, two moods, both iconic. 👑

🫶 [connection]

• host (localhost) — connect to the MongoDB socket on the given hostname. default is just chillin' on localhost, home sweet home.
• port (27017) — connect to the MongoDB socket on the given port. default port is 27017, the classic.

🔐 [authentication]

• username (empty) — username to connect to the database. default is empty, so if you need it, go fill it in.
• password (empty) — password to connect to the database. also empty by default, keep it secret, keep it safe. 🙈

---

🌈 INSTALLATION 🌈

to install, the following must be done as root:

# cd $PCP_PMDAS_DIR/mongodb
# ./Install

to uninstall, the following must be done as root:

# cd $PCP_PMDAS_DIR/mongodb
# ./Remove

⚠️ important note, bestie: pmdamongodb is launched by pmcd(1) and should never be executed directly. like, do not talk to it directly, it goes through its people. the Install and Remove scripts notify pmcd(1) when the agent is installed or removed, so everybody stays in the loop. 💅

---

🦋 FILES 🦋

• $PCP_PMDAS_DIR/mongodb/mongodb.conf — configuration file for the pmdamongodb agent.
• $PCP_PMDAS_DIR/mongodb/Install — installation script for the pmdamongodb agent.
• $PCP_PMDAS_DIR/mongodb/Remove — undo installation script for the pmdamongodb agent.
• $PCP_LOG_DIR/pmcd/mongodb.log — default log file for messages from the pmdamongodb agent.

and just so you know, the usual/default value for $PCP_PMDAS_DIR is /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp — but these settings are platform dependent, so don't come for me if your paths are doing their own thing. 😭

---

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

---

👑 SEE ALSO 👑

PCPIntro(1) and pmcd(1). go read those next, they're the supporting cast and they ate. 🍓

---

okay that's the whole page, you're officially educated 💖 this was the Performance Co-Pilot (PCP) PMDAMONGODB(1) situation, brought to you with love and zero skipped details. go forth and monitor those databases, main character. 🌟