fnordmetric 0.5.5 → 0.5.6

metadata

@@ -1,223 +1,229 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: fnordmetric
-version: !ruby/object:Gem::Version
-  version: 0.5.5
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.5.6
 platform: ruby
-authors:
+authors: 
 - Paul Asmuth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-28 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bson_ext
-  requirement: &81646210 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 1.4.0
   type: :runtime
-  prerelease: false
-  version_requirements: *81646210
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: sinatra
-  requirement: &81645630 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 1.2.6
   type: :runtime
-  prerelease: false
-  version_requirements: *81645630
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: redis
-  requirement: &81645130 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 2.2.2
   type: :runtime
-  prerelease: false
-  version_requirements: *81645130
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: eventmachine
-  requirement: &81644700 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *81644700
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: em-hiredis
-  requirement: &81644350 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *81644350
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &81643990 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *81643990
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: i18n
-  requirement: &82478780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *82478780
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: haml
-  requirement: &82478540 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *82478540
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: rack
-  requirement: &82478300 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *82478300
-- !ruby/object:Gem::Dependency
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
   name: rack-test
-  requirement: &82478060 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *82478060
-- !ruby/object:Gem::Dependency
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
   name: yajl-ruby
-  requirement: &82477820 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *82477820
-- !ruby/object:Gem::Dependency
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
   name: thin
-  requirement: &82477580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *82477580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
   name: activesupport
-  requirement: &82477340 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *82477340
-- !ruby/object:Gem::Dependency
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
   name: delorean
-  requirement: &82477100 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *82477100
-- !ruby/object:Gem::Dependency
+  version_requirements: *id014
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &82476860 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.6.0
   type: :development
-  prerelease: false
-  version_requirements: *82476860
-- !ruby/object:Gem::Dependency
+  version_requirements: *id015
+- !ruby/object:Gem::Dependency 
   name: shoulda
-  requirement: &82476620 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *82476620
-- !ruby/object:Gem::Dependency
+  version_requirements: *id016
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &82476380 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id017 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
-  prerelease: false
-  version_requirements: *82476380
-- !ruby/object:Gem::Dependency
+  version_requirements: *id017
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &82476140 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id018 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.5.2
   type: :development
-  prerelease: false
-  version_requirements: *82476140
+  version_requirements: *id018
 description: FnordMetric is a Ruby Event-Tracking gem on steroids
 email: paul@paulasmuth.com
 executables: []
+
 extensions: []
-extra_rdoc_files: []
-files:
+
+extra_rdoc_files: 
+- README.md
+files: 
 - .travis.yml
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - VERSION
 - doc/preview1.png
@@ -262,7 +268,6 @@ files:
 - pub/sprite.png
 - pub/vendor/highcharts.js
 - pub/vendor/jquery-1.6.1.min.js
-- readme.rdoc
 - spec/app_spec.rb
 - spec/context_spec.rb
 - spec/dashboard_spec.rb
@@ -274,32 +279,35 @@ files:
 - spec/spec_helper.rb
 - spec/widget_spec.rb
 - spec/worker_spec.rb
+has_rdoc: true
 homepage: http://github.com/paulasmuth/fnordmetric
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: FnordMetric is a Ruby Event-Tracking gem on steroids
-test_files:
+test_files: 
 - spec/app_spec.rb
 - spec/context_spec.rb
 - spec/dashboard_spec.rb

data/readme.rdoc

@@ -1,337 +0,0 @@
-= FnordMetric
-
-FnordMetric is a highly configurable (and pretty fast) realtime app/event tracking thing based on ruby eventmachine and redis. You define your own plotting and counting functions as ruby blocks!
-
-{<img src="https://secure.travis-ci.org/paulasmuth/fnordmetric.png" />}[http://travis-ci.org/paulasmuth/fnordmetric]
-
-SCREENCAST: http://www.screenr.com/KiJs - the FnordMetric-instance we use to track our social dating app
-
----
-
-FnordMetric keeps track of your data and draws nice timeline plots.
-
-{<img src="https://raw.github.com/paulasmuth/fnordmetric/master/doc/preview1.png" />}[https://raw.github.com/paulasmuth/fnordmetric/master/doc/preview1.png]
-
-FnordMetric gives you a live dashboard, that shows who is using your app in realtime. You can select a single user and follow them step by step.
-
-{<img src="https://raw.github.com/paulasmuth/fnordmetric/master/doc/preview2.png" />}[https://raw.github.com/paulasmuth/fnordmetric/master/doc/preview1.png]
-
-
-== Getting Started
-
-Copy doc/ulm_stats.rb (that's the configuration from the screenshots and screencast) or the simple example from below to 'my_stats_app.rb'
-
-Simple Example: This will listen for json-events with type=unicorn_seen and render a timeline-plot showing the number of received events per hour.
-
- require "fnordmetric"
-
-  FnordMetric.namespace :myapp do
-
-    # numeric (delta) gauge, 1-hour tick
-    gauge :unicorns_seen_per_hour, 
-      :tick => 1.hour.to_i, 
-      :title => "Unicorns seenper Hour"
-
-    # on every event like { _type: 'unicorn_seen' }
-    event(:unicorn_seen) do
-      # increment the unicorns_seen_per_hour gauge by 1
-      incr :unicorns_seen_per_hour 
-    end
-
-    # draw a timeline showing the gauges value, auto-refresh every 30s
-    widget 'Overview', {
-      :title => "Unicorn-Sightings per Hour",
-      :type => :timeline,
-      :gauges => :unicorns_seen_per_hour,  
-      :include_current => true,
-      :autoupdate => 2
-    }
-
-  end
-
-  FnordMetric.standalone
-
-Start the app (requires ruby >= 1.9.2):
-
-  $ ruby my_stats_app.rb run
-
-Log all incoming events:
-
-  $ ruby my_stats_app.rb log DUMP_FILE=/tmp/foo.json
-
-This is the easiest way to submit an event:
-
-  echo "{\"_type\": \"unicorn_seen\"}" | nc localhost 1337
-
-
-== Installation
-
-  gem install fnordmetric
-
-or in your Gemfile:
-
-  gem 'fnordmetric', '>= 0.5.1'
-
-
-== Documentation
-
-
-=== Sending Events
-
-The slow way: HTTP-Post the json event to the fnordmetric webinterface
-
-  POST http://localhost:2323/events _type=unicorn_seen
-
-  curl -X POST -d "_type=unicorn_seen" http://localhost:4242/events 
-
-The easy way: Stream one ore more newline-seperated json encoded events through a tcp connection.
-
-  echo "\{\"_type\": \"unicorn_seen\"\}\n" | nc localhost 2323
-
-The fast way: Add your event directly to the redis-based queue:
-
-  uuid = (8**32).to_s(36)
-  event = { :_type => "unicorn_seen" }.to_json
-
-  redis.lpush("fnordmetric-queue", uuid) 
-  redis.set("fnordmetric-event-#{my_uuid}", event)
-  redis.expire("fnordmetric-event-#{my_uuid}", 60)
-
----
-
-=== Special Events
-
-  // track a pageview
-  { "_type": "_pageview", "url": "/blob/my_super_seo_article", "_session": "mysessiontoken" }
-
-  // set the user name
-  { "_type": "_set_name", "name": "Tingle Tangle Bob", "_session": "mysessiontoken" }
-
-  // set the user picture
-  { "_type": "_set_picture", "url": "http://myhost/123.jpg", "_session": "mysessiontoken" }
-
-
----
-
-=== DSL Methods
-
-  gauge
-
-  widget
-
-  event
-
-
----
-
-=== Event Handlers
-
-call these methods from the event-handler block
-
-  incr(gauge_name, value=1): 
-    Increment the given (two-dimensional) gauge by value at the tick specified by event-time
-
-  incr_field(gauge_name, field_name, value=1): 
-    Increment the given field on a three-dimensional gauge by value at the tick specified by event-time
-
-  set_value(gauge_name, value)
-    Set the given (two-dimensional) to value at the tick specified by event-time (overwrite existing value)
-
-  set_field(gauge_name, field_name, value)
-    Set the given  field on a three-dimensional gauge to value at the tick specified by event-time (overwrite existing value)
-
-
----
-
-=== Gauges
-
----
-
-=== Widgets
-
-[autoupdate] auto-refresh the timeline every n secs (0 turns autoupdate off)
-
-==== Widget-Options: TimelineWidget
-
-[plot_style] one of: line, areaspline
-[include_current] show the current tick?
-[ticks] number of ticks to show (defaults to 24/30)
-
-==== Widget-Options: BarsWidget
-
-[plot_style] one of: vertical, horizontal
-[order_by]: order bars/columns by: value, field
-
-==== Widget-Options: Numbers-Widget
-
-==== Widget-Options: ToplistWidget
-
-
----
-
-=== JSON API
-
-
-
-== Examples
-  
-(link1), (link2), (link3), (link4)
-
-
-
-== Full Example
-
-  require "fnordmetric"
-
-  FnordMetric.namespace :myapp do
-
-    # numeric (delta) gauge, 1-hour tick
-    gauge :messages_sent, 
-      :tick => 1.hour.to_i, 
-      :title => "Messages (sent) per Hour"
-
-    # numeric (delta) gauge, 1-hour tick
-    gauge :messages_read, 
-      :tick => 1.hour.to_i, 
-      :title => "Messages (read) per Hour"
-
-    # numeric (progressive) gauge, 1-hour tick
-    gauge :events_total, 
-      :tick => 1.day.to_i, 
-      :progressive => true,
-      :title => "Events (total)"
-
-    # numeric (delta) gauge, increments uniquely by session_key
-    gauge :pageviews_daily_unique, 
-      :tick => 1.day.to_i, 
-      :unique => true, 
-      :title => "Unique Visits (Daily)"
-
-    # numeric (delta) gauge, increments uniquely by session_key, returns average
-    gauge :avg_age_per_session, 
-      :tick => 1.day.to_i, 
-      :unique => true,
-      :average => true,
-      :title => "Avg. User Age"
-
-    # three-dimensional (delta) gauge (time->key->value)
-    gauge :pageviews_per_url_daily, 
-      :tick => 1.day.to_i, 
-      :title => "Daily Pageviews per URL", 
-      :three_dimensional => true
-
-
-    # on every event like { _type: 'message_sent' }
-    event(:message_sent) do
-      # increment the messages_sent gauge by 1
-      incr :messages_sent 
-    end
-
-    # on every event like { _type: 'message_read' }
-    event(:message_read) do 
-      # increment the messages_read gauge by 1
-      incr :messages_read 
-    end
-
-    # on _every_ event
-    event :"*" do
-      # increment the events_total gauge by 1
-      incr :events_total
-    end
-
-    # on every event like { _type: '_pageview', _session: 'sbz7jset', _url: '/page2' }
-    event :_pageview do
-      # increment the daily_uniques gauge by 1 if session_key hasn't been seen in this tick yet
-      incr :pageviews_daily_unique
-      # increment the pageviews_per_url_daily gauge by 1 where key = 'page2'
-      incr_field :pageviews_per_url_daily, data[:url]
-    end
-
-   # on every event like { _type: '_pageview', my_set_age: '23' }
-    event(:my_set_age) do 
-      # add the value of my_set_age to the avg_age_per_session gauge if session_key 
-      # hasn't been seen in this tick yet
-      incr :avg_age_per_session, data[:my_age_field] 
-    end
- 
-    # draw a timeline showing the pageviews_daily_unique, auto-refresh every 30s
-    widget 'Overview', {
-      :title => "Unique Visits per Day",
-      :type => :timeline,
-      :width => 70,
-      :gauges => :pageviews_daily_unique,
-      :include_current => true,
-      :autoupdate => 30
-    }
-
-   # draw the values of the messages_sent and messages_read gauge at the current tick, three ticks ago, and
-   # the sum of the last 10 ticks, auto-refresh every 20s
-   widget 'Overview', {
-      :title => "Messages Sent / Read",
-      :type => :numbers,
-      :width => 30,
-      :autoupdate => 20,
-      :offsets => [0,3,"10s"]
-      :gauges => [ :messages_sent, :messages_read ]
-    }
-
-    # draw a list of the most visited urls (url, visits + percentage), auto-refresh every 20s
-    widget 'Overview', {
-      :title => "Top Pages",
-      :type => :toplist,
-      :autoupdate => 20,
-      :gauges => [ :pageviews_per_url_daily ]
-    }
-
-  end
-
-  FnordMetric.standalone
-
-
-== License
-
-Copyright (c) 2011 Paul Asmuth
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to use, copy and modify copies of the Software, 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.
-
-
-== Todos
-
-  -> funnel-widget
-  -> combine/calculation gauges via opts_gauge({}, &block) (+calculate ctr)
-  -> timeline_widget: 'compare mode': compate gauge to yesterday
-  -> fix include_current
-  -> numbers_widget: handle decreasing vals
-  -> make redis-addr and redis-prefix + listen-ports configurable
-  -> referal tracking fu (parse googlequeries)  
-  -> trend detection
-  -> opt_event options: :increment => gauge_name
-  -> preconfigured default-dashboard (like google analytics)
-  -> pagview+ref-tracking via js-tracking-pixel 
-  -> table/gauge-list-widget (with mini-stats!)
-  -> prune the namespace-sessions-timline (remove event_ids older than x)
-  -> prune the namespace-event-types-list (trim to max items)
-  -> timelinewidget + numberswidget => should use redis hmget
-  -> get multiple metrics in a single http get
-  -> { _namespace: myns } field (!!!)
-  
-
-  -> demo / example: chatroom;  
-    -> events: msg_read, msg_sent, {reg_start, reg_register, reg_active}, login (+demog.data+lang), referall
-    -> widgets: msgs sent/read (timeline), user-demog. (bars), reg-funnel (funnel), male vs. female users (pie), top langs (list), kpi list (toplist - regs, msg/user, conversion rate, etc), top referrers
-
-