Monittr : A Web Interface for Monit Statistics

Monittr provides a Ruby interface for the Monit systems management system.

Its main goal is to display statistics from multiple Monit instances in an attractive web interface.

Monittr loads XML from the web server embedded in Monit and makes it accessible as Ruby objects.

It also provides helpers for Sinatra applications, to display the information as HTML. You can insert the Monit information into any page, or create a dedicated page.

You can use the default template, or create your own. The default template is located in lib/monittr/sinatra/template.erb.

The default template is pictured below.

Screenshot: Monittr, a web interface for Monit statistics

Usage

First, clone or download the sources from Github, to get the latest version:

$ git clone http://github.com/karmi/monittr.git
$ cd monittr

You can try the Ruby interface in a IRB console:

$ irb -Ilib -rubygems -rmonittr

You have to pass one or more full URLs to a local or remote Monit web server output:

cluster = Monittr::Cluster.new ['http://localhost:2812/']

In case you don't have a running Monit at hand, use the provided FakeWeb setup:

require 'fakeweb'
FakeWeb.register_uri(:get, 'http://localhost:2812/_status?format=xml', :body => File.read('test/fixtures/status.xml') ); nil

cluster = Monittr::Cluster.new ['http://localhost:2812/']

Now, you can display the information from the cluster:

cluster.servers.size

server = cluster.servers.first
server.system.status
server.system.load

server.filesystems.first.name
server.filesystems.first.percent

server.processes.first.name
server.processes.first.cpu
server.processes.first.memory

...

You can also check out the HTML display by running the example application:

$ ruby examples/application.rb
$ open http://localhost:4567/

You should see the information about two faked Monit instances in your browser.

Provide the URLs to live Monit instances by setting the appropriate option in application.rb:

set :monit_urls,  %w[ http://production.example.com:2812 http://staging.example.com:2812 ]

You may also need to comment out the FakeWeb section, if you're passing localhost URLs.

Customization

It's easy to customize the HTML output by setting the appropriate options in your Sinatra application.

set :template,   Proc.new { File.join(root, 'template.erb') }
set :stylesheet, '/path/to/my/stylesheet'

Please see the example application for prepared examples.

Installation

The best way how to install the gem is from the source:

$ git clone http://github.com/karmi/monittr.git
$ cd monittr
$ rake install

Stable versions of the gem can be installed from Rubygems:

$ gem install monittr

Other

The code is useful for the intended purpose as it is, but if you've got any feedback, suggestions or patches, please send me an e-mail or use Github Issues/Pull Requests.

Check out the monit gem for another Ruby interface to Monit.


Karel Minarik