amnesia 1.0.0

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2009— Ben Schwarz
+
+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.markdown

@@ -0,0 +1,69 @@
+# Amnesia
+
+Amnesia is what you get when you lose your memory. 
+
+Hopefully with Amnesia you'll know exactly whats happening with memory when it comes to memcached.
+
+![Amnesia screen shot](http://farm5.static.flickr.com/4125/5030135910_698fdb4514_z_d.jpg "Amnesia")
+
+## Why?
+
+Its always nice to have some statistics to see how everything is performing within your stack. Memcached seems to be a  mystery box that people don't really pay alot of attention to.
+
+Amnesia tells you how your application is performing, when it misses, when it is running sweet, when you're about to run out of memcached and (perhaps) fall down in a screaming heap.
+
+## What does it tell you? 
+
+All stats are since each memcached instance was restarted
+
+Available as a cumluative result of all your memcached instances, or single instances alone:
+
+* Cache hits and misses
+* Reads and writes
+* Remaining memory
+
+
+Available for single instances only: 
+
+* Amount of items stored in cache
+* Connections (current and total)
+* Accesses (Read / Write)
+* Accuracy (Hits / Misses)
+* Memory (Used / Total)
+
+## Installation / Getting started
+
+    gem install amnesia
+
+### How to run it alongside your application
+
+"config.ru":
+  
+    require 'amnesia'
+    use Amnesia::Application, :hosts => ["localhost:11211"]
+    run Sinatra::Application
+
+### Then, cruise on over to `your-host.tld/amnesia`
+
+## Potential issues
+
+* Hosts are listed as "Inactive" or "Not Responding"
+
+Amnesia uses memcached-client to connect to memcached on the standard memcached port (11211), be sure to enter your
+full hostname with the port if you are using a non standard port. (localhost:11211 will work)
+
+Within my slices, I punched a hole through `iptables`
+
+    sudo iptables -A INPUT -i eth0 -s HOST_THAT_REQUIRES_ACCESS -p tcp --destination-port 11211 -j ACCEPT
+
+You won't need to do this unless you've explicitly blocked ports to your server. (When in doubt, block nearly everything)
+
+Let me know if you come accross any issues using Github messaging.
+
+## Something missing? 
+
+Amnesia used to be a full blown application that required a datamapper sqlite database, yml file for configuration and a bit of pain to get deployed. I decided these were all false constraints and wrapped it up as a middleware instead. Now—You can drop it alongside your rails/sinatra/rack application and see what the hell is going on with Memcached. 
+
+## Licence
+
+MIT, See `LICENCE` file.

data/lib/amnesia.rb

@@ -0,0 +1,55 @@
+require 'sinatra'
+require 'memcache'
+require 'gchart'
+require 'haml'
+
+$:<< File.dirname(__FILE__)
+
+require 'amnesia/host'
+require 'core_ext/array'
+
+module Amnesia
+  class << self
+    attr_accessor :config
+  end
+  
+  class Application < Sinatra::Base
+    set :public, File.join(File.dirname(__FILE__), 'amnesia', 'public')
+    set :views, File.join(File.dirname(__FILE__), 'amnesia', 'views')
+
+    def initialize(app, configuration = {})
+      Amnesia.config = configuration
+      super(app)
+    end
+    
+    helpers do
+      def graph_url(data = [])
+        GChart.pie(:data => data, :size => '115x115').to_url
+      end
+      
+      def number_to_human_size(size, precision=1)
+         size = Kernel.Float(size)
+         case
+           when size.to_i == 1;    "1 Byte"
+           when size < 1.kilobyte; "%d Bytes" % size
+           when size < 1.megabyte; "%.#{precision}f KB"  % (size / 1.0.kilobyte)
+           when size < 1.gigabyte; "%.#{precision}f MB"  % (size / 1.0.megabyte)
+           when size < 1.terabyte; "%.#{precision}f GB"  % (size / 1.0.gigabyte)
+           else                    "%.#{precision}f TB"  % (size / 1.0.terabyte)
+         end.sub(/([0-9])\.?0+ /, '\1 ' )
+       rescue
+         nil
+       end
+    end
+    
+    get '/amnesia' do
+      @hosts = Amnesia.config[:hosts].map{|host| Host.new(host)}
+      haml :index
+    end
+
+    get '/amnesia/:host' do
+      @host = Host.new(params[:host])
+      haml :host
+    end
+  end
+end

data/lib/amnesia/host.rb

@@ -0,0 +1,29 @@
+class Host
+  attr_reader :address
+  
+  def initialize(address)
+    @address = address
+  end
+  
+  def alive? 
+    return true if connection.stats
+  rescue MemCache::MemCacheError
+    return false
+  end
+  
+  def method_missing(method, *args)
+    return stats[method.to_s] if stats.has_key? method.to_s
+  end
+  
+  def stats
+    connection.stats[connection.stats.keys.first]
+  rescue MemCache::MemCacheError
+    return {}
+  end
+  
+  private
+  
+  def connection
+    @connection ||= MemCache.new(@address)
+  end
+end

data/lib/amnesia/public/css/application.css

@@ -0,0 +1,38 @@
+/* HTML5 */
+header, footer, article, section, aside, nav, menu, figure { display: block; }
+
+/* Resets */
+body, h1, h2, h3, h4, h5, h6, p, a, ul, ol, dl, dt, dd, table, caption, th, td, fieldset, legend, blockquote { font-weight: normal; margin: 0; padding: 0; color: inherit; list-style-type: none; }
+a img, form, legend { border: 0; }
+
+/* Layout */
+body { font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; margin: 0 auto; width: 450px; text-rendering: optimizeLegibility; -webkit-font-smoothing: antialiased; }
+
+h1, h2, h3 { color: #1f1f1f; }
+img { display: block; }
+a { color: inherit; }
+
+header { margin: 1em 0; }
+header h1 { font-size: 3.5em; }
+header h1 a { color: #1f1f1f; text-decoration: none; }
+header h1 a:hover:after { content: "—Huh?";}
+header p { font-size: 0.8em; color: #454545; }
+
+section#main h2 { font-size: 1em; float: right; }
+section#main p.sub {  color: #666; font-size: 0.9em; font-style: italic; }
+
+section#main .stats { clear: left; padding: 1.75em 0; }
+section#main :last-child { border: none; }
+section#main .graph img { float: left; margin-top: -1.5em; margin-left: -1em; }
+section#main .stats h3 { font-size: 1.1em; margin-left: 110px; line-height: 1.5em; }
+section#main .stats p { line-height: 1.4em; font-size: 0.75em; color: #454545; margin-left: 110px; }
+
+section#main .stats h3 span.graph-indicator { color: #ff9900; }
+
+nav#hosts { clear: left; margin: 2em 0; }
+nav#hosts li { margin: 0.5em 0; }
+nav#hosts li.inactive { color: #999; }
+
+footer { margin-top: 2em; border-top: 0.1em dotted #eee; width: 50%; margin: 2em auto; padding: 0.5em 0; }
+footer p { font-size: 0.6em; color: #ccc; text-align: center; }
+footer p a:hover { color: #999; }

data/lib/amnesia/views/host.haml

@@ -0,0 +1,24 @@
+%h2= @host.address 
+%p.sub #{@host.curr_items} item/s in cache, with #{@host.curr_connections} active connections
+
+%section.stats.graph
+  %img{:src => graph_url([@host.bytes, @host.limit_maxbytes]) }
+  %h3
+    %span.graph-indicator Used Memory (#{number_to_human_size(@host.bytes)})
+    \/ Free Memory (#{number_to_human_size(@host.limit_maxbytes)})
+  %p The cumulative amount of free memory and total memory across all active hosts.
+
+
+%section.stats.graph
+  %img{:src => graph_url([@host.get_hits, @host.get_misses]) }
+  %h3
+    %span.graph-indicator Hit (#{@host.get_hits})
+    \/ Miss (#{@host.get_misses})
+  %p The amount of returned caches vs misses, misses usually require your application servers to work harder.
+
+%section.stats.graph
+  %img{:src => graph_url([@host.cmd_get, @host.cmd_set]) }
+  %h3
+    %span.graph-indicator Read (#{@host.cmd_get})
+    \/ Write (#{@host.cmd_set})
+  %p More writes than reads can often mean that you’re caching too early, or that you’ve not been monitoring for very long.

data/lib/amnesia/views/index.haml

@@ -0,0 +1,34 @@
+- if @hosts.any?{|host| host.alive? }
+  %section#overall
+    %section.stats.graph
+      %img{:src => graph_url([@hosts.collect{|h| h.get_hits if h.alive? }.compact.sum, @hosts.collect{|h| h.get_misses if h.alive? }.compact.sum])}
+      %h3
+        %span.graph-indicator Hit
+        \/ Miss
+      %p The amount of returned caches vs misses, misses usually require your application servers to work harder.
+    %section.stats.graph
+      %img{:src => graph_url([@hosts.collect{|h| h.cmd_get if h.alive? }.compact.sum, @hosts.collect{|h| h.cmd_set if h.alive? }.compact.sum])}
+      %h3
+        %span.graph-indicator Read
+        \/ Write
+      %p More writes than reads can often mean that you’re caching too early, or that you’ve not been monitoring for very long.
+  
+    %section.stats.graph
+      %img{:src => graph_url([@hosts.collect{|h| h.bytes if h.alive? }.compact.sum, @hosts.collect{|h| h.limit_maxbytes if h.alive? }.compact.sum])}
+      %h3
+        %span.graph-indicator Used Memory
+        \/ Free Memory
+      %p The cumulative amount of free memory and total memory across all active hosts.
+
+%nav#hosts
+  %p.sub Active Hosts
+  %ul
+  - for host in @hosts
+    - if host.alive?
+      %li
+        %a{:href => "/amnesia/" + host.address }= host.address
+    - else
+      %li.inactive
+        = host.address
+        (Inactive)
+      

data/lib/amnesia/views/layout.haml

@@ -0,0 +1,19 @@
+!!!
+%html
+  %head
+    %meta{:charset => "utf-8"}
+    %title Amnesia
+    %link{:rel => "stylesheet", :href => "/css/application.css"}
+  %body
+    %header
+      %h1
+        %a{:href => '/amnesia'} Amnesia
+      %p Statistics for Memcached. Wait—What?
+    %section#main
+      = yield
+    %footer
+      %p 
+        Another
+        %a{:href => "http://germanforblack.com"} Ben Schwarz
+        joint. Get the 
+        %a{:href => "http://github.com/benschwarz/amnesia"} Source.

data/lib/core_ext/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def sum
+    inject( nil ) { |sum,x| sum ? sum+x : x }
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: amnesia
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ben Schwarz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: gchart
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id004
+description: With Amnesia you'll know exactly whats happening with memory when it comes to memcached.
+email: 
+- ben.schwarz@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/amnesia/host.rb
+- lib/amnesia/public/css/application.css
+- lib/amnesia/views/host.haml
+- lib/amnesia/views/index.haml
+- lib/amnesia/views/layout.haml
+- lib/amnesia.rb
+- lib/core_ext/array.rb
+- LICENCE
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/benschwarz/amnesia
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Amnesia is what you get when you lose your memory
+test_files: []
+