https://github.com/junegunn/redis-stat
(UNMAINTAINED) A real-time Redis monitoring tool
https://github.com/junegunn/redis-stat
Last synced: 10 months ago
JSON representation
(UNMAINTAINED) A real-time Redis monitoring tool
- Host: GitHub
- URL: https://github.com/junegunn/redis-stat
- Owner: junegunn
- License: mit
- Created: 2012-07-22T12:47:19.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2016-12-12T16:01:16.000Z (about 9 years ago)
- Last Synced: 2025-04-11T18:22:14.562Z (11 months ago)
- Language: Ruby
- Homepage:
- Size: 2.01 MB
- Stars: 2,025
- Watchers: 116
- Forks: 339
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-redis - redis-stat - A real-time Redis monitoring tool (Performance Monitoring)
README
# redis-stat
_redis-stat_ is a simple Redis monitoring tool written in Ruby.
It is based on [INFO](http://redis.io/commands/info) command of Redis,
and thus generally won't affect the performance of the Redis instance
unlike the other monitoring tools based on [MONITOR](http://redis.io/commands/monitor) command.
_redis-stat_ allows you to monitor Redis instances
- either with vmstat-like output from the terminal
- or with the dashboard page served by its embedded web server.
## Installation
```
gem install redis-stat
```
If you have trouble setting up a Ruby environment, you can [download the
executable JAR file](https://github.com/junegunn/redis-stat/releases) and use
it instead.
## Usage
```
usage: redis-stat [HOST[:PORT][/PASS] ...] [INTERVAL [COUNT]]
-a, --auth=PASSWORD Password
-v, --verbose Show more info
--style=STYLE Output style: unicode|ascii
--no-color Suppress ANSI color codes
--csv=OUTPUT_CSV_FILE_PATH Save the result in CSV format
--es=ELASTICSEARCH_URL Send results to ElasticSearch: [http://]HOST[:PORT][/INDEX]
--server[=PORT] Launch redis-stat web server (default port: 63790)
--daemon Daemonize redis-stat. Must be used with --server option.
--version Show version
--help Show this message
```
## Running redis-stat for command-line monitoring
```
redis-stat
redis-stat 1
redis-stat 1 10
redis-stat --verbose
redis-stat localhost:6380 1 10
redis-stat localhost localhost:6380 localhost:6381 5
redis-stat localhost localhost:6380 1 10 --csv=/tmp/output.csv --verbose
```
### Screenshot
## redis-stat in web browser
When `--server` option is set, redis-stat will open up an embedded web server (default port: 63790)
in the background so that you can monitor Redis in your browser.
Since _redis-stat_ pushes updates every interval via [Server-sent events](http://www.w3.org/TR/eventsource/),
modern browsers are required to view the page.
```
redis-stat --server
redis-stat --verbose --server=8080 5
# redis-stat server can be daemonized
redis-stat --server --daemon
# Kill the daemon
killall -9 redis-stat-daemon
```
### Screenshot
## Windows support
If you're running Windows, you can only install redis-stat on
[JRuby](http://jruby.org/). Notice that fancy terminal colors will not be
printed as they are not supported in the default Windows command prompt.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
### Test
You need two Redis servers running on localhost with port 6379 and 6380 with
no password.
```sh
bundle install
bundle exec rake test
```
## About the name _redis-stat_
Since this project was supposed to be a vmstat-like monitoring script for Redis,
naming it _redis-stat_ seemed like a nice idea. That was when I was unaware of the existence of
the original [redis-stat](https://github.com/antirez/redis-tools/blob/master/redis-stat.c)
included in [redis-tools](https://github.com/antirez/redis-tools) written by the creator of Redis himself. (My bad)
Although the original C-version hasn't been updated for the past couple of years, you might want to check it out first.