PMDARSYSLOG(1)

💖 PMDARSYSLOG 💖

ok so bestie, welcome to the pmdarsyslog page — that's section 1 of the General Commands Manual, if you're keeping track. it's a whole Performance Metrics Domain Agent situation and honestly? it's giving iconic. 💅

---

✨ NAME ✨

pmdarsyslog — rsyslog (reliable and extended syslog) PMDA 🦋

---

🌸 DESCRIPTION 🌸

pmdarsyslog is a Performance Metrics Domain Agent (PMDA), which is basically a little agent whose whole job is exporting metric values from the rsyslogd(8) server. no cap, that's the gig. 👑

if you want further deets about rsyslog itself, it's all over at http://www.rsyslog.com/. go look, i'll wait. 💜

---

🎀 INSTALLATION 🎀

ok so if you want access to the names and the values for the rsyslog performance metrics, do the following as root:

# cd $PCP_PMDAS_DIR/rsyslog
# ./Install

and to uninstall — which, tragic, but sometimes necessary 😭 — do the following as root:

# cd $PCP_PMDAS_DIR/rsyslog
# ./Remove

heads up bestie: pmdarsyslog is launched by pmcd(1) and should never be executed directly. like, never ever. the Install and Remove scripts are the ones that notify pmcd(1) when the agent is installed or removed, so just let them cook. 🔥

and in order to use this agent, rsyslog stats gathering must be enabled. this is done by adding the lines:

module(load="impstats" interval="10" severity="7")
if $syslogtag contains 'rsyslogd-pstats' then {
    action(
        name="pstats-for-pcp"
        type="ompipe"
        template="RSYSLOG_FileFormat"
        pipe="/var/log/pcp/rsyslog/stats"
    )
    stop
}

to your rsyslog.conf(5) configuration file after installing the PMDA. periodt. ✨

---

🫶 FILES 🫶

• $PCP_LOG_DIR/rsyslog/stats — a named pipe containing statistics exported from rsyslog, usually created by the PMDA Install script. it's the main character of the plumbing, fr fr.
• $PCP_PMDAS_DIR/rsyslog/rsyslog.conf — optional configuration file for pmdarsyslog. optional! lowkey chill of it.
• $PCP_PMDAS_DIR/rsyslog/Install — installation script for the pmdarsyslog agent.
• $PCP_PMDAS_DIR/rsyslog/Remove — undo installation script for the pmdarsyslog agent. the breakup script. 💔
• $PCP_LOG_DIR/pmcd/rsyslog.log — default log file for error messages from pmdarsyslog. that's where the drama gets written down. 📝

---

🌈 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). iykyk. 💅

---

👑 SEE ALSO 👑

PCPIntro(1), pmcd(1) and rsyslogd(1). go read them, they're all slay in their own way. 🍓

---

ok that's the whole page bestie, you ate that. mwah 💖

this was brought to you by Performance Co-Pilot (that's the source, and the version is PCP, iconic name honestly) — and this little page lives in the PMDARSYSLOG(1) section of the manual, so if you need it again, that's where to find it. bye bestie, go enable those stats 🦋✨