From 2583b9fb70783ce03fda765fc02036396480916f Mon Sep 17 00:00:00 2001 From: Stig Sandbeck Mathisen Date: Sun, 5 Oct 2014 20:12:15 +0200 Subject: [PATCH] Update documentation --- plugins/rabbitmq/rabbitmq_connections | 55 ++++++++++++++++++++------- 1 file changed, 41 insertions(+), 14 deletions(-) diff --git a/plugins/rabbitmq/rabbitmq_connections b/plugins/rabbitmq/rabbitmq_connections index 2e6970b9..9b943b93 100755 --- a/plugins/rabbitmq/rabbitmq_connections +++ b/plugins/rabbitmq/rabbitmq_connections @@ -1,19 +1,46 @@ #!/bin/sh -# -# Plugin to monitor the number of connections to RabbitMQ -# -# Usage: Link or copy into /etc/munin/node.d/ -# -# Parameters -# env.conn_warn -# env.conn_crit -# -# Magic markers (optional - only used by munin-config and some -# installation scripts): -# -#%# family=auto -HOME=/tmp/ +: << =cut + +=head1 NAME + +rabbitmq_connections - monitor the number of connections to RabbitMQ + +=head1 CONFIGURATION + +You will need to add configuration to +/etc/munin/plugin-conf.d/rabbitmq_connection.conf for this plugin to +work. + +=over 2 + +=item C + +Required. Valid choices are C and C. This is required +by C. + +=item C + +Optional, default value is 500 + +=item C + +Optional, default value is 1000 + +=back + +=head2 EXAMPLE CONFIGURATION + + [rabbitmq_connections] + user rabbitmq + env.conn_warn 512 + env.conn_crit 1024 + +=head1 MAGIC MARKERS + + #%# family=contrib + +=cut # If run with the "config"-parameter, give out information on how the # graphs should look.