Scroll to navigation

CHECK_RABBITMQ_EXCHANGE(1p) User Contributed Perl Documentation CHECK_RABBITMQ_EXCHANGE(1p)

NAME

check_rabbitmq_exchange - Nagios plugin using RabbitMQ management API to check the average rate of messages per second during a given period of time on a given exchange

SYNOPSIS

check_rabbitmq_overview [options] -H hostname --queue exchange --period period

DESCRIPTION

Use the management interface of RabbitMQ to get the average rate of confirmed, published in and published out messages per second in a given period of time. 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

Display help text
Verbose output
Set a timeout for the check in seconds
The host to connect to
The port to connect to (default: 15672)
Use SSL when connecting (default: false)
The user to connect as (default: guest)
The password for the user (default: guest)
The warning levels for each average rate of confirmed, published_in and published_out messages per second for the given period of time. This field consists of one to three comma-separated thresholds. Specify -1 if no threshold for a particular average rate.
The critical levels for each average rate of confirmed, published_in and published_out messages per second for the given period of time. This field consists of one to four comma-separated thresholds. Specify -1 if no threshold for a particular average rate.

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 average rates are less than 2 messages confirmed per second, less than 2 published_in messages per second, or less than 4 published_out messages per second use

--critical=2:,2:,4:

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_exchange -H rabbit.example.com

This returns a standard Nagios result:

    RABBITMQ_OVERVIEW OK - confirm_avg_rate OK (2.5) publish_in_avg_rate OK (2.5)
      publish_out_avg_rate OK (5) | confirm_avg_rate=2.5;;
      publish_in_avg_rate=2.5;; publish_out_avg_rate=5;;

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.

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

Maria Fernandez

2025-10-05 perl v5.40.1