metricstore 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@metricstore --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Johnson
+
+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,126 @@
+# Metricstore
+
+Metrics in a key-value store.
+
+Accepts, summarizes, and stores continuous metrics updates to a key-value store.
+Answers queries in constant time.
+
+We assume that the backing key-value store is fast, durable, and supports TTL.
+Initial implementation will use Couchbase.
+
+## Installation
+
+Follow the instructions at https://github.com/couchbase/couchbase-ruby-client
+to install the couchbase gem.
+
+Add this line to your application's Gemfile:
+
+    gem 'metricstore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metricstore
+
+## Usage
+
+    m = Metricstore.couchbase(:hostname => "localhost")
+
+    # Configure...
+    m.ttl_of_hours = 31_556_926 # 1 year, default
+    m.ttl_of_minutes = 86_400 # 24 hours, default
+    m.ttl_of_group_members = 7200 # 2 hours, default
+    m.list_threshold = 1000 # default
+
+    # (Suppose that the current time is 17:05 UTC on April 13, 2012.)
+
+    m.counter(:when => Time.now, :metric => "logins", :where =>
+     {:user => 'joe', :ip => '10.20.30.40'})
+    m.counter(:when => Time.now, :metric => "logins", :where =>
+     {:user => 'bob', :ip => '10.20.30.40'})
+    m.counter(:when => Time.now, :metric => "logins", :where =>
+     {:user => 'joe', :ip => '10.20.30.50'})
+
+    m.measure(:when => Time.now, :metric => "load_time", :value => 340, :where =>
+     {:page => '/welcome/', :session_id => "h0zhmb1c-u1xfgw305e"})
+    m.measure(:when => Time.now, :metric => "load_time", :value => 501, :where =>
+     {:page => '/welcome/', :session_id => "h0zhmb2q-643dotlcgd"})
+    m.measure(:when => Time.now, :metric => "load_time", :value => 212, :where =>
+     {:page => '/welcome/', :session_id => "h0zhmb1c-u1xfgw305e"})
+    m.measure(:when => Time.now, :metric => "load_time", :value => 343, :where =>
+     {:page => '/welcome/', :session_id => "h0zhmb2q-643dotlcgd"})
+
+    # Now we can query...
+
+    m.count(:when => "2012-04-13-17", :metric => "logins")
+     => 3
+    m.list(:when => "2012-04-13-17", :metric => "logins", :list => :user)
+     => ['joe', 'bob']
+    m.count(:when => "2012-04-13-17", :metric => "logins", :where => {:user => 'joe'})
+     => 2
+    m.count(:when => "2012-04-13-17", :metric => "logins", :where => {:user => 'bob'})
+     => 1
+    m.list(:when => "2012-04-13-17", :metric => "logins", :where => {:user => 'joe'}, :list => :ip)
+     => ['10.20.30.40', '10.20.30.50']
+    m.list(:when => "2012-04-13-17", :metric => "logins", :where => {:user => 'bob'}, :list => :ip)
+     => ['10.20.30.40']
+    m.count(:when => "2012-04-13-17", :metric => "logins", :where => {:user => 'joe', :ip => '10.20.30.40'})
+     => 1
+
+    m.count(:when => "2012-04-13-17", :metric => "load_time")
+     => 4
+    m.sum(:when => "2012-04-13-17", :metric => "load_time")
+     => 1396
+    m.average(:when => "2012-04-13-17", :metric => "load_time")
+     => 349.0
+    m.maximum(:when => "2012-04-13-17", :metric => "load_time")
+     => 501
+    m.minimum(:when => "2012-04-13-17", :metric => "load_time")
+     => 212
+    m.stddev(:when => "2012-04-13-17", :metric => "load_time")
+     => 102.45730818248154
+    m.list(:when => "2012-04-13-17", :metric => "load_time", :list => :page)
+     => ['/welcome/']
+
+    # We can do queries related to groups as well, with some limitations.
+    # We only guarantee the accuracy of the result if all related data was
+    # loaded from start-to-finish within :ttl_of_group_members seconds.
+    # Note: a range is the difference between the minimum and maximum metric,
+    # for an individual group.
+    m.count_of_groups(:when => "2012-04-13-17", :metric => "load_time", :group => :session_id)
+     => 2
+    m.sum_of_ranges(:when => "2012-04-13-17", :metric => "load_time", :group => :session_id)
+     => 286
+    m.average_range(:when => "2012-04-13-17", :metric => "load_time", :group => :session_id)
+     => 143
+    m.maximum_range(:when => "2012-04-13-17", :metric => "load_time", :group => :session_id)
+     => 158
+    m.minimum_range(:when => "2012-04-13-17", :metric => "load_time", :group => :session_id)
+     => 128
+    m.stddev_of_ranges(:when => "2012-04-13-17", :metric => "load_time", :group => :session_id)
+     => 15.0
+
+
+    # Supposing there were instead millions of counter and measure operations,
+    # metricstore may reach its list_threshold. Some queries will fail.
+
+    m.list(:page, "2012-04-13-17", "load_time")
+     => ['/welcome/', '/projects/']
+
+    m.list(:session_id, "2012-04-13-17", "load_time")
+    metricstore::DataLossError: Too many session_id for "2012-04-13-17", "load_time".
+
+    m.estimated_list_size(:session_id, "2012-04-13-17", "load_time")
+     => 3560831
+
+
+## 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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/metricstore.rb

@@ -0,0 +1,5 @@
+require "memtrics/version"
+
+module Metricstore
+  # Your code goes here...
+end

data/lib/metricstore/base_client.rb

@@ -0,0 +1,24 @@
+module Metricstore
+  module BaseClient
+
+    def initialize
+      @ttl_of_hours = 31_556_926 # 1 year
+      @ttl_of_minutes = 86_400 # 24 hours
+      @ttl_of_group_members = 7200 # 2 hours
+      @list_threshold = 1000
+    end
+
+    attr_accessor :ttl_of_hours
+    attr_accessor :ttl_of_minutes
+    attr_accessor :ttl_of_group_members
+    attr_accessor :list_threshold
+
+    def counter(args={})
+      #TODO
+    end
+
+    def measure(args={})
+      #TODO
+    end
+  end
+end

data/lib/metricstore/couchbase_client.rb

@@ -0,0 +1,16 @@
+module Metricstore
+  class CouchbaseClient
+    include BaseClient
+    
+    def initialize(*args, &callback)
+      super
+
+      require 'couchbase'
+      @couchbase = Couchbase.connect(*args, &callback)
+    end
+
+    private
+
+    attr_reader :couchbase
+  end
+end

data/lib/metricstore/version.rb

@@ -0,0 +1,3 @@
+module Metricstore
+  VERSION = "0.0.1"
+end

data/metricstore.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/metricstore/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Johnson"]
+  gem.email         = ["chris@kindkid.com"]
+  gem.description   = "Metrics in a key-value store."
+  gem.summary       = "Metrics in a key-value store. Accepts, summarizes, and stores continuous metrics updates to a key-value store. Answers queries in constant time."
+  gem.homepage      = "https://github.com/kindkid/metricstore"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "metricstore"
+  gem.require_paths = ["lib"]
+  gem.version       = Metricstore::VERSION
+
+  gem.add_dependency "couchbase", "~> 1.1.1"
+
+  gem.add_development_dependency "rspec", "~> 2.9.0"
+  gem.add_development_dependency "simplecov", "~> 0.6.1"
+  gem.add_development_dependency("rb-fsevent", "~> 0.9.1") if RUBY_PLATFORM =~ /darwin/i
+  gem.add_development_dependency "guard", "~> 1.0.1"
+  gem.add_development_dependency "guard-bundler", "~> 0.1.3"
+  gem.add_development_dependency "guard-rspec", "~> 0.7.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: metricstore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchbase
+  requirement: &70120781282620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70120781282620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70120781281880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70120781281880
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70120781281280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *70120781281280
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70120781280640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: *70120781280640
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70120781279980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *70120781279980
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &70120781279340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: *70120781279340
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70120781278700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70120781278700
+description: Metrics in a key-value store.
+email:
+- chris@kindkid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/metricstore.rb
+- lib/metricstore/base_client.rb
+- lib/metricstore/couchbase_client.rb
+- lib/metricstore/version.rb
+- metricstore.gemspec
+homepage: https://github.com/kindkid/metricstore
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Metrics in a key-value store. Accepts, summarizes, and stores continuous
+  metrics updates to a key-value store. Answers queries in constant time.
+test_files: []