---
name: "check_rabbitmq_queue"
section: "1p"
platform: "linux"
package: "nagios-plugins-rabbitmq"
version: "1:1.2.0-2.5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/check_rabbitmq_queue"
---

# check\_rabbitmq\_queue(1p)

Nagios plugin using RabbitMQ management API to count the messages pending and consumers on a given queue

## NAME

check\_rabbitmq\_queue - Nagios plugin using RabbitMQ management API to count the messages pending and consumers on a given queue

## SYNOPSIS

check\_rabbitmq\_overview \[options\] -H hostname

## DESCRIPTION

Use the management interface of RabbitMQ to count the number of pending, ready and unacknowledged messages and number of consumers.  These are published as performance metrics for the check.

Critical and warning thresholds can be set for each of the metrics.

It uses Monitoring::Plugin and accepts all standard Nagios options.

## OPTIONS

- \-h \| --help

  Display help text

- \-v \| --verbose

  Verbose output

- \-t \| --timeout

  Set a timeout for the check in seconds

- \-H \| --hostname \| --host

  The host to connect to

- \--port

  The port to connect to (default: 55672)

- \--ssl

  Use SSL when connecting (default: false)

- \--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, messages\_unacknowledged and consumers.  This field consists of one to four comma-separated thresholds.  Specify -1 if no threshold for a particular count.

- \-c \| --critical

  The critical levels for each count of messages, messages\_ready, messages\_unacknowledged and consumers.  This field consists of one to four comma-separated thresholds.  Specify -1 if no threshold for a particular count.

## THRESHOLD FORMAT

The format of thresholds specified in --warning and --critical arguments is defined at \<http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT\>.

For example to be crtical if more than 100 messages, more than 90 messages\_ready, more than 20 messages\_unacknowledged or no fewer than 10 consumers use

\--critical=100,90,20,10:

## 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_queue -H rabbit.example.com
```

This returns a standard Nagios result:

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

## ERRORS

The check tries to provide useful error messages on the status line for standard error conditions.

Otherwise it returns the HTTP Error message returned by the management interface.

## EXIT STATUS

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

## SEE ALSO

See **Monitoring::Plugin**(3)

The RabbitMQ management plugin is described at http://www.rabbitmq.com/management.html

## 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\>