PMDAREDIS(1)

πŸ“¦
version 7.2.2 Β· 3 versions
, in arch rolling, centos-stream 10, centos-stream 9, debian trixie, fedora 43, fedora 44, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’Ύ PMDAREDIS(1) β€” the manual, but make it cute

okay bestie, so this is pmdaredis from the General Commands Manual section β€” it's the Redis performance metrics domain agent (PMDA) and honestly? it's giving observability icon energy. πŸ“


✨ NAME ✨

pmdaredis β€” Redis performance metrics domain agent (PMDA)


🌸 DESCRIPTION 🌸

This PMDA gets its performance data by literally just sending the INFO command to a Redis (redis.io) server and seeing what comes back. no cap. and what comes back includes:

  • General information about the Redis server πŸ‘‘
  • Client connections 🫢
  • Memory consumption 🧠
  • Persistence statistics πŸ’Ύ
  • Replication statistics πŸͺž
  • CPU consumption statistics πŸ”₯
  • Redis command statistics ⌨️
  • Redis Cluster statistics 🌈
  • Database related statistics πŸ—„οΈ

The hostname (localhost), the port (6379 by default) and all the other config info must be specified in the $PCP_PMDAS_DIR/redis/redis.conf file. fr fr, it's mandatory.

# cd $PCP_PMDAS_DIR/redis
# [ edit redis.conf ]
  host=localhost.localdomain:6379

Once that's all set up, you can access the names and values for the redis performance metrics by doing the following as root:

# cd $PCP_PMDAS_DIR/redis
# ./Install

and to uninstall, the following must be done as root:

# cd $PCP_PMDAS_DIR/redis
# ./Remove

okay so important thing: pmdaredis is launched by pmcd(1) and should never be executed directly. like, don't do it. not the vibe. the Install and Remove scripts notify pmcd(1) when the agent is installed or removed, so they handle all that for you. πŸ’…


πŸŽ€ FILES πŸŽ€

  • $PCP_PMDAS_DIR/redis/redis.conf β€” mandatory configuration file listing monitored redis instances. mandatory!! did she stutter? πŸ’–
  • $PCP_PMDAS_DIR/redis/Install β€” installation script for the pmdaredis agent
  • $PCP_PMDAS_DIR/redis/Remove β€” undo installation script for the pmdaredis agent
  • $PCP_LOG_DIR/pmcd/redis.log β€” default log file for error messages from pmdaredis

🌈 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) and pmcd(1). go read them, bestie, they're iconic.


and that's the whole page!! brought to you by Performance Co-Pilot / PCP, and yes the header really did say PMDAREDIS(1) at the top and the footer really did say Performance Co-Pilot, PCP, PMDAREDIS(1) at the bottom β€” consider them mentioned, slay βœ¨πŸŽ€πŸ’–

πŸ“¦ where this page comes from