CHECK_...VERVIEW(1p)

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

💖 check_rabbitmq_overview — the manual, but make it a group chat 💖

okay bestie, sit down, hydrate, and let me tell you about check_rabbitmq_overview — it's a Nagios plugin that uses the RabbitMQ management API to count the messages pending on the broker. yes, we're counting messages. it's giving accounting but for bunnies 🐰✨

this page lives in the User Contributed Perl Documentation, iykyk 📖

✨ NAME ✨

check_rabbitmq_overview — Nagios plugin using RabbitMQ management API to count the messages pending on the broker.

like. that's it. that's the whole vibe. it counts your pending messages and tells nagios about it. 🦋

✨ SYNOPSIS ✨

check_rabbitmq_overview [options] -H hostname

that's the shape of it, bestie. options go in, hostname goes at the end, magic happens. 💅

✨ DESCRIPTION ✨

so here's the tea ☕ — this plugin uses the management interface of RabbitMQ to count the number of pending, ready, and unacknowledged messages. those counts get published as performance metrics for the check. metrics! for the check! iconic. 📊

and because we're ✨thorough✨, you can set critical and warning thresholds for each of the metrics individually. not one threshold for everything — per metric. slay.

it uses Monitoring::Plugin and accepts all standard Nagios options. so if you already know your Nagios flags, you're already fluent. no cap. 🫶

✨ OPTIONS ✨

every single one, bestie, no skipping, this is a full send 🎀

  • -h | --help — display help text. the classic. the legend. 👑
  • -v | --verbose — verbose output. it will simply tell you more things.
  • -t | --timeout — set a timeout for the check, in seconds. patience is a finite resource, so is this.
  • -H | --hostname | --host — the host to connect to. the main character of the argument list, honestly. 🌟
  • --port — the port to connect to (default: 55672).
  • --ssl — use SSL when connecting (default: false). security era 🔒
  • --username | --user — the user to connect as (default: guest).
  • --pass — the password for the user (default: guest).
  • -w | --warning — the warning levels for each count of messages, messages_ready and messages_unacknowledged. this field consists of three comma-separated integers. specify -1 if no threshold for a particular count.
  • -c | --critical — the critical levels for each count of messages, messages_ready and messages_unacknowledged. this field consists of three comma-separated integers. specify -1 if no threshold for a particular count.
not me emphasizing this: -w and -c each take three comma-separated integers, in the order messages, messages_ready, messages_unacknowledged. and -1 means "no threshold here, we're chill for this one". 💅

✨ EXAMPLES ✨

the defaults all work with a standard fresh install of RabbitMQ — like, out of the box, plug and play, no setup arc 🧚 — and all that is needed is to specify the host to connect to:

check_rabbitmq_overview -H rabbit.example.com

and this returns a standard Nagios result. look at it. it's beautiful:

RABBITMQ_OVERVIEW OK - messages OK (25794) messages_ready OK (22971)
  messages_unacknowledged OK (2823) | messages=25794;;
  messages_ready=22971;; messages_unacknowledged=2823;;

the way that perfdata line just sits there with all those semicolons… ate. 💀✨

✨ ERRORS ✨

the check tries to provide useful error messages on the status line for standard error conditions. so when things go wrong, it's not just a mysterious void. it talks. 🫶

otherwise, it returns the HTTP Error message returned by the management interface. raw, unfiltered, straight from the API. 😭

✨ EXIT STATUS ✨

returns zero if the check is OK. otherwise it returns standard Nagios exit codes to signify WARNING, UNKNOWN, or CRITICAL state.

translation: 0 = we're good, anything else = something's up, check the vibe 🙈

✨ 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.

okay legal bestie, real talk: don't skip the license. it's short, it's sweet, it's legally binding. periodt. 💅

✨ AUTHOR ✨

James Casey <jamesc.000@gmail.com> 👑

go off, James. icon behavior.

and that's the whole page bestie!! this one's CHECK_...VERVIEW(1p), shipped as part of perl v5.40.1, dated 2026-01-26. you understood the assignment, and so did the plugin. slay safe out there 🌈💖🦋

📦 where this page comes from