redis_dashboard 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f712009a2a6aaf18f7dc9ae5ffa8ed7fd82bdeddc415f140c250a9043652f8
-  data.tar.gz: 3eebf9aa402bee15fcc14af27dc413c00880fad12742be6382a38c1f66a81848
+  metadata.gz: 9642ce8486ef1fc0d995d2c06380537aa7918335b1f90e8cbade6983e3a84940
+  data.tar.gz: 5221f10a927a48865bd0f598cddac86f9601a942b800d85543e336754c2682e8
 SHA512:
-  metadata.gz: 0bf3538439851524bcc5cb5ee97d486b935a71995ae5d4be78cf12ab9f598297f9dc67d87e981918292575c56dc97e2d6dcd5875a19d9106853f2432fa915074
-  data.tar.gz: c180db4825405d3e3dbee1d95756ca3954b91c2300ad8f4731938658387404b5b0512356778038a2842b402ac98f569d0a805608c310da86b87d8a46ba440b44
+  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

@@ -3,4 +3,3 @@ source "https://rubygems.org"
 gem "sinatra"
 gem "erubi"
 gem "redis"
-gem "sassc"

data/Gemfile.lock

@@ -1,21 +1,18 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    erubi (1.9.0)
-    ffi (1.12.2)
+    erubi (1.10.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    rack (2.2.2)
-    rack-protection (2.0.8.1)
+    rack (2.2.3)
+    rack-protection (2.1.0)
       rack
-    redis (4.1.3)
-    ruby2_keywords (0.0.2)
-    sassc (2.2.1)
-      ffi (~> 1.9)
-    sinatra (2.0.8.1)
+    redis (4.5.1)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.8.1)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
     tilt (2.0.10)
 
@@ -25,8 +22,7 @@ PLATFORMS
 DEPENDENCIES
   erubi
   redis
-  sassc
   sinatra
 
 BUNDLED WITH
-   1.17.2
+   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

@@ -12,36 +12,53 @@ class RedisDashboard::Application < Sinatra::Base
     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 "/memory" do
-    erb(:memory, locals: {client: client, stats: client.memory_stats})
+  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 "/application.css" do
-    scss(:application, style: :expanded)
+  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
@@ -64,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)
@@ -90,6 +107,22 @@ class RedisDashboard::Application < Sinatra::Base
       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 ||= {

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
@@ -39,16 +40,32 @@ class RedisDashboard::Client
     array_reply_to_hash(connection.memory("stats"))
   end
 
+  def keys(pattern)
+    connection.keys(pattern)
+  end
+
   def close
     connection.close if connection
   end
 
-  private
+  def host
+    URI(url).host
+  end
 
-  def connection
-    @connection ||= Redis.new(url: url)
+  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
+
   # Array reply is a Redis format which is translated into a hash for convenience.
   def array_reply_to_hash(array)
     hash = {}