Skip to content
Manage your Redis instance (see keys, memory used, connected client, etc...)
Ruby HTML JavaScript CSS
Branch: master
Clone or download
BorisBresciani Merge pull request #24 from estebaninformatica/feature/remove_downcas…
…e_in_search

Remove downcase, i need search with upcase params
Latest commit ddcf8da Feb 20, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Add search by memory size Feb 18, 2020
bin rubocop clean Feb 7, 2020
config Refactor search Feb 12, 2020
gemfiles First commit Feb 7, 2020
images First commit Feb 7, 2020
lib Remove downcase, i need search with upcase params Feb 19, 2020
spec Add search by memory size Feb 18, 2020
.coveralls.yml add service_name: travis-pro Feb 7, 2020
.gitignore First commit Feb 7, 2020
.rspec First commit Feb 7, 2020
.rubocop.yml First commit Feb 7, 2020
.travis.yml Add travis Feb 7, 2020
Gemfile First commit Feb 7, 2020
Gemfile.lock Merge conflict Feb 12, 2020
MIT-LICENSE First commit Feb 7, 2020
README.md Refactor search Feb 12, 2020
Rakefile rubocop clean Feb 7, 2020
redis_web_manager.gemspec rubocop clean Feb 7, 2020

README.md

RedisWebManager

Gem Version Maintainability Build Status security Gem Coverage Status

Web interface that allows you to manage easily your Redis instance (see keys, memory used, connected client, etc...).

Check your stats

The Dashboard allows you to check the Memory usage, CPU and Redis clients.

RedisWebManager Dashboard

Manage your redis keys

You can easily edit and delete any keys stored in your redis database.

RedisWebManager Keys

Keep an eye on your redis clients

Check how many clients are connected and their infos.

RedisWebManager Clients

Installation

Add this line to your application's Gemfile:

gem 'redis_web_manager'

And then execute:

$ bundle

Or install it yourself as:

$ gem install redis_web_manager

Add the custom route in your routes.rb:

mount RedisWebManager::Engine => '/redis_web_manager'

Access to RedisWebManager at /redis_web_manager

Configuration

You can configure RedisWebManager:

# initializers/redis_web_manager.rb

RedisWebManager.configure do |config|
  config.redis = Redis.new(db: 1) # Default Redis.new (Instance of Redis)
  config.lifespan = 2.days # Default 15.days (Lifespan of each keys for dashboard)
  config.authenticate = proc {
                           authenticate_or_request_with_http_basic do |username, password|
                              username == 'TEST' && password == 'TEST'
                            end
                          } # Default nil (Authenticate method to secure tools)
end

Collect data for dashboard

In order to have data on your dashboard you must collect the data like this:

data = RedisWebManager::Data.new
data.perform

If you are using a system to run background tasks in your application (like Sidekiq, Sucker Punch or ActiveJob), you can write your own background task to update the dashboard statistics.

Sidekiq exemple:

class DashboardWorker
  include Sidekiq::Worker

  def perform
    data = RedisWebManager::Data.new
    data.perform
  end
end

Sucker Punch exemple:

class DashboardJob
  include SuckerPunch::Job

  def perform
    data = RedisWebManager::Data.new
    data.perform
  end
end

Todo

  • Add graph for most used commands
  • Manage multiple redis instances
  • Real time chart update
  • Alert system (ex: triggered when memory is peaking)
  • Command line interface to manage your redis database
  • Logs interface

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/OpenGems/redis_web_manager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.