metriks 0.8.1

data/lib/metriks/reporter/logger.rb

@@ -0,0 +1,94 @@
+require 'logger'
+
+module Metriks::Reporter
+  class Logger
+    def initialize(options = {})
+      @registry  = options[:registry]  || Metriks::Registry.default
+      @logger    = options[:logger]    || ::Logger.new(STDOUT)
+      @log_level = options[:log_level] || ::Logger::INFO
+      @prefix    = options[:prefix]    || 'metriks:'
+      @interval  = options[:interval]  || 60
+      @on_errror = options[:on_error]  || proc { |ex| }
+    end
+
+    def start
+      @thread ||= Thread.new do
+        loop do
+          sleep @interval
+
+          Thread.new do
+            begin
+              write
+            rescue Exception => ex
+              @on_error[ex] rescue nil
+            end
+          end
+        end
+      end
+    end
+
+    def stop
+      @thread.kill if @thread
+      @thread = nil
+    end
+
+    def write
+      @registry.each do |name, metric|
+        case metric
+        when Metriks::Meter
+          log_metric name, 'meter', metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate
+          ]
+        when Metriks::Counter
+          log_metric name, 'counter', metric, [
+            :count
+          ]
+        when Metriks::UtilizationTimer
+          log_metric name, 'utilization_timer', metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev,
+            :one_minute_utilization, :five_minute_utilization,
+            :fifteen_minute_utilization, :mean_utilization,
+          ]
+        when Metriks::Timer
+          log_metric name, 'timer', metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev
+          ]
+        end
+      end
+    end
+
+    def extract_from_metric(metric, *keys)
+      keys.flatten.collect do |key|
+        [ { key => metric.send(key) } ]
+      end
+    end
+
+    def log_metric(name, type, metric, *keys)
+      message = []
+
+      message << @prefix if @prefix
+      message << { :time => Time.now.to_i }
+
+      message << { :name => name }
+      message << { :type => type }
+      message += extract_from_metric(metric, keys)
+
+      @logger.add(@log_level, format_message(message))
+    end
+
+    def format_message(args)
+      args.map do |arg|
+        case arg
+        when Hash then arg.map { |name, value| "#{name}=#{format_message([value])}" }
+        when Array then format_message(arg)
+        else arg
+        end
+      end.join(' ')
+    end
+  end
+end

data/lib/metriks/reporter/proc_title.rb

@@ -0,0 +1,59 @@
+module Metriks::Reporter
+  class ProcTitle
+    def initialize(options = {})
+      @interval  = options[:interval] || 5
+      @rounding  = options[:rounding] || 1
+      @on_errror = options[:on_error] || proc { |ex| }
+
+      @prefix   = $0.dup
+      @metrics  = []
+    end
+
+    def add(name, suffix = nil, &block)
+      @metrics << [ name, suffix, block ]
+    end
+
+    def empty?
+      @metrics.empty?
+    end
+
+    def start
+      @thread ||= Thread.new do
+        loop do
+          begin
+            unless @metrics.empty?
+              title = generate_title
+              if title && !title.empty?
+                $0 = "#{@prefix} #{title}"
+              end
+            end
+          rescue Exception => ex
+            @on_errror[ex] rescue nil
+          end
+          sleep @interval
+        end
+      end
+    end
+
+    def stop
+      @thread.kill if @thread
+      @thread = nil
+    end
+
+    protected
+    def generate_title
+      @metrics.collect do |name, suffix, block|
+        val = block.call
+        val = "%.#{@rounding}f" % val if val.is_a?(Float)
+
+        if suffix == '%'
+          "#{name}: #{val}#{suffix}"
+        elsif suffix
+          "#{name}: #{val}/#{suffix}"
+        else
+          "#{name}: #{val}"
+        end
+      end.join(' ')
+    end
+  end
+end

data/lib/metriks/simple_moving_average.rb

@@ -0,0 +1,60 @@
+require 'atomic'
+
+module Metriks
+  class SimpleMovingAverage
+    INTERVAL = 5.0
+    SECONDS_PER_MINUTE = 60.0
+
+    ONE_MINUTE      = 1
+    FIVE_MINUTES    = 5
+    FIFTEEN_MINUTES = 15
+
+    def self.new_m1
+      new(ONE_MINUTE * SECONDS_PER_MINUTE, INTERVAL)
+    end
+
+    def self.new_m5
+      new(FIVE_MINUTES * SECONDS_PER_MINUTE, INTERVAL)
+    end
+
+    def self.new_m15
+      new(FIFTEEN_MINUTES * SECONDS_PER_MINUTE, INTERVAL)
+    end
+
+    def initialize(duration, interval)
+      @interval = interval
+      @duration = duration
+
+      @values = Array.new((duration / interval).to_i) { Atomic.new(nil) }
+      @index  = Atomic.new(0)
+    end
+
+    def clear
+      @values.each do |value|
+        value.value = nil
+      end
+      @index.value = 0
+    end
+
+    def update(value)
+      @values[@index.value].update { |v| v ? v + value : value }
+    end
+
+    def tick
+      @index.update { |v| v < @values.length - 1 ? v + 1 : 0 }
+    end
+
+    def rate
+      num, count = 0.0, 0.0
+
+      @values.each do |value|
+        if v = value.value
+          num   += v
+          count += 1
+        end
+      end
+
+      num / count / @interval.to_f
+    end
+  end
+end

data/lib/metriks/timer.rb

@@ -0,0 +1,93 @@
+require 'atomic'
+require 'hitimes'
+
+require 'metriks/meter'
+require 'metriks/histogram'
+
+module Metriks
+  class Timer
+    class Context
+      def initialize(timer)
+        @timer    = timer
+        @interval = Hitimes::Interval.now
+      end
+
+      def stop
+        @interval.stop
+        @timer.update(@interval.duration)
+      end
+    end
+
+    def initialize
+      @meter     = Metriks::Meter.new
+      @histogram = Metriks::Histogram.new_uniform
+    end
+
+    def clear
+      @meter.clear
+      @histogram.clear
+    end
+
+    def update(duration)
+      if duration >= 0
+        @meter.mark
+        @histogram.update(duration)
+      end
+    end
+
+    def time(callable = nil, &block)
+      callable ||= block
+      context = Context.new(self)
+
+      if callable.nil?
+        return context
+      end
+
+      begin
+        return callable.call
+      ensure
+        context.stop
+      end
+    end
+
+    def count
+      @histogram.count
+    end
+
+    def one_minute_rate
+      @meter.one_minute_rate
+    end
+
+    def five_minute_rate
+      @meter.five_minute_rate
+    end
+
+    def fifteen_minute_rate
+      @meter.fifteen_minute_rate
+    end
+
+    def mean_rate
+      @meter.mean_rate
+    end
+
+    def min
+      @histogram.min
+    end
+
+    def max
+      @histogram.max
+    end
+
+    def mean
+      @histogram.mean
+    end
+
+    def stddev
+      @histogram.stddev
+    end
+
+    def stop
+      @meter.stop
+    end
+  end
+end

data/lib/metriks/uniform_sample.rb

@@ -0,0 +1,35 @@
+require 'atomic'
+
+module Metriks
+  class UniformSample
+    def initialize(reservoir_size)
+      @values = Array.new(reservoir_size, 0)
+      @count  = Atomic.new(0)
+    end
+
+    def clear
+      @values.length.times do |idx|
+        @values[idx] = 0
+      end
+      @count.value = 0
+    end
+
+    def size
+      count = @count.value
+      count > @values.length ? @values.length : count
+    end
+
+    def update(value)
+      new_count = @count.update { |v| v + 1 }
+
+      if new_count <= @values.length
+        @values[new_count - 1] = value
+      else
+        idx = rand(new_count)
+        if idx < @values.length
+          @values[idx] = value
+        end
+      end
+    end
+  end
+end

data/lib/metriks/utilization_timer.rb

@@ -0,0 +1,43 @@
+require 'metriks/timer'
+
+module Metriks
+  class UtilizationTimer < Metriks::Timer
+    def initialize
+      super
+      @duration_meter = Metriks::Meter.new
+    end
+
+    def clear
+      super
+      @duration_meter.clear
+    end
+
+    def update(duration)
+      super
+      if duration >= 0
+        @duration_meter.mark(duration)
+      end
+    end
+
+    def one_minute_utilization
+      @duration_meter.one_minute_rate
+    end
+
+    def five_minute_utilization
+      @duration_meter.five_minute_rate
+    end
+
+    def fifteen_minute_utilization
+      @duration_meter.fifteen_minute_rate
+    end
+
+    def mean_utilization
+      @duration_meter.mean_rate
+    end
+
+    def stop
+      super
+      @duration_meter.stop
+    end
+  end
+end

data/metriks.gemspec

@@ -0,0 +1,90 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'metriks'
+  s.version           = '0.8.1'
+  s.date              = '2012-02-27'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "An experimental metrics client"
+  s.description = "An experimental metrics client."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Eric Lindvall"]
+  s.email    = 'eric@sevenscale.com'
+  s.homepage = 'https://github.com/eric/metriks_client'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## If your gem includes any executables, list them here.
+  # s.executables = ["name"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('atomic', ["~> 1.0"])
+  s.add_dependency('hitimes', [ "~> 1.1"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('tomdoc', ["~> 0.2"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    lib/metriks.rb
+    lib/metriks/counter.rb
+    lib/metriks/ewma.rb
+    lib/metriks/histogram.rb
+    lib/metriks/meter.rb
+    lib/metriks/registry.rb
+    lib/metriks/reporter/logger.rb
+    lib/metriks/reporter/proc_title.rb
+    lib/metriks/simple_moving_average.rb
+    lib/metriks/timer.rb
+    lib/metriks/uniform_sample.rb
+    lib/metriks/utilization_timer.rb
+    metriks.gemspec
+    test/counter_test.rb
+    test/histogram_test.rb
+    test/logger_reporter_test.rb
+    test/meter_test.rb
+    test/metriks_test.rb
+    test/proc_title_reporter_test.rb
+    test/registry_test.rb
+    test/test_helper.rb
+    test/timer_test.rb
+    test/utilization_timer_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test\.rb/ }
+end