CHECK_R...TERMARK(1p)

📦
version 1.2.0 · 4 versions
, in ubuntu resolute, ubuntu stonking

💖 NAME 💖

okay bestie, gather round — this is check_rabbitmq_watermark, a Nagios plugin that uses the RabbitMQ management API to check whether the mem_alarm or disk_free_alarm has been triggered. like, is your rabbit okay or is it screaming? that's the whole job. 🐰✨

(it lives in section 1p of the perl manual pages, iykyk.)

✨ SYNOPSIS ✨

check_rabbitmq_watermark [options] -H hostname

that's it. that's the vibe. 🎀

🦋 DESCRIPTION 🦋

so the way this works: it uses the management interface of RabbitMQ to check if the mem_alarm or disk_free_alarm has been triggered. no cap, that's literally the entire mission statement.

it uses Monitoring::Plugin and accepts all standard Nagios options. so if you already know Nagios options, you're basically home. 💅

🌸 OPTIONS 🌸

  • -h | --help — display the help text, bestie. like when you're lost, ask for help, it's iconic 💖
  • -v | --verbose — verbose output. more words. more info. we love a chatty flag 🗣️
  • -t | --timeout — set a timeout for the check, in seconds ⏱️
  • -H | --hostname | --host — the host to connect to. this is the one you gotta give it 🫶
  • --port — the port to connect to (default: 55672)
  • --ssl — use SSL when connecting (default: false). glow up your connection 🔒
  • --vhost — the vhost to create the test queue within (default: /)
  • -n | --node — the node name (default is hostname)
  • --username | --user — the user to connect as (default: guest)
  • --pass — the password for the user (default: guest)
ngl the guest/guest default is giving "default credentials" energy, which is exactly why it works on a fresh install. 🙈

🎀 EXAMPLES 🎀

the defaults all work with a standard fresh install of RabbitMQ, and all that is needed is to specify the host to connect to:

check_rabbitmq_watermark -H rabbit.example.com

this returns a standard Nagios result:

RABBITMQ_ALIVENESS OK - vhost: /

you can choose a different vhost to use for the check also:

check_rabbitmq_watermark -H rabbit.example.com --vhost /foo

look at her go. 🔥

💀 ERRORS 💀

the check tries to provide useful error messages on the status line for standard error conditions. so it won't leave you on read. 💌

otherwise, it returns the HTTP Error message returned by the management interface.

👑 EXIT STATUS 👑

returns zero if the check is OK — otherwise returns standard Nagios exit codes to signify WARNING, UNKNOWN or CRITICAL state. so the exit code is the whole mood ring basically. 🌈

🌈 SEE ALSO 🌈

💜 LICENSE 💜

this file is part of nagios-plugins-rabbitmq.

Copyright 2010, Platform 14.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

🫶 AUTHOR 🫶

James Casey <jamesc.000@gmail.com>

okay that's the whole page, no notes. this gem is from perl v5.40.1, dated 2026-01-26, and the manpage goes by CHECK_R...TERMARK(1p) if you're searching for her. periodt. 💅✨

📦 where this page comes from