right_support 2.8.26 → 2.8.27

data/VERSION

@@ -1 +1 @@
-2.8.26
+2.8.27

data/lib/right_support/stats/activity.rb

@@ -56,7 +56,7 @@ module RightSupport::Stats
     def reset
       @interval = 0.0
       @last_start_time = Time.now
-      @avg_duration = nil
+      @avg_latency = nil
       @total = 0
       @count_per_type = {}
       @last_type = nil
@@ -89,22 +89,22 @@ module RightSupport::Stats
       now
     end
 
-    # Mark the finish of an activity and update the average duration
+    # Mark the finish of an activity and update the average latency
     #
     # @param start_time [Time] Time when activity started, defaults to last time update was called
     # @param id [String] Unique identifier associated with this activity
     #
-    # @return [Float] Activity duration in seconds
+    # @return [Float] Activity latency in seconds
     def finish(start_time = nil, id = nil)
       now = Time.now
       start_time ||= @last_start_time
-      duration = now - start_time
-      @avg_duration = average(@avg_duration || 0.0, duration)
+      latency = now - start_time
+      @avg_latency = average(@avg_latency || 0.0, latency)
       @last_id = 0 if id && id == @last_id
-      duration
+      latency
     end
 
-    # Update activity and measure its duration
+    # Update activity and measure its latency
     #
     # @param type [String, Symbol] Type of activity, with anything that is not a symbol, true, or false
     #   automatically converted to a String and truncated to MAX_TYPE_SIZE characters; defaults to nil
@@ -134,14 +134,17 @@ module RightSupport::Stats
       end
     end
 
-    # Get average duration of activity
+    # Get average latency for performing an activity
     #
-    # @return [Float, NilClass] Average duration in seconds of activity weighted
+    # @return [Float, NilClass] Average latency in seconds of activity weighted
     #   toward past activity, or nil if total is 0
-    def avg_duration
-      @avg_duration
+    def avg_latency
+      @avg_latency
     end
 
+    # avg_duration is deprecated but still supported
+    alias :avg_duration :avg_latency
+
     # Get stats about last activity
     #
     # @return [Hash, NilClass] Information about last activity, or nil if the total is 0
@@ -170,7 +173,7 @@ module RightSupport::Stats
       end
     end
 
-    # Get stat summary including all aspects of activity that were measured except duration
+    # Get stat summary including all aspects of activity that were measured except latency
     #
     # @return [Hash, NilClass] Information about activity, or nil if the total is 0
     #   "total" [Integer] Total activity count
@@ -180,6 +183,7 @@ module RightSupport::Stats
     #     "type" [String] Type of activity if tracking type, otherwise omitted
     #     "active" [Boolean] Whether activity still active if tracking whether active, otherwise omitted
     #   "rate" [Float] Recent average rate if measuring rate, otherwise omitted
+    #   "latency" [Float] Recent average latency if measuring latency, otherwise omitted
     def all
       if @total > 0
         result = if @count_per_type.empty?
@@ -189,6 +193,7 @@ module RightSupport::Stats
         end
         result.merge!("last" => last)
         result.merge!("rate" => avg_rate) if @measure_rate
+        result.merge!("latency" => avg_latency) if @avg_latency
         result
       end
     end
@@ -219,12 +224,15 @@ module RightSupport::Stats
     #     "type" [String] Type of activity if tracking type, otherwise omitted
     #     "active" [Boolean] Whether activity still active if tracking whether active, otherwise omitted
     #   "rate" [Float] Recent average rate if measuring rate, otherwise omitted
+    #   "latency" [Float] Recent average latency if measuring latency, otherwise omitted
     def self.all(stats)
       if (total = stats.inject(0) { |t, s| t += s["total"] if s && s["total"]; t }) > 0
         all = percentage(stats, total)
         all["last"] = last(stats.map { |s| s["last"] if s })
         rate = avg_rate(stats.map { |s| {"rate" => s["rate"], "total" => s["total"]} if s }, total)
         all["rate"] = rate if rate
+        latency = avg_latency(stats.map { |s| {"latency" => s["latency"], "total" => s["total"]} if s }, total)
+        all["latency"] = latency if latency
         all
       end
     end
@@ -267,6 +275,17 @@ module RightSupport::Stats
       sum / total if sum
     end
 
+    # Compute average latency from multiple average latency
+    #
+    # @param stats [Array] List of stats containing hash of "latency" and "total"
+    # @param total [Integer] Overall total
+    #
+    # @return [Fixnum, NilClass] Average latency or nil if no average latency data
+    def self.avg_latency(stats, total)
+      sum = stats.inject(nil) { |sum, stat| sum = (sum || 0.0) + (stat["latency"] * stat["total"]) if stat && stat["latency"]; sum }
+      sum / total if sum
+    end
+
     # Determine last activity from multiple last activity stats
     #
     # @param stats [Array] Multiple last activity stats

data/lib/right_support/stats/helpers.rb

@@ -420,7 +420,7 @@ module RightSupport
     #     "type"(String):: Type of activity if tracking type, otherwise omitted
     #     "active"(Boolean):: Whether activity still active if tracking whether active, otherwise omitted
     #   "rate" [Float] Recent average rate if measuring rate, otherwise omitted
-    #   "duration" [Float] Average duration of activity if tracking duration, otherwise omitted
+    #   "latency" [Float] Recent average latency of activity if tracking latency, otherwise omitted
     #
     # @return [String] Activity stats in displayable format without any line separators
     def self.activity_str(value)
@@ -430,9 +430,9 @@ module RightSupport
       str += "#{value['total']}"
       str += ", last: #{last_activity_str(value['last'], single_item = true)}" if value["last"]
       str += ", rate: #{enough_precision(value['rate'])}/sec" if value["rate"]
-      str += ", duration: #{enough_precision(value['duration'])} sec" if value["duration"]
+      str += ", latency: #{enough_precision(value['latency'])} sec" if value["latency"]
       value.each do |name, data|
-        unless ["total", "percent", "last", "rate", "duration"].include?(name)
+        unless ["total", "percent", "last", "rate", "latency"].include?(name)
           str += ", #{name}: #{data.is_a?(String) ? data : data.inspect}"
         end
       end

data/right_support.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: right_support 2.8.26 ruby lib
+# stub: right_support 2.8.27 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "right_support"
-  s.version = "2.8.26"
+  s.version = "2.8.27"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Tony Spataro", "Sergey Sergyenko", "Ryan Williamson", "Lee Kirchhoff", "Alexey Karpik", "Scott Messier"]
-  s.date = "2014-08-06"
+  s.date = "2014-08-08"
   s.description = "A toolkit of useful, reusable foundation code created by RightScale."
   s.email = "support@rightscale.com"
   s.extra_rdoc_files = [

data/spec/stats/activity_spec.rb

@@ -47,7 +47,7 @@ describe RightSupport::Stats::Activity do
     it "initializes stats data" do
       @stats.instance_variable_get(:@interval).should == 0.0
       @stats.instance_variable_get(:@last_start_time).should == @now
-      @stats.instance_variable_get(:@avg_duration).should be_nil
+      @stats.instance_variable_get(:@avg_latency).should be_nil
       @stats.instance_variable_get(:@total).should == 0
       @stats.instance_variable_get(:@count_per_type).should == {}
     end
@@ -59,7 +59,7 @@ describe RightSupport::Stats::Activity do
       @stats.update
       @stats.instance_variable_get(:@interval).should == 1.0
       @stats.instance_variable_get(:@last_start_time).should == @now + 10
-      @stats.instance_variable_get(:@avg_duration).should be_nil
+      @stats.instance_variable_get(:@avg_latency).should be_nil
       @stats.instance_variable_get(:@total).should == 1
       @stats.instance_variable_get(:@count_per_type).should == {}
     end
@@ -69,7 +69,7 @@ describe RightSupport::Stats::Activity do
       @stats.update("test")
       @stats.instance_variable_get(:@interval).should == 1.0
       @stats.instance_variable_get(:@last_start_time).should == @now + 10
-      @stats.instance_variable_get(:@avg_duration).should be_nil
+      @stats.instance_variable_get(:@avg_latency).should be_nil
       @stats.instance_variable_get(:@total).should == 1
       @stats.instance_variable_get(:@count_per_type).should == {"test" => 1}
     end
@@ -106,7 +106,7 @@ describe RightSupport::Stats::Activity do
       @stats.update
       @stats.instance_variable_get(:@interval).should == 0.0
       @stats.instance_variable_get(:@last_start_time).should == @now + 10
-      @stats.instance_variable_get(:@avg_duration).should be_nil
+      @stats.instance_variable_get(:@avg_latency).should be_nil
       @stats.instance_variable_get(:@total).should == 1
       @stats.instance_variable_get(:@count_per_type).should == {}
     end
@@ -118,24 +118,24 @@ describe RightSupport::Stats::Activity do
   end
 
   context :finish do
-    it "updates duration when finish using internal start time by default" do
+    it "updates latency when finish using internal start time by default" do
       flexmock(Time).should_receive(:now).and_return(1000010)
-      @stats.avg_duration.should be_nil
+      @stats.avg_latency.should be_nil
       @stats.finish
       @stats.instance_variable_get(:@interval).should == 0.0
       @stats.instance_variable_get(:@last_start_time).should == @now
-      @stats.instance_variable_get(:@avg_duration).should == 1.0
+      @stats.instance_variable_get(:@avg_latency).should == 1.0
       @stats.instance_variable_get(:@total).should == 0
       @stats.instance_variable_get(:@count_per_type).should == {}
     end
 
-    it "updates duration when finish using specified start time" do
+    it "updates latency when finish using specified start time" do
       flexmock(Time).should_receive(:now).and_return(1000030)
-      @stats.avg_duration.should be_nil
+      @stats.avg_latency.should be_nil
       @stats.finish(1000010)
       @stats.instance_variable_get(:@interval).should == 0.0
       @stats.instance_variable_get(:@last_start_time).should == @now
-      @stats.instance_variable_get(:@avg_duration).should == 2.0
+      @stats.instance_variable_get(:@avg_latency).should == 2.0
       @stats.instance_variable_get(:@total).should == 0
       @stats.instance_variable_get(:@count_per_type).should == {}
     end
@@ -150,7 +150,7 @@ describe RightSupport::Stats::Activity do
       @stats.instance_variable_get(:@total).should == 1
       @stats.instance_variable_get(:@count_per_type).should == {"test" => 1}
       @stats.instance_variable_get(:@last_id).should == 0
-      @stats.instance_variable_get(:@avg_duration).should == 1.0
+      @stats.instance_variable_get(:@avg_latency).should == 1.0
     end
 
     it "yields to the block" do
@@ -227,7 +227,7 @@ describe RightSupport::Stats::Activity do
       @stats.last.should == {"elapsed" => 10, "type" => "test", "active" => true}
       @stats.finish(@now - 10, "token")
       @stats.last.should == {"elapsed" => 10, "type" => "test", "active" => false}
-      @stats.instance_variable_get(:@avg_duration).should == 2.0
+      @stats.instance_variable_get(:@avg_latency).should == 2.0
     end
   end
 
@@ -251,17 +251,25 @@ describe RightSupport::Stats::Activity do
   end
 
   context :all do
-    it "returns all activity aspects that were measured except duration" do
+    it "returns all activity aspects that were measured" do
       flexmock(Time).should_receive(:now).and_return(1000020, 1000042)
       @stats.update
-      @stats.all.should == {"last" => {"elapsed" => 22}, "total" => 1, "rate" => 0.25}
+      @stats.finish
+      @stats.all.should == {"last" => {"elapsed" => 22}, "total" => 1, "rate" => 0.25, "latency" => 2.2}
     end
 
     it "excludes rate if it is not being measured" do
       @stats = RightSupport::Stats::Activity.new(false)
-      flexmock(Time).should_receive(:now).and_return(1000010)
+      flexmock(Time).should_receive(:now).and_return(1000020, 1000042)
+      @stats.update
+      @stats.finish
+      @stats.all.should == {"last" => {"elapsed" => 22}, "total" => 1, "latency" => 2.2}
+    end
+
+    it "excludes latency if it is not being measured" do
+      flexmock(Time).should_receive(:now).and_return(1000020, 1000042)
       @stats.update
-      @stats.all.should == {"last" => {"elapsed" => 0}, "total" => 1}
+      @stats.all.should == {"last" => {"elapsed" => 22}, "total" => 1, "rate" => 0.25}
     end
 
     it "includes percentage breakdown when update recorded per type" do
@@ -310,6 +318,13 @@ describe RightSupport::Stats::Activity do
             {"last" => {"elapsed" => 10, "type" => "foo"}, "total" => 5, "percent" => {"foo" => 20.0, "bar" => 80.0}, "rate" => 0.18}
       end
 
+      it "includes latency if provided" do
+        stats = [{"last" => {"elapsed" => 10, "type" => "foo"}, "total" => 1, "percent" => {"foo" => 100.0}, "rate" => 0.5, "latency" => 0.5},
+                 {"last" => {"elapsed" => 20, "type" => "bar"}, "total" => 4, "percent" => {"bar" => 100.0}, "rate" => 0.1, "latency" => 0.1}]
+        RightSupport::Stats::Activity.all(stats).should ==
+            {"last" => {"elapsed" => 10, "type" => "foo"}, "total" => 5, "percent" => {"foo" => 20.0, "bar" => 80.0}, "rate" => 0.18, "latency" => 0.18}
+      end
+
       it "handles nil stat" do
         stats = [{"last" => {"elapsed" => 10, "type" => "foo"}, "total" => 1, "percent" => {"foo" => 100.0}},
                  nil,
@@ -367,6 +382,28 @@ describe RightSupport::Stats::Activity do
       end
     end
 
+    context :avg_latency do
+      it "computes average latency from multiple average latencies" do
+        stats = [{"total" => 1, "latency" => 0.5},
+                 {"total" => 5, "latency" => 0.1},
+                 {"total" => 4, "latency" => 0.2}]
+        RightSupport::Stats::Activity.avg_latency(stats, 10).should == 0.18
+      end
+
+      it "handles nil stat" do
+        stats = [{"total" => 1, "latency" => 0.5},
+                 nil,
+                 {"total" => 5, "latency" => 0.1},
+                 nil,
+                 {"total" => 4, "latency" => 0.2}]
+        RightSupport::Stats::Activity.avg_latency(stats, 10).should == 0.18
+      end
+
+      it "returns nil if there is no data" do
+        RightSupport::Stats::Activity.avg_latency([], 0).should be_nil
+      end
+    end
+
     context :last do
       it "determines last activity from multiple last activity stats" do
         stats = [{"last" => {"elapsed" => 0, "type" => "foo"}, "total" => 1, "percent" => {"foo" => 100.0}},

data/spec/stats/helpers_spec.rb

@@ -338,7 +338,7 @@ describe RightSupport::Stats do
                        "                                 (1) Mon Jan 12 #{@hr}:46:40 Exception: Test error\n" +
                        "             heartbeat         : 60 sec\n" +
                        "             returns           : no queue consumers: 67%, no queue: 33%, total: 3, \n" +
-                       "                                 last: no queue consumers (10 sec ago), rate: 1.0/sec\n"
+                       "                                 last: no queue consumers (10 sec ago), rate: 1.0/sec, latency: 1.0 sec\n"
     end
 
     it "omits exceptions from brokers if exceptions key omitted" do
@@ -357,7 +357,7 @@ describe RightSupport::Stats do
                        "             b2: rs-broker-localhost-5674 failed, disconnects: none, failures: 3 (16 min 40 sec ago w/ 2 retries)\n" +
                        "             heartbeat         : 60 sec\n" +
                        "             returns           : no queue consumers: 67%, no queue: 33%, total: 3, \n" +
-                       "                                 last: no queue consumers (10 sec ago), rate: 1.0/sec\n"
+                       "                                 last: no queue consumers (10 sec ago), rate: 1.0/sec, latency: 1.0 sec\n"
     end
   end
 
@@ -371,7 +371,7 @@ describe RightSupport::Stats do
       activity.update("more testing")
       flexmock(Time).should_receive(:now).and_return(1000010)
       @helpers.activity_str(activity.all).should == "more testing: 75%, testing: 25%, total: 4, last: more testing (10 sec ago), " +
-                                                    "rate: 1.0/sec"
+                                                    "rate: 1.0/sec, latency: 1.0 sec"
     end
 
     it 'converts last activity stats to string' do

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: right_support
 version: !ruby/object:Gem::Version
-  version: 2.8.26
+  version: 2.8.27
+  prerelease: 
 platform: ruby
 authors:
 - Tony Spataro
@@ -13,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies: []
 description: A toolkit of useful, reusable foundation code created by RightScale.
 email: support@rightscale.com
@@ -23,7 +24,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files:
-- ".rspec"
+- .rspec
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
@@ -145,25 +146,29 @@ files:
 homepage: https://github.com/rightscale/right_support
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3750525095222830475
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.26
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Reusable foundation code.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 6010fe3e9ebbaa222eacaf224b0576a36e350f7c
-  data.tar.gz: a4a49a381d7a250a19230b0a3cd848436a51f221
-SHA512:
-  metadata.gz: a74303a4224cd7bc1ffa4bb3d65df38b4664baa9c55ba31f63327696ff598756c7898d6de68ac625caa8f0e453e5811c73adf8b725a9dc709ebdf200d5f09189
-  data.tar.gz: 9f1d6b77e03702c6e8f83e04633f5fe8708d79f4a790dfbae77a4c860b5da1772576405db4d30d00f8eb19cb15b21d9591b3a91b575806702bd212b68f88cd91