Welcome to collectd-rabbitmq’s documentation!¶

Contents:

collectd-rabbitmq¶

“A collected plugin, written in python, to collect statistics from RabbitMQ.”

Free software: Apache license
Documentation: https://collectd-rabbitmq.readthedocs.org.
For the older single file version see https://github.com/NYTimes/collectd-rabbitmq/tree/0.1.0

Features¶

Support queue, exchange, and node stats,

Configuration¶

This plugin supports a small amount of configuration options:

Username: The rabbitmq user. Defaults to guest
Password: The rabbitmq user password. Defaults to guest
Realm: The http realm for authentication. Defaults to RabbitMQ Management
Scheme: The protocol that the rabbitmq management API is running on. Defaults to http
Host: The hostname that the rabbitmq server running on. Defaults to localhost
Port: The port that the rabbitmq server is listening on. Defaults to 15672
Ignore: The queue to ignore, matching by Regex. See example.

Example Configuration¶

``` LoadPlugin python <Plugin python>

ModulePath “/usr/lib/python2.7/site-packages/collectd-rabbitmq” LogTraces true Interactive false Import rabbitmq <Module rabbitmq>

Username “guest” Password “guest” Realm “RabbitMQ Management” Host “localhost” Port “15672” <Ignore “queue”>

Regex “amq-gen-.*” Regex “tmp-.*”

</Ignore>

</Module>

</Plugin> ```

Nodes¶

For each node the following statistics are gathered:

disk_free_limit
fd_total
fd_used
mem_limit
mem_used
proc_total
proc_used
processors
run_queue
sockets_total
sockets_used

Queues¶

For each queue in each vhost the following statistics are gathered: _NOTE_: The / vhost name is sent as default

message_stats
- deliver_get
- deliver_get_details
  
  rate
- get
- get_details
  
  rate
- publish
- publish_details
  
  rate
- redeliver
- redeliver_details
  
  rate
messages
messages_details
- rate
messages_ready
messages_ready_details
- rate
messages_unacknowledged
messages_unacknowledged_details * rate
memory
consumers

Exchanges¶

For each exchange in each vhost the following statistics are gathered: _NOTE_: The / vhost name is sent as default

disk_free
disk_free_limit
fd_total
fd_used
mem_limit
mem_used
proc_total
proc_used
processors
run_queue
sockets_total
sockets_used

Credits¶

This package was created with Cookiecutter and the cookiecutter-pypackage project template.

Installation¶

At the command line:

$ easy_install collectd-rabbitmq

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv collectd-rabbitmq
$ pip install collectd-rabbitmq

This plugins requires that the Collectd type database be updated. Each of these statistics have their own custom enter in collectd’s type database. To add these types defined in this example run the following command:

$ cat config/types.db.custom >> /usr/share/collectd/types.db

Configuration¶

Example Configuration:

See this example config.

TypesDB "/usr/share/collectd/types.db"
TypesDB "/mnt/projects/collectd-rabbitmq/config/types.db.custom"

LoadPlugin logfile
<Plugin logfile>
       LogLevel info 
       File STDOUT
       Timestamp true
       PrintSeverity false
</Plugin>

LoadPlugin python
<Plugin python>
  ModulePath "/mnt/projects/collectd-rabbitmq/"
  LogTraces true
  Interactive false

  Import rabbitmq
  <Module rabbitmq>
    Username "guest"
    Password "guest"
    Realm "RabbitMQ Management"
    Host "localhost"
    Port "15672"
  </Module>
</Plugin>

LoadPlugin amqp
<Plugin "amqp">
  <Publish "name">
     Host "localhost"
     Port "5672"
     VHost "/"
     User "guest"
     Password "guest"
     Exchange "collectd"
     RoutingKey "graphite"
     Persistent false
     Format "Graphite"
     StoreRates false
  </Publish>
</Plugin>

Usage¶

To use collectd-rabbitmq in a project:

import collectd-rabbitmq

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/NYTimes/collectd-rabbitmq/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

collectd-rabbitmq could always use more documentation, whether as part of the official collectd-rabbitmq docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/NYTimes/collectd-rabbitmq/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up collectd-rabbitmq for local development.

Fork the collectd-rabbitmq repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/collectd-rabbitmq.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv collectd-rabbitmq
$ cd collectd-rabbitmq/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 collectd-rabbitmq tests
$ python setup.py test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/jimbydamonk/collectd-rabbitmq/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_collectd_plugin

History¶

0.1.0 (2014-09-18)¶

First public release.

Welcome to collectd-rabbitmq’s documentation!¶

collectd-rabbitmq¶

Features¶

Configuration¶

Example Configuration¶

Nodes¶

Queues¶

Exchanges¶

Credits¶

Installation¶

Configuration¶

Usage¶

Contributing¶

Types of Contributions¶

Report Bugs¶

Fix Bugs¶

Implement Features¶

Write Documentation¶

Submit Feedback¶

Get Started!¶

Pull Request Guidelines¶

Tips¶

History¶

0.1.0 (2014-09-18)¶

Indices and tables¶

Table Of Contents

Related Topics