pulse-meter 0.2.11 → 0.3.0

data/.rbenv-version

@@ -1 +1 @@
-1.9.2-p290
+1.9.3-p125

data/README.md

@@ -76,10 +76,26 @@ There are several caveats with timeline sensors:
     When building a visualisation you may choose to display the last value or not.
   * For some sensors (currently Median and Percentile) considerable amount of data should be stored for a
     particular interval to obtain value for this interval. So it is a good idea to schedule
-    <tt>pulse reduce</tt>
+    `pulse reduce`
     command on a regular basis. This command reduces the stored data for passed intervals to single values,
     so that they do not consume storage space.
 
+
+### Observers
+
+Observer allows to notify a sensor each time some class or instance method is called
+Suppose you have a user model and want to count users distribytion by name. To do this you have to observe class method `create` of User class:
+
+    counter = PulseMeter::Sensor::HashedCounter.new :users_by_name
+    PulseMeter::Observer.observe_class_method(User, :create, counter) do |execution_time, attrs|
+      event({attrs[:name] => 1})
+    end
+    
+Block recieves all execution time and observed method's argements and is executed in context of sensor passed to observer (this means that event method refers to `counter`).    
+To observe instance methods use `observe_method`. 
+
+`unobserve_class_method` and `unobserve_method` remove observations from class or instace method.
+
 ## Client usage
 
 Just create sensor objects and write data. Some examples below.
@@ -146,7 +162,7 @@ Just create sensor objects and write data. Some examples below.
     # 2012-05-24 11:07:00 +0400: 3.0
     # 2012-05-24 11:08:00 +0400: 7.0
  
- There is also an alternative and a bit more DRY way for sensor creation, management and usage using <tt>PulseMeter::Sensor::Configuration</tt> class. It is also convenient for creating a bunch of sensors from some configuration data.  
+ There is also an alternative and a bit more DRY way for sensor creation, management and usage using `PulseMeter::Sensor::Configuration` class. It is also convenient for creating a bunch of sensors from some configuration data.  
  
 	require 'pulse-meter'
 	PulseMeter.redis = Redis.new
@@ -205,12 +221,12 @@ Just create sensor objects and write data. Some examples below.
 
 ## Command line interface
 
-Gem includes a tool <tt>pulse</tt>, which allows to send events to sensors, list them, etc.
-You should pay attention to the command <tt>pulse reduce</tt>, which is generally should be
+Gem includes a tool `pulse`, which allows to send events to sensors, list them, etc.
+You should pay attention to the command `pulse reduce`, which is generally should be
 scheduled on a regular basis to keep data in Redis small.
 
-To see available commands of this tool one can run the example above(see <tt>examples/readme\_client\_example.rb</tt>)
-and run <tt>pulse help</tt>.
+To see available commands of this tool one can run the example above(see `examples/readme_client_example.rb`)
+and run `pulse help`.
 
 ## Visualisation
 
@@ -225,12 +241,12 @@ There is a minimal and a full example below.
 
 ### Minimal example
 
-It can be found in <tt>examples/minimal</tt> folder. To run it, execute
-<tt>bundle && cd examples/minimal && bundle exec foreman start</tt> (or just <tt>rake example:minimal</tt>)
+It can be found in `examples/minimal` folder. To run it, execute
+`bundle && cd examples/minimal && bundle exec foreman start` (or just `rake example:minimal`)
 at project root and visit
-<tt>http://localhost:9292</tt> at your browser.
+`http://localhost:9292` at your browser.
 
-<tt>client.rb</tt> just creates a timelined counter an sends data to it in an infinite loop.
+`client.rb` just creates a timelined counter an sends data to it in an infinite loop.
 
     require "pulse-meter"
 
@@ -247,7 +263,7 @@ at project root and visit
       sleep(Random.rand)
     end
 
-<tt>server.ru</tt> is a Rackup file creating a simple layout with one page and one widget on it, which displays
+`server.ru` is a Rackup file creating a simple layout with one page and one widget on it, which displays
 the sensor's data. The layout is converted to a rack application and launched.
 
     require "pulse-meter/visualizer"
@@ -269,19 +285,19 @@ the sensor's data. The layout is converted to a rack application and launched.
 
     run layout.to_app
 
-<tt>Procfile</tt> allows to launch both "client" script and the web server with <tt>foreman</tt>.
+`Procfile` allows to launch both "client" script and the web server with `foreman`.
 
     web: bundle exec rackup server.ru
     sensor_data_generator: bundle exec ruby client.rb
 
 ### Full example with DSL explanation
 
-It can be found in <tt>examples/full</tt> folder. To run it, execute
-<tt>bundle && cd examples/full && bundle exec foreman start</tt> (or just <tt>rake example:full</tt>)
+It can be found in `examples/full` folder. To run it, execute
+`bundle && cd examples/full && bundle exec foreman start` (or just `rake example:full`)
 at project root and visit
-<tt>http://localhost:9292</tt> at your browser.
+`http://localhost:9292` at your browser.
 
-<tt>client.rb</tt> imitating users visiting some imaginary site.
+`client.rb` imitating users visiting some imaginary site.
 
     require "pulse-meter"
 

data/Rakefile

@@ -1,7 +1,11 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
+require 'coffee-script'
+require 'listen'
 require 'rspec/core/rake_task'
-require "yard"
+require 'sprockets'
+require 'tilt'
+require 'yard'
 require 'yard/rake/yardoc_task'
 
 RSpec::Core::RakeTask.new(:spec)
@@ -13,17 +17,32 @@ ROOT = File.dirname(__FILE__)
 task :default => :spec
 
 namespace :coffee do
-	desc "Complile coffee to js"
-	task :compile do
-		system 'coffee', '-c', "#{ROOT}/lib/pulse-meter/visualize/public/"
-		puts "Done"
-	end
+  COFFEE_PATH = "#{ROOT}/lib/pulse-meter/visualize/coffee"
 
-	desc "Watch coffee files and recomplile them immediately"
-	task :watch do
-		system 'coffee', '--watch', '-c', "#{ROOT}/lib/pulse-meter/visualize/public/"
-	end
+  def compile_js
+    Tilt::CoffeeScriptTemplate.default_bare = true
+    env = Sprockets::Environment.new
+    env.append_path COFFEE_PATH
+    data = env['application.coffee']
+    open("#{ROOT}/lib/pulse-meter/visualize/public/js/application.js", "w").write(data)
+    puts "application.js compiled"
+  end
+
+  desc "Compile coffee to js"
+  task :compile do
+    compile_js
+  end
 
+  desc "Watch coffee files and recomplile them immediately"
+  task :watch do
+    Listen.to(COFFEE_PATH) do |modified, added, removed|
+      puts "Modified: #{modified}" unless modified.empty?
+      puts "Added: #{added}" unless added.empty?
+      puts "Removed: #{removed}" unless removed.empty?
+      puts "Recompiling..."
+      compile_js
+    end
+  end
 end
 
 namespace :yard do

data/examples/basic.ru

@@ -1,4 +1,4 @@
-$: << File.join(File.absolute_path(__FILE__), '..', 'lib')
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'pulse-meter/visualizer'
 

data/examples/full/server.ru

@@ -1,4 +1,4 @@
-$: << File.join(File.absolute_path(__FILE__), '..', 'lib')
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require "pulse-meter/visualizer"
 

data/examples/minimal/server.ru

@@ -1,4 +1,4 @@
-$: << File.join(File.absolute_path(__FILE__), '..', 'lib')
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require "pulse-meter/visualizer"
 

data/lib/pulse-meter.rb

@@ -4,6 +4,7 @@ require "pulse-meter/version"
 require "pulse-meter/mixins/dumper"
 require "pulse-meter/mixins/utils"
 require "pulse-meter/mixins/cmd"
+require "pulse-meter/observer"
 require "pulse-meter/sensor"
 require "pulse-meter/sensor/configuration"
 

data/lib/pulse-meter/observer.rb

@@ -0,0 +1,117 @@
+require 'pulse-meter'
+
+module PulseMeter
+  class Observer
+    class << self
+      # Removes observation from instance method
+      # @param klass [Class] class
+      # @param method [Symbol] instance method name
+      def unobserve_method(klass, method)
+        with_observer = method_with_observer(method)
+        without_observer = method_without_observer(method)
+
+        return unless klass.method_defined? with_observer
+        klass.class_eval do
+          alias_method method, without_observer
+          remove_method with_observer
+          remove_method without_observer
+        end
+      end
+
+      # Removes observation from class method
+      # @param klass [Class] class
+      # @param method [Symbol] class method name
+      def unobserve_class_method(klass, method)
+        with_observer = method_with_observer(method)
+        without_observer = method_without_observer(method)
+
+        return unless klass.respond_to? with_observer
+        metaclass(klass).instance_eval do
+          alias_method method, without_observer
+          remove_method with_observer
+          remove_method without_observer
+        end
+      end
+
+      # Registeres an observer for instance method
+      # @param klass [Class] class
+      # @param method [Symbol] instance method
+      # @param sensor [Object] notifications receiver
+      # @param proc [Proc] proc to be called in context of receiver each time observed method called
+      def observe_method(klass, method, sensor, &proc)
+        with_observer = method_with_observer(method)
+        without_observer = method_without_observer(method)
+
+        return if klass.method_defined? with_observer
+            
+        klass.class_eval do
+          alias_method without_observer, method
+          define_method with_observer do |*args, &block|
+            result = nil
+            start_time = Time.now
+            begin
+              result = self.send without_observer, *args, &block
+            ensure
+              begin
+                delta = ((Time.now - start_time) * 1000).to_i
+                sensor.instance_exec delta, *args, &proc
+              rescue Exception
+              end
+            end
+            result
+          end
+          alias_method method, with_observer
+        end
+      end
+
+      # Registeres an observer for class method
+      # @param klass [Class] class
+      # @param method [Symbol] class method
+      # @param sensor [Object] notifications receiver
+      # @param proc [Proc] proc to be called in context of receiver each time observed method called
+      def observe_class_method(klass, method, sensor, &proc)
+        with_observer = method_with_observer(method)
+        without_observer = method_without_observer(method)
+
+        return if klass.respond_to? with_observer
+
+        metaclass(klass).instance_eval do
+          alias_method without_observer, method
+          define_method with_observer do |*args, &block|
+            result = nil
+            start_time = Time.now
+            begin
+              result = self.send without_observer, *args, &block
+            ensure
+              begin
+                delta = ((Time.now - start_time) * 1000).to_i
+                sensor.instance_exec delta, *args, &proc
+              rescue Exception
+              end
+            end
+            result
+          end
+          alias_method method, with_observer
+        end
+      end
+
+      private
+
+      def metaclass(klass)
+        klass.class_eval do
+          class << self
+            self
+          end
+        end
+      end
+
+      def method_with_observer(method)
+        "#{method}_with_observer"
+      end
+
+      def method_without_observer(method)
+        "#{method}_without_observer"
+      end
+    end
+  end
+end

data/lib/pulse-meter/sensor.rb

@@ -15,6 +15,7 @@ require 'pulse-meter/sensor/timelined/hashed_indicator'
 require 'pulse-meter/sensor/timelined/min'
 require 'pulse-meter/sensor/timelined/max'
 require 'pulse-meter/sensor/timelined/percentile'
+require 'pulse-meter/sensor/timelined/multi_percentile'
 require 'pulse-meter/sensor/timelined/median'
 require 'pulse-meter/sensor/timelined/uniq_counter'
 

data/lib/pulse-meter/sensor/timeline.rb

@@ -74,8 +74,9 @@ module PulseMeter
         interval_data_key = data_key(interval_id)
         multi do
           redis.del(interval_raw_data_key)
-          redis.set(interval_data_key, value)
-          redis.expire(interval_data_key, ttl)
+          if redis.setnx(interval_data_key, value)
+            redis.expire(interval_data_key, ttl)
+          end
         end
       end
 

data/lib/pulse-meter/sensor/timelined/multi_percentile.rb

@@ -0,0 +1,43 @@
+module PulseMeter
+  module Sensor
+    module Timelined
+      # Calculates n'th percentile in interval
+      class MultiPercentile < Timeline
+        attr_reader :p_value
+
+        def initialize(name, options)
+          @p_value = assert_array!(options, :p, [])
+          @p_value.each {|p| assert_ranged_float!({:percentile => p}, :percentile, 0, 1)}
+          super(name, options)
+        end
+
+        def aggregate_event(key, value)
+          redis.zadd(key, value, "#{value}::#{uniqid}")
+        end
+
+        def summarize(key)
+          @p_value.each_with_object({}) do |p, acc|
+            count = redis.zcard(key)
+            percentile = if count > 0
+              position = p > 0 ? (p * count).round - 1 : 0
+              el = redis.zrange(key, position, position)[0]
+              redis.zscore(key, el)
+            else
+              nil
+            end
+            acc[p] = percentile
+          end.to_json
+        end
+
+        private
+        
+        def deflate(value)
+          hash = JSON.parse(value)
+          hash.each {|p, v| hash[p] = v.to_f}
+          hash
+        end
+
+      end
+    end
+  end
+end

data/lib/pulse-meter/version.rb

@@ -1,3 +1,3 @@
 module PulseMeter
-  VERSION = "0.2.11"
+  VERSION = "0.3.0"
 end

data/lib/pulse-meter/visualize/app.rb

@@ -24,25 +24,35 @@ module PulseMeter
       get '/' do
         @title = @layout.title
         gon.pageInfos = camelize_keys(@layout.page_infos)
-				gon.options = camelize_keys(@layout.options)
+        gon.options = camelize_keys(@layout.options)
         haml :main
       end
 
-			get '/pages/:id/widgets' do
-				id = params[:id].to_i 
+      get '/pages/:id/widgets' do
+        id = params[:id].to_i 
 
-				content_type :json
+        content_type :json
         camelize_keys(@layout.widgets(id - 1)).to_json
-			end
+      end
 
-			get '/pages/:page_id/widgets/:id' do
-				page_id = params[:page_id].to_i 
-				id = params[:id].to_i
+      get '/pages/:page_id/widgets/:id' do
+        page_id = params[:page_id].to_i 
+        id = params[:id].to_i
         timespan = params[:timespan].to_i
+				start_time = params[:startTime].to_i
+				end_time = params[:endTime].to_i
 
-				content_type :json
-        camelize_keys(@layout.widget(page_id - 1, id - 1, timespan: timespan)).to_json
-			end
+        content_type :json
+        camelize_keys(
+					@layout.widget(
+						page_id - 1,
+						id - 1,
+						timespan: timespan,
+						start_time: start_time,
+						end_time: end_time
+					)
+				).to_json
+      end
 
       get '/sensors' do
         content_type :json
@@ -50,9 +60,15 @@ module PulseMeter
       end
 
       get '/dynamic_widget' do
+				start_time = params[:startTime].to_i
+				end_time = params[:endTime].to_i
+        timespan = params[:timespan].to_i
+
         content_type :json
         camelize_keys(@layout.dynamic_widget(
-          timespan:  params[:timespan],
+          timespan: timespan,
+          start_time: start_time,
+          end_time: end_time,
           sensors: params[:sensor],
           type: params[:type])
         ).to_json