CHECK-PATRONI(1)

📦
version 2.2.0 · 3 versions
, in debian trixie, ubuntu resolute

💖 check-patroni — like, the manual page, but make it make sense 💖

okay bestie, pull up a chair 🫶 this is the user manual for check-patroni, a Nagios plugin that lives in the User Commands corner of your man pages. Think of it as the little gossipy friend who keeps tabs on your Patroni cluster so you don't have to 👑

✨ NAME ✨

check-patroni — a Nagios plugin to check on patroni. that's it, that's the vibe. 💅

🦋 SYNOPSIS 🦋

check_patroni [OPTIONS] COMMAND [ARGS]...

like, options first, then a command, then whatever args that command wants. no cap. ✨

🌸 DESCRIPTION 🌸

okay so. this is a Nagios plugin that uses Patroni's REST API to monitor a Patroni cluster. it pokes the API, it looks at the cluster, it reports back. main character energy fr fr. 👑

💅 OPTIONS 💅

  • --config FILE — read option defaults from the specified INI file. the default is config.ini, so if you don't say anything it's gonna go looking for that. 🙈
  • -e, --endpoints TEXT — the Patroni API endpoint. you can drop it multiple times, or hand over a list of comma separated addresses, your call bestie. here's the tea though ☕: the node services check the status of one node, so if you list several addresses they should point to different interfaces on the same node. the cluster services check the status of the whole cluster, so for those it's better to give a list of all the Patroni node addresses. default is http://127.0.0.1:8008 🎀
  • --cert_file PATH — file with the client certificate. 🔐
  • --key_file PATH — file with the client key. 🔑
  • --ca_file PATH — the CA certificate. 🏛️
  • -v, --verbose — increase verbosity! -v for info, -vv for warning, -vvv for debug. the more v's, the more it tells you. obsessed. 🔥
  • --version — shows the version, obviously. ✨
  • --timeout INTEGER — timeout in seconds for the API queries, and 0 disables the timeout entirely. default is 2. ⏰
  • --help — show this message and exit. the classic. 🫶

👑 Commands 👑

these are the actual checks you can run. pick your fighter:

  • cluster_config_has_changed — check if the hash of the configuration... 🌈
  • cluster_has_leader — check if the cluster has a leader. 👑
  • cluster_has_replica — check if the cluster has healthy replicas... 🦋
  • cluster_has_scheduled_action — check if the cluster has a scheduled... 📅
  • cluster_is_in_maintenance — check if the cluster is in maintenance... 🛠️
  • cluster_node_count — count the number of nodes in the cluster. 🔢
  • node_is_alive — check if the node is alive ie patroni is... 💀
  • node_is_leader — check if the node is a leader node. 🌟
  • node_is_pending_restart — check if the node is in pending restart... 🔄
  • node_is_primary — check if the node is the primary with the... 🌸
  • node_is_replica — check if the node is a replica with no... 🌙
  • node_patroni_version — check if the version is equal to the input 🎀
  • node_tl_has_changed — check if the timeline has changed. ⏳

and that's the whole page bestie, no notes 💖 this was Version 2.2.0, dated April 2025, straight out of the CHECK-PATRONI(1) manual. go monitor something iconic. periodt. 💅✨🫶

📦 where this page comes from