{"id":13878614,"url":"https://github.com/OpenGems/redis_web_manager","last_synced_at":"2025-07-16T14:32:39.892Z","repository":{"id":40092748,"uuid":"238955845","full_name":"OpenGems/redis_web_manager","owner":"OpenGems","description":"Manage your Redis instance (see keys, memory used, connected client, etc...)","archived":false,"fork":false,"pushed_at":"2023-10-09T18:24:57.000Z","size":777,"stargazers_count":172,"open_issues_count":18,"forks_count":25,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-13T04:05:38.260Z","etag":null,"topics":["rails","rails-engine","rails-redis","redis","redis-client","redis-monitor","redis-monitoring","redis-monitoring-application"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenGems.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-02-07T15:21:30.000Z","updated_at":"2024-10-07T21:06:07.000Z","dependencies_parsed_at":"2024-01-05T22:00:07.997Z","dependency_job_id":null,"html_url":"https://github.com/OpenGems/redis_web_manager","commit_stats":{"total_commits":85,"total_committers":8,"mean_commits":10.625,"dds":0.5529411764705883,"last_synced_commit":"a65a9f82ebb6e2ab08126fbd64c069a9d0f28e05"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenGems%2Fredis_web_manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenGems%2Fredis_web_manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenGems%2Fredis_web_manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenGems%2Fredis_web_manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenGems","download_url":"https://codeload.github.com/OpenGems/redis_web_manager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225964825,"owners_count":17552413,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rails","rails-engine","rails-redis","redis","redis-client","redis-monitor","redis-monitoring","redis-monitoring-application"],"created_at":"2024-08-06T08:01:54.813Z","updated_at":"2025-07-16T14:32:39.883Z","avatar_url":"https://github.com/OpenGems.png","language":"Ruby","readme":"# ⚠️ Gem status\nWord of caution if you intend to use this project in production. This gem has not been properly maintained in the past years. Maintainers are trying their best to revive it but it's not their main priority. Thank you for your comprehension.\n\n# RedisWebManager\n\n[![Gem Version](https://badge.fury.io/rb/redis_web_manager.svg)](https://badge.fury.io/rb/redis_web_manager)\n[![Maintainability](https://api.codeclimate.com/v1/badges/55600fe789679fe62d8b/maintainability)](https://codeclimate.com/github/OpenGems/redis_web_manager/maintainability)\n[![Build Status](https://travis-ci.org/OpenGems/redis_web_manager.svg?branch=master)](https://travis-ci.org/OpenGems/redis_web_manager)\n[![security](https://hakiri.io/github/OpenGems/redis_web_manager/master.svg)](https://hakiri.io/github/OpenGems/redis_web_manager/master)\n![Gem](https://img.shields.io/gem/dt/redis_web_manager)\n[![Coverage Status](https://coveralls.io/repos/github/OpenGems/redis_web_manager/badge.svg?branch=master)](https://coveralls.io/github/OpenGems/redis_web_manager?branch=master)\n\nWeb interface that allows you to manage easily your Redis instance (see keys, memory used, connected client, etc...). \n\n### Check your stats \nThe Dashboard allows you to check the Memory usage, CPU and Redis clients.\n\n![RedisWebManager Dashboard](images/images_dashboard.png)\n\n### Manage your redis keys\nYou can easily edit and delete any keys stored in your redis database.\n\n![RedisWebManager Keys](images/images_keys.png)\n\n### Keep an eye on your redis clients\nCheck how many clients are connected and their infos.\n\n![RedisWebManager Clients](images/images_clients.png)\n\n## Installation\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'redis_web_manager'\n```\n\nAnd then execute:\n```bash\n$ bundle\n```\n\nOr install it yourself as:\n```bash\n$ gem install redis_web_manager\n```\n\nAdd the custom route in your `routes.rb`:\n```\nmount RedisWebManager::Engine =\u003e '/redis_web_manager'\n```\n\nAccess to RedisWebManager at `/redis_web_manager`\n\n## Configuration\n\nYou can configure RedisWebManager: \n\n```ruby\n# initializers/redis_web_manager.rb\n\nRedisWebManager.configure do |config|\n  config.redises = {\n    instance_1: Redis.new(db: 1),\n    instance_2: Redis.new(url: 'XXX')\n  } # Default { default: Redis.new } (Hash with instance(s) of Redis)\n  config.lifespan = 2.days # Default 15.days (Lifespan of each keys for dashboard)\n  config.authenticate = proc {\n                           authenticate_or_request_with_http_basic do |username, password|\n                              username == 'TEST' \u0026\u0026 password == 'TEST'\n                            end\n                          } # Default nil (Authenticate method to secure tools)\nend\n```\n\n## Collect data for dashboard\n\nIn order to have data on your dashboard you must collect the data like this:\n```ruby\ndata = RedisWebManager::Data.new(:instance_1)\ndata.perform\n```\n\nor \n\n```ruby\nRedisWebManager.redises.keys.each do |instance|\n  data = RedisWebManager::Data.new(instance)\n  data.perform\nend\n```\n\nIf 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.\n\nSidekiq exemple:\n```ruby\nclass DashboardWorker\n  include Sidekiq::Worker\n\n  def perform\n    data = RedisWebManager::Data.new(:instance_1)\n    data.perform\n  end\nend\n```\n\nor\n\n```ruby\nclass DashboardWorker\n  include Sidekiq::Worker\n\n  def perform\n    RedisWebManager.redises.keys.each do |instance|\n      data = RedisWebManager::Data.new(instance)\n      data.perform\n    end\n  end\nend\n```\n\nSucker Punch exemple:\n```ruby\nclass DashboardJob\n  include SuckerPunch::Job\n\n  def perform\n    data = RedisWebManager::Data.new(:instance_1)\n    data.perform\n  end\nend\n```\n\nor\n\n```ruby\nclass DashboardJob\n  include SuckerPunch::Job\n\n  def perform\n    RedisWebManager.redises.keys.each do |instance|\n      data = RedisWebManager::Data.new(instance)\n      data.perform\n    end\n  end\nend\n```\n\n\n\n\n## Todo\n* [ ] Add graph for most used commands\n* [ ] Real time chart update\n* [ ] Alert system (ex: triggered when memory is peaking)\n* [ ] Command line interface to manage your redis database\n* [ ] Logs interface\n\n\n## Contributing\nBug 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](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","funding_links":[],"categories":["Ruby","Process Management and Monitoring","Higher level libraries and tools","Gems"],"sub_categories":["Articles"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenGems%2Fredis_web_manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenGems%2Fredis_web_manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenGems%2Fredis_web_manager/lists"}