.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "CHECK_RABBITMQ_OVERVIEW 1p" .TH CHECK_RABBITMQ_OVERVIEW 1p "2023-09-29" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" check_rabbitmq_overview \- Nagios plugin using RabbitMQ management API to count the messages pending on the broker .SH "SYNOPSIS" .IX Header "SYNOPSIS" check_rabbitmq_overview [options] \-H hostname .SH "DESCRIPTION" .IX Header "DESCRIPTION" Use the management interface of RabbitMQ to count the number of pending, ready and unacknowledged messages. These are published as performance metrics for the check. .PP Critical and warning thresholds can be set for each of the metrics. .PP It uses Monitoring::Plugin and accepts all standard Nagios options. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\-h | \-\-help" 4 .IX Item "-h | --help" Display help text .IP "\-v | \-\-verbose" 4 .IX Item "-v | --verbose" Verbose output .IP "\-t | \-\-timeout" 4 .IX Item "-t | --timeout" Set a timeout for the check in seconds .IP "\-H | \-\-hostname | \-\-host" 4 .IX Item "-H | --hostname | --host" The host to connect to .IP "\-\-port" 4 .IX Item "--port" The port to connect to (default: 55672) .IP "\-\-ssl" 4 .IX Item "--ssl" Use \s-1SSL\s0 when connecting (default: false) .IP "\-\-username | \-\-user" 4 .IX Item "--username | --user" The user to connect as (default: guest) .IP "\-\-pass" 4 .IX Item "--pass" The password for the user (default: guest) .IP "\-w | \-\-warning" 4 .IX Item "-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. .IP "\-c | \-\-critical" 4 .IX Item "-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 .SH "EXAMPLES" .IX Header "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: .PP .Vb 1 \& check_rabbitmq_overview \-H rabbit.example.com .Ve .PP This returns a standard Nagios result: .PP .Vb 3 \& RABBITMQ_OVERVIEW OK \- messages OK (25794) messages_ready OK (22971) \& messages_unacknowledged OK (2823) | messages=25794;; \& messages_ready=22971;; messages_unacknowledged=2823;; .Ve .SH "ERRORS" .IX Header "ERRORS" The check tries to provide useful error messages on the status line for standard error conditions. .PP Otherwise it returns the \s-1HTTP\s0 Error message returned by the management interface. .SH "EXIT STATUS" .IX Header "EXIT STATUS" Returns zero if check is \s-1OK\s0 otherwise returns standard Nagios exit codes to signify \s-1WARNING, UNKNOWN\s0 or \s-1CRITICAL\s0 state. .SH "SEE ALSO" .IX Header "SEE ALSO" See \fBMonitoring::Plugin\fR\|(3) .PP The RabbitMQ management plugin is described at http://www.rabbitmq.com/management.html .SH "LICENSE" .IX Header "LICENSE" This file is part of nagios-plugins-rabbitmq. .PP Copyright 2010, Platform 14. .PP Licensed under the Apache License, Version 2.0 (the \*(L"License\*(R"); you may not use this file except in compliance with the License. You may obtain a copy of the License at .PP .Vb 1 \& http://www.apache.org/licenses/LICENSE\-2.0 .Ve .PP Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \*(L"\s-1AS IS\*(R" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,\s0 either express or implied. See the License for the specific language governing permissions and limitations under the License. .SH "AUTHOR" .IX Header "AUTHOR" James Casey