NAME

       check_rabbitmq_aliveness - Nagios plugin using RabbitMQ management API to check liveness by send/receive
       a message through a vhost

SYNOPSIS

       check_rabbitmq_aliveness [options] -H hostname

DESCRIPTION

       Use the management interface of RabbitMQ to check that the server is alive.  It declares a test queue,
       then publishes and consumes a message.

       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)

       --vhost
           The vhost to create the test queue within (default: /)

       --username | --user
           The user to connect as (default: guest)

       --pass
           The password for the user (default: guest)

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_aliveness -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_aliveness -H rabbit.example.com --vhost /foo

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>

perl v5.38.2                                       2024-05-08                       CHECK_RABBITMQ_ALIVENESS(1p)