ringoteam / redmon

A web interface for managing redis: cli, admin, and live monitoring

Redmon

Simple sinatra based dashbord for redis. After seeing the fnordmetric project I was inspired to write this. Some of the ideas there have be carried over here.

---

Watch your redis server live.

---

Interact with redis using a familiar cli interface.

---

Dynamically update your server configuration.

---

Installation

Redmon is available as a RubyGem:

gem install redmon

Usage

$ redmon -h
Usage: /Users/sean/codez/steelThread/redmon/vendor/ruby/1.9.1/bin/redmon (options)
    -a, --address ADDRESS            The thin bind address for the app (default: 0.0.0.0)
    -n, --namespace NAMESPACE        The root Redis namespace (default: redmon)
    -i, --interval SECS              Poll interval in secs for the worker (default: 10)
    -p, --port PORT                  The thin bind port for the app (default: 4567)
    -r, --redis URL                  The Redis url for monitor (default: redis://127.0.0.1:6379)
    -s, --secure CREDENTIALS         Use basic auth. Colon separated credentials, eg admin:admin.
        --no-app                     Do not run the web app to present stats
        --no-worker                  Do not run a worker to collect the stats

$ redmon
>> Thin web server (v1.3.1 codename Triple Espresso)
>> Maximum connections set to 1024
>> Listening on 0.0.0.0:4567, CTRL+C to stop
[12-03-10 15:49:40] listening on http#0.0.0.0:4567

If you want to simulate a weak load on redis

$ ruby load_sim.rb

Open your browser to 0.0.0.0:4567

Using in a Rails application

Add to Gemfile:

gem 'redmon', require: false

Add to config/routes.rb:

require 'redmon/app'
mount Redmon::App => '/redmon'

You can configure the Redmon using an initializer config/initializers/redmon.rb:

Redmon.configure do |config|
  config.redis_url = 'redis://127.0.0.1:6379'
  config.namespace = 'redmon'
end

This will mount the Redmon application to the /redmon/ path. The trailing slash is important. The worker that gathers the redis info stats will not be started when Redmon is mounted. In order to get a worker running inside of your Rails app you can try this Railtie based approach.

License

Copyright (c) 2012 Sean McDaniel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use, copy and modify copies of the Software, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.