Permalink
Browse files

Update the readme and LICENSE

  • Loading branch information...
1 parent 0c01404 commit 815e7df2165a494ce0fb63511ce9c53bab277d69 Gavin M. Roy committed Oct 26, 2012
Showing with 101 additions and 0 deletions.
  1. +25 −0 LICENSE
  2. +76 −0 README.md
View
25 LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2012, MeetMe
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+ * Neither the name of the MeetMe nor the names of its contributors may be used
+ to endorse or promote products derived from this software without specific
+ prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -0,0 +1,76 @@
+rabbitmq-pulse
+==============
+rabbitmq-pulse is an *experimental* plugin that publishes information made available by the rabbitmq-management plugin
+making cluster monitoring a push event instead of something you poll for.
+
+Overview
+--------
+The rabbitmq-pulse plugin will publish node statistics to a topic exchange with a routing key of node.[hostname]. The
+message is a JSON serialized payload of data provided by the rabbitmq-management plugin.
+
+Installation
+------------
+Currently, the best way to install the plugin is to follow the instructions at http://www.rabbitmq.com/plugin-development.html and
+setup the rabbitmq-public-umbrella checkout, clone the rabbitmq-pulse directory into it and custom compile the plugin.
+
+Configuration
+-------------
+Default configuration values:
+
+- username: guest
+- virtual_host: /
+- exchange: rabbitmq-pulse
+- interval: 5000
+
+Interval is the number of miliseconds between publishing stats. To change the default configuration values, add a
+rabbitmq_pulse stanza in the rabbitmq.config file for the value you would like to override:
+
+ [{rabbitmq_config, [{username, <<"guest">>},
+ {virtual_host, <<"/">>},
+ {exchange, <<"rabbitmq-pulse">>},
+ {interval, 5000}]}]
+
+Example Node Message
+--------------------
+The following is an example stats message for a node:
+
+ Exchange: rabbitmq-pulse
+ Routing Key: node.localhost
+
+ Properties
+
+ app_id: rabbitmq-pulse
+ content_type: application/json
+ delivery_mode: 1
+ timestamp: 1351221662
+ type: rabbitmq node stats
+
+ Message:
+
+ {
+ "name": "rabbit@localhost",
+ "os_pid": "7499",
+ "type": "disc",
+ "running": true,
+ "disk_free": 169206083584,
+ "disk_free_alarm": false,
+ "disk_free_limit": 1000000000,
+ "fd_total": 1024,
+ "fd_used": 28,
+ "mem_alarm": false,
+ "mem_atom": 703377,
+ "mem_atom_used": 677667,
+ "mem_binary": 150264,
+ "mem_code": 18406789,
+ "mem_ets": 1499064,
+ "mem_limit": 5647935078,
+ "mem_proc": 12891074,
+ "mem_proc_used": 13038914,
+ "mem_used": 38600528,
+ "proc_total": 1048576,
+ "proc_used": 228,
+ "run_queue": 0,
+ "sockets_total": 829,
+ "sockets_used": 1,
+ "uptime": 6092
+ }

0 comments on commit 815e7df

Please sign in to comment.