Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kumarnitin committed Aug 4, 2012
1 parent 46aa122 commit 3f1160f
Showing 1 changed file with 3 additions and 37 deletions.
40 changes: 3 additions & 37 deletions README.md
Expand Up @@ -5,43 +5,9 @@ Visualize your redis instances, analyze query patterns and spikes.

![Redis Live](https://github.com/kumarnitin/RedisLive/blob/master/design/redis-live.png?raw=true "Redis Live")

Installation
------------
**Install Dependencies**
+ [tornado](https://github.com/facebook/tornado) `pip install tornado`
+ [redis.py] (https://github.com/andymccurdy/redis-py) `pip install redis`
+ [python-dateutil] (http://labix.org/python-dateutil) `pip install python-dateutil`

You'll also need argparse if you're running Python < 2.7:

+ [argparse] (http://code.google.com/p/argparse/) `pip install argparse`

**Get RedisLive**
+ Clone the repo `git clone https://github.com/kumarnitin/RedisLive.git`, or [download the latest release](https://github.com/kumarnitin/RedisLive/zipball/master)

**Configuration**
+ edit redis-live.conf :
+ update the value of the key `RedisServers` to the redis instances you want to monitor. You can monitor multiple instances by appending more values to the RedisServers list.
+ update the value of the key `RedisStatsServer` to the redis instance you will use to store RedisLive data (this redis instance is different from the redis instances you are monitoring).
+ passwords can be added as an optional parameter for any redis instance

if you don't have a spare redis instance to use to store RedisLive data, then you can configure RedisLive to use sqlite by changing to ` "DataStoreType" : "sqlite" `

**Start RedisLive**
+ start the monitoring script `./redis-monitor.py --duration=120` duration is in seconds ([see caveat](#caveat-on-monitoring-redis))
+ start the webserver `./redis-live.py`
+ RedisLive is now running @ `http://localhost:8888/index.html`


Caveat on monitoring redis
--------------------------

Currently the only hook into monitoring a redis instance is Redis [MONITOR](http://redis.io/commands/monitor) command, which streams back every command processed and reduces the throughput of the redis instance. It is recommended to run redis-monitor with --duration suitable for your redis deployment and scheduling it to run periodically as a cron job.

Feedback
--------

Have feedback, feature request or improvements you'd like to see? Drop me a note [@nkrode](https://twitter.com/#!/nkrode) or just fork and send a pull request :-)
Setup Instructions
------------------
Details and setup instructions [here](http://www.nkrode.com/article/real-time-dashboard-for-redis)

Authors
-------
Expand Down

1 comment on commit 3f1160f

@josegonzalez
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is bad. If your blog goes down - and it will - then the instructions go away.

As a general rule of thumb, I'd keep ALL of the documentation with the repo, so that way it never gets out of date. Readme Driven Development!

Please sign in to comment.