redis_dashboard 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b7368d883f06fd1e645b36e38eda3265344e4e79
-  data.tar.gz: fd50890c3609ce804ff203eea14a0ebc85455572
+SHA256:
+  metadata.gz: 9642ce8486ef1fc0d995d2c06380537aa7918335b1f90e8cbade6983e3a84940
+  data.tar.gz: 5221f10a927a48865bd0f598cddac86f9601a942b800d85543e336754c2682e8
 SHA512:
-  metadata.gz: 35aaf7042c058433465f2aa74615bec63c44d08e66906da4fef874522dd106bddea978ec68f24c779f15b88b6825667777b0d33ff058f81008e42f8d187a7415
-  data.tar.gz: f6a728c21d83ca3f6cb31fde65b49ae0da1371a2a0db0c1416e0db8522f77d66be6feecb769aaedcf022b364c300ec002eff992fd95a0b4b9be7c588bc94f1cf
+  metadata.gz: 1865b8f9ef769bf860987722807e5c341d32c0303e5c115e9c09a9f8c97b91bf9a2de46bd8c2c17dc5b676f379ac1a96142c747f2a1d134611d51a101bff8389
+  data.tar.gz: be609cbe14b267d8421006103528db4afafbd99de6f7995bffc5880daf0f067b83d27a7230e8ed97e0fc014c4e76af53c6c2ef317587d688e309a8c82f0a9503

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 0.3.0
+
+* Add keyspace explorer
+* Use friendly URLs with server host name
+* Mute Redis error when server is too old to support memory command
+* Use Ariato CSS framework https://ariato.org
+* Remove sassc dependency to switch to plain CSS
+
+## 0.2.0
+
+* Add memory stats
+* Replace deprecated sass by sassc
+
+## 0.1.6
+
+* Switch to erubi
+* Escape HTML by default
+* Fix cache hit ratio

data/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
 gem "sinatra"
+gem "erubi"
 gem "redis"
-gem "sass"

data/Gemfile.lock

@@ -1,34 +1,28 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    ffi (1.11.1)
-    mustermann (1.0.3)
-    rack (2.0.7)
-    rack-protection (2.0.5)
+    erubi (1.10.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.3)
+    rack-protection (2.1.0)
       rack
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
-      ffi (~> 1.0)
-    redis (4.1.2)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    sinatra (2.0.5)
+    redis (4.5.1)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.5)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
-    tilt (2.0.9)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  erubi
   redis
-  sass
   sinatra
 
 BUNDLED WITH
-   1.15.0
+   2.1.4

data/README.md

@@ -20,38 +20,40 @@ You can run it in standalone or inside your Rails app.
 
 ## Installation inside a Rails app
 
-Add this line in your Gemfile:
-```ruby
-gem "redis_dashboard"
-```
-
-In your terminal run the following command:
-```shell
-bundle install
-```
+Add to your Gemfile `gem "redis_dashboard"` and run `bundle install`.
 
 Then mount the app from `config/routes.rb`:
 ```ruby
-mount RedisDashboard::Application, at: "redis_dashboard"
+mount RedisDashboard::Application, at: "redis"
 ```
 
-Specify the Redis URLs in `config/redis_dashboard.rb`:
+By default Redis dashboard tries to connect to `REDIS_URL` environment variable or to `localhost`. You can specify any other URL by adding an initializer in `config/initializers/redis_dashboard.rb` :
 ```ruby
-RedisDashboard.urls = ["redis://localhost"]
+RedisDashboard.urls = [ENV["REDIS_URL"] || "redis://localhost"]
 ```
 
-Finally visit http://localhost/redis_dashboard/.
+Finally visit http://localhost:3000/redis.
 
-## Authentication
+## Authentication and permissions
 
-To protect your dashboard you can setup a basic HTTP authentication:
+To protect your dashboard you can setup a basic HTTP authentication :
 
 ```ruby
+# config/initializers/redis_dashboard.rb
 RedisDashboard::Application.use(Rack::Auth::Basic) do |user, password|
   user == "USER" && password == "PASSWORD"
 end
 ```
 
+In case you handle authentication with Devise, you can perform the permission verification directly from the routes :
+
+```ruby
+# config/routes.rb
+authenticate :user, -> (u) { u.admin? } do # Supposing there is a User#admin? method
+  mount RedisDashboard::Application, at: "redis"
+end
+```
+
 ## MIT License
 
 Made by [Base Secrète](https://basesecrete.com).

data/lib/redis_dashboard/application.rb

@@ -1,40 +1,64 @@
 require "sinatra/base"
+require "erubi"
 require "redis"
 require "uri"
 
 class RedisDashboard::Application < Sinatra::Base
+  set :erb, escape_html: true
+
   after { close_clients }
 
   get "/" do
     erb(:index, locals: {clients: clients})
   end
 
-  get "/info" do
-    erb(:info, locals: {info: client.info})
-  end
-
-  get "/config" do
+  get "/:server/config" do
     erb(:config, locals: {config: client.config})
   end
 
-  get "/clients" do
+  get "/:server/clients" do
     erb(:clients, locals: {clients: client.clients})
   end
 
-  get "/stats" do
+  get "/:server/stats" do
     erb(:stats, locals: {stats: client.stats})
   end
 
-  get "/slowlog" do
+  get "/:server/slowlog" do
     erb(:slowlog, locals: {client: client, commands: client.slow_commands})
   end
 
-  get "/application.css" do
-    scss(:application, style: :expanded)
+  get "/:server/memory" do
+    stats = mute_redis_command_error { client.memory_stats } || {}
+    erb(:memory, locals: {client: client, stats: stats })
+  end
+
+  get "/:server/keyspace" do
+    erb(:keyspace, locals: {keyspace: client.keyspace})
+  end
+
+  get "/:server/keyspace/:db" do
+    client.connection.select(params[:db].sub(/^db/, ""))
+    erb(:keys, locals: {client: client, keys: client.keys(params[:query])})
+  end
+
+  get "/:server/keyspace/:db/*" do
+    params[:key] = params[:splat].first
+    client.connection.select(params[:db].sub(/^db/, ""))
+    erb(:key, locals: {client: client})
+  end
+
+  get "/:server" do
+    erb(:info, locals: {info: client.info})
   end
 
   def client
-    @client ||= RedisDashboard::Client.new(RedisDashboard.urls[redis_id.to_i])
+    return @client if @client
+    if url = RedisDashboard.urls.find { |url| URI(url).host == params[:server] }
+      @client ||= RedisDashboard::Client.new(url)
+    else
+      raise Sinatra::NotFound
+    end
   end
 
   def clients
@@ -57,12 +81,12 @@ class RedisDashboard::Application < Sinatra::Base
       Time.at(epoch).strftime("%b %d %H:%M")
     end
 
-    def redis_id
-      params[:id]
+    def active_page_css(path)
+      request.path_info == path && "active"
     end
 
-    def active_page?(path='')
-      request.path_info == '/' + path
+    def active_path_css(path)
+      request.path_info.start_with?(path) && "active"
     end
 
     def format_impact_percentage(percentage)
@@ -74,16 +98,34 @@ class RedisDashboard::Application < Sinatra::Base
     end
 
     def compute_cache_hit_ratio(info)
-      if (total = info["keyspace_hits"].to_i + info["keyspace_misses"].to_i) > 0
-        info["keyspace_hits"].to_f * 100
+      hits = info["keyspace_hits"].to_i
+      misses = info["keyspace_misses"].to_i
+      if (total = hits + misses) > 0
+        hits * 100.0 / total
       else
         0
       end
     end
 
+    def render_key_data(key)
+      type = client.connection.type(params[:key])
+      erb(:"key/#{type}", locals: {key: key})
+    rescue Errno::ENOENT
+      erb(:"key/unsupported", locals: {key: key})
+    end
+
+    def mute_redis_command_error(&block)
+      block.call
+    rescue Redis::CommandError
+    end
+
+    def escape_key(key)
+      key.gsub("#", "%23")
+    end
+
     def clients_column_description(col)
       # https://redis.io/commands/client-list
-      {
+      @clients_column_description ||= {
         id: "an unique 64-bit client ID (introduced in Redis 2.8.12).",
         addr: "address/port of the client",
         fd: "file descriptor corresponding to the socket",
@@ -101,12 +143,13 @@ class RedisDashboard::Application < Sinatra::Base
         omem: "output buffer memory usage",
         events: "file descriptor events (see below)",
         cmd: "last command played",
-      }[col.to_sym]
+      }
+      @clients_column_description[col.to_sym]
     end
 
     def client_event_description(event)
       # https://redis.io/commands/client-list
-      {
+      @client_event_description ||= {
         O: "the client is a slave in MONITOR mode",
         S: "the client is a normal slave server",
         M: "the client is a master",
@@ -120,7 +163,8 @@ class RedisDashboard::Application < Sinatra::Base
         r: "the client is in readonly mode against a cluster node",
         A: "connection to be closed ASAP",
         N: "no specific flag set",
-      }[event.to_sym]
+      }
+      @client_event_description[event.to_sym]
     end
   end
 end

data/lib/redis_dashboard/client.rb

@@ -3,6 +3,7 @@ class RedisDashboard::Client
 
   def initialize(url)
     @url = url
+    @connection ||= Redis.new(url: url)
   end
 
   def clients
@@ -10,12 +11,7 @@ class RedisDashboard::Client
   end
 
   def config
-    hash = {}
-    array = connection.config("get", "*")
-    while (pair = array.slice!(0, 2)).any?
-      hash[pair.first] = pair.last
-    end
-    hash
+    array_reply_to_hash(connection.config("get", "*"))
   end
 
   def info
@@ -40,13 +36,42 @@ class RedisDashboard::Client
     end.sort{ |left, right| right.microseconds <=> left.microseconds }
   end
 
+  def memory_stats
+    array_reply_to_hash(connection.memory("stats"))
+  end
+
+  def keys(pattern)
+    connection.keys(pattern)
+  end
+
   def close
     connection.close if connection
   end
 
+  def host
+    URI(url).host
+  end
+
+  def keyspace
+    connection.info("KEYSPACE").inject({}) do |hash, space|
+      db, str = space
+      hash[db] = str.split(",").inject({}) do |h, s|
+        k, v = s.split("=")
+        h[k] = v
+        h
+      end
+      hash
+    end
+  end
+
   private
 
-  def connection
-    @connection ||= Redis.new(url: url)
+  # Array reply is a Redis format which is translated into a hash for convenience.
+  def array_reply_to_hash(array)
+    hash = {}
+    while (pair = array.slice!(0, 2)).any?
+      hash[pair.first] = pair.last.is_a?(Array) ? array_reply_to_hash(pair.last) : pair.last
+    end
+    hash
   end
 end