memdash 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brian Ryckbost
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Memdash [![Build Status](https://secure.travis-ci.org/bryckbost/memdash.png)](http://travis-ci.org/bryckbost/memdash) [![Dependency Status](https://gemnasium.com/bryckbost/memdash.png)](https://gemnasium.com/bryckbost/memdash)
+
+A dashboard for your memcache. **This is a work in progress,** but aims to provide a little insight into your application's memcached servers.
+
+![Screenshot of memdash](https://github.com/bryckbost/memdash/raw/front-end/screenshot.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'memdash'
+
+And then from the console, run:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memdash
+
+## Usage
+
+To begin using Memdash, run the following:
+
+    $ rails g memdash:active_record
+    $ rake db:migrate
+
+The generator will create a table (`memdash_reports`) to store a serialized column of statistics from your cache servers.
+
+From this point onward, any calls to the cache should generate statistics and shove them into that table. But don't worry, Memdash won't actually write to the database on every call. Instead, it caches the stats within memcache for a minute and writes when it needs to.
+
+To view the dashboard, you'll need to add `require 'memdash/server'` to `config/routes.rb` and mount a server at an endpoint. It might look something like this:
+
+    require 'memdash/server'
+
+    MyRailsApp::Application.routes.draw do
+      …other routes…
+
+      mount Memdash::Server.new, :at => "/memdash"
+    end
+
+## Why Did I Build This?
+
+Memdash is meant to give you insight into your memcached setup without adding overhead to your application. I found it useful when deploying apps to Heroku where the memcached add-on is a bit of a black box. Stuff goes in, stuff comes out. Hopefully, it's being used effectively.
+
+## How Does it Work???
+
+Building on top of [Dalli](https://github.com/mperham/dalli), Memdash hooks into Dalli's chokepoint method to generate statistics.
+
+When a call to the cache is triggered, `memdash` performs that operation and does a `get` for the key `memdash`. If the returned value is not found, Memdash then writes the cache statistics to the database and `add`s the `memdash` key with a default time to live of 60 seconds.
+
+## 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

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+ADAPTERS = %w(active_record)
+
+task :default => :test
+
+desc 'Run tests'
+task :test => ADAPTERS.map{|a| "#{a}:test" }
+
+ADAPTERS.each do |adapter|
+  namespace adapter do
+    desc "Run tests against #{adapter}"
+    RSpec::Core::RakeTask.new(:test => :env)
+
+    task :env do
+      ENV['ADAPTER'] = adapter
+    end
+  end
+end

data/config.ru

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'logger'
+
+require 'memdash/server'
+
+use Rack::ShowExceptions
+run Memdash::Server.new

data/lib/generators/memdash/active_record_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module Memdash
+  module Generators
+    class ActiveRecordGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+
+      self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_memdash_active_record_reports.rb'
+      end
+    end
+  end
+end

data/lib/generators/memdash/templates/migration.rb

@@ -0,0 +1,12 @@
+class CreateMemdashActiveRecordReports < ActiveRecord::Migration
+  def self.up
+    create_table :memdash_reports do |table|
+      table.text :stats
+      table.datetime :created_at
+    end
+  end
+
+  def self.down
+    drop_table :memdash_reports
+  end
+end

data/lib/memdash.rb

@@ -0,0 +1,9 @@
+require 'memdash/client'
+require 'memdash/configuration'
+require 'dalli'
+
+module Memdash
+  extend Memdash::Configuration
+end
+
+Dalli::Client.send(:include, Memdash::Client)

data/lib/memdash/active_record.rb

@@ -0,0 +1,2 @@
+require 'memdash'
+require 'memdash/active_record/client'

data/lib/memdash/active_record/client.rb

@@ -0,0 +1,13 @@
+require 'memdash/active_record/report'
+
+module Memdash
+  module ActiveRecord
+    module Client
+      def generate_stats
+        Memdash::ActiveRecord::Report.create!(:stats => stats)
+      end
+    end
+  end
+end
+
+Dalli::Client.send(:include, Memdash::ActiveRecord::Client)

data/lib/memdash/active_record/report.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+
+module Memdash
+  module ActiveRecord
+    class Report < ::ActiveRecord::Base
+      self.table_name = :memdash_reports
+
+      serialize :stats
+
+      scope :past_day, where('created_at >= :time', :time => Time.current - 1.day)
+    end
+  end
+end

data/lib/memdash/client.rb

@@ -0,0 +1,26 @@
+module Memdash
+  module Client
+    def self.included(base)
+      base.class_eval do
+        alias_method :perform_without_stats, :perform
+        alias_method :perform, :perform_with_stats
+      end
+    end
+
+    def perform_with_stats(op, key, *args)
+      ret = perform_without_stats(op, key, *args)
+      resp = perform_without_stats(:get, 'memdash')
+      if resp.nil? || resp == 'Not found'
+        generate_stats
+        perform_without_stats(:add, 'memdash', true, Memdash.ttl, nil)
+      end
+      ret
+    end
+
+    private
+
+    def generate_stats
+      raise NotImplementedError
+    end
+  end
+end

data/lib/memdash/configuration.rb

@@ -0,0 +1,11 @@
+module Memdash
+  module Configuration
+    DEFAULT_TTL = 60
+
+    attr_writer :ttl
+
+    def ttl
+      @ttl ||= DEFAULT_TTL
+    end
+  end
+end

data/lib/memdash/server.rb

@@ -0,0 +1,50 @@
+require 'sinatra/base'
+require 'erb'
+require 'memdash/active_record'
+
+module Memdash
+  class Server < Sinatra::Base
+    dir = File.dirname(File.expand_path(__FILE__))
+    set :views,         "#{dir}/server/views"
+    set :public_folder, "#{dir}/server/public"
+
+    helpers do
+      include Rack::Utils
+      alias_method :h, :escape_html
+
+      def url_path(*path_parts)
+        [path_prefix, path_parts].join("/").squeeze('/')
+      end
+      alias_method :u, :url_path
+
+      def path_prefix
+        request.env['SCRIPT_NAME']
+      end
+
+      def hit_ratio(hits, misses)
+        hits / (hits + misses)
+      end
+
+      def miss_ratio(hits, misses)
+        1 - hit_ratio(hits, misses)
+      end
+
+      def miss_ratio_percentage(hits, misses)
+        miss_ratio(hits, misses) * 100
+      end
+    end
+
+    get "/" do
+      @last_report = Memdash::ActiveRecord::Report.last
+      past_day = Memdash::ActiveRecord::Report.past_day
+      @gets = past_day.flat_map{|report| report.stats.map{|_, v| [report.created_at.strftime("%m-%d-%Y %I:%M%p"), v["cmd_get"].to_i]}}
+      @sets = past_day.flat_map{|report| report.stats.map{|_, v| [report.created_at.strftime("%m-%d-%Y %I:%M%p"), v["cmd_set"].to_i]}}
+      @hits = past_day.flat_map{|report| report.stats.map{|_, v| [report.created_at.strftime("%m-%d-%Y %I:%M%p"), v["get_hits"].to_i]}}
+      @misses = past_day.flat_map{|report| report.stats.map{|_, v| [report.created_at.strftime("%m-%d-%Y %I:%M%p"), v["get_misses"].to_i]}}
+      @limit_maxbytes = past_day.flat_map{|report| report.stats.map{|_, v| [report.created_at.strftime("%m-%d-%Y %I:%M%p"), (v["limit_maxbytes"].to_i / 1024.0 / 1024.0).round(2)]}}
+      @bytes = past_day.flat_map{|report| report.stats.map{|_, v| [report.created_at.strftime("%m-%d-%Y %I:%M%p"), (v["bytes"].to_i / 1024.0 / 1024.0).round(2)]}}
+      @current_items = past_day.flat_map{|report| report.stats.map{|_, v| [report.created_at.strftime("%m-%d-%Y %I:%M%p"), v["curr_items"].to_i]}}
+      erb :overview, :layout => :application
+    end
+  end
+end

data/lib/memdash/server/public/charts.js

@@ -0,0 +1,136 @@
+$(document).ready(function(){
+  $.jqplot('gets-sets', [$("#gets-sets").data("gets"), $("#gets-sets").data("sets")], {
+    title: 'Gets & Sets for the Past Day',
+    grid: {
+      drawBorder: false,
+      shadow: false,
+      background: '#fefefe'
+    },
+    axes:{
+      xaxis:{
+        renderer: $.jqplot.DateAxisRenderer,
+        tickOptions: {
+          formatString:'%#I %p'
+        },
+        min: $("#gets-sets").data("gets")[0][0],
+        max: $("#gets-sets").data("gets")[$("#gets-sets").data("gets").length - 1][0],
+        tickInterval: "2 hours",
+      }
+    },
+    seriesDefaults: {
+      rendererOptions: {
+        smooth: true
+      }
+    },
+    series: [
+      {label: 'Gets', showMarker: false},
+      {label: 'Sets', showMarker: false},
+   ],
+   legend: {
+    show: true
+   },
+   seriesColors: ["rgb(36, 173, 227)", "rgb(227, 36, 132)"]
+  });
+  $.jqplot('hits-misses', [$("#hits-misses").data("hits"), $("#hits-misses").data("misses")], {
+    title: 'Hits & Misses for the Past Day',
+    grid: {
+      drawBorder: false,
+      shadow: false,
+      background: '#fefefe'
+    },
+    axes:{
+      xaxis:{
+        renderer: $.jqplot.DateAxisRenderer,
+        tickOptions: {
+          formatString:'%#I %p'
+        },
+        min: $("#hits-misses").data("hits")[0][0],
+        max: $("#hits-misses").data("hits")[$("#hits-misses").data("hits").length - 1][0],
+        tickInterval: "2 hours",
+      },
+      yaxis: {
+        rendererOptions: { forceTickAt0: true, forceTickAt100: true }
+      }
+      
+    },
+    seriesDefaults: {
+      rendererOptions: {
+        smooth: true
+      }
+    },
+    series: [
+       {label: 'Hits', showMarker: false},
+       {label: 'Misses', showMarker: false}
+    ],
+    legend: {
+     show: true
+    },
+    seriesColors: ["rgb(227, 36, 132)", "rgb(227, 193, 36)"]
+  });
+  $.jqplot('memory-usage', [$("#memory-usage").data("limit-maxbytes"), $("#memory-usage").data("bytes")], {
+    title: 'Cache Memory for the Past Day',
+    grid: {
+      drawBorder: false,
+      shadow: false,
+      background: '#fefefe'
+    },
+    axes:{
+      xaxis:{
+        renderer: $.jqplot.DateAxisRenderer,
+        tickOptions: {
+          formatString:'%#I %p'
+        },
+        min: $("#memory-usage").data("limit-maxbytes")[0][0],
+        max: $("#memory-usage").data("limit-maxbytes")[$("#memory-usage").data("limit-maxbytes").length - 1][0],
+        tickInterval: "2 hours",
+      }
+    },
+    seriesDefaults: {
+      rendererOptions: {
+        smooth: true
+      }
+    },
+    series: [
+       {label: 'Max Size (MB)', showMarker: false},
+       {label: 'Used (MB)', showMarker: false}
+    ],
+    legend: {
+     show: true
+    },
+    seriesColors: ["rgb(227, 193, 36)", "rgb(36, 173, 227)"]
+  });
+  $.jqplot('current-items', [$("#current-items").data("current-items")], {
+    title: 'Items over the Past Day',
+    grid: {
+      drawBorder: false,
+      shadow: false,
+      background: '#fefefe'
+    },
+    axes:{
+      xaxis:{
+        renderer: $.jqplot.DateAxisRenderer,
+        tickOptions: {
+          formatString:'%#I %p'
+        },
+        min: $("#current-items").data("current-items")[0][0],
+        max: $("#current-items").data("current-items")[$("#current-items").data("current-items").length - 1][0],
+        tickInterval: "2 hours",
+      },
+      yaxis: {
+        rendererOptions: { forceTickAt0: true, forceTickAt100: true }
+      }
+    },
+    seriesDefaults: {
+      rendererOptions: {
+        smooth: true,
+      }
+    },
+    series: [
+       {label: 'Items', showMarker: false},
+    ],
+    legend: {
+     show: true
+    },
+    seriesColors: ["rgb(227, 193, 36)"]
+  });
+});