metriksd_reporter 0.5.0

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'rake', '0.8.7'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Eric Lindvall
+
+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,28 @@
+# Metriks Server Reporter
+
+A reporter to send metrics from [metriks][] to [metriksd][].
+
+
+## Usage
+
+Add the gem to your `Gemfile`:
+
+``` ruby
+gem 'metriksd_reporter'
+```
+
+Use the reporter:
+
+``` ruby
+  reporter = MetriksdReporter.new(:host => 'metriksd.local', :port => 3331)
+```
+
+
+# License
+
+Copyright (c) 2012 Eric Lindvall
+
+Published under the MIT License, see LICENSE
+
+[metriks]: https://github.com/eric/metriks
+[metriksd]: https://github.com/eric/metriksd

data/Rakefile

@@ -0,0 +1,144 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/metriksd_reporter.rb

@@ -0,0 +1,9 @@
+module MetriksdReporter
+  VERSION = '0.5.0'
+
+  def self.new(*args)
+    Reporter.new(*args)
+  end
+end
+
+require 'metriksd_reporter/reporter'

data/lib/metriksd_reporter/reporter.rb

@@ -0,0 +1,197 @@
+require 'snappy'
+require 'msgpack'
+
+module MetriksdReporter
+  class Reporter
+    def initialize(options = {})
+      missing_keys = %w(port host) - options.keys.map(&:to_s)
+      unless missing_keys.empty?
+        raise ArgumentError, "Missing required options: #{missing_keys * ', '}"
+      end
+
+      @port = options[:port]
+      @host = options[:host]
+
+      @client_id       = options[:client_id] || "#{Socket.gethostname}:#{$$}"
+      @extras          = options[:extras] || {}
+      @registry        = options[:registry] || Metriks::Registry.default
+
+      @max_packet_size = options[:max_packet_size] || 1000
+      @interval        = options[:interval] || 60
+      @interval_offset = options[:interval_offset] || 0
+      @flush_delay     = options[:flush_delay] || 0.6
+
+      @on_error        = options[:on_error] || proc { |ex| }
+    end
+
+    def start
+      @socket ||= UDPSocket.new
+
+      @thread ||= Thread.new do
+        loop do
+          sleep_until_deadline
+
+          begin
+            write
+          rescue Exception => ex
+            @on_error[ex] rescue nil
+          end
+        end
+      end
+    end
+
+    def stop
+      if @thread
+        @thread.exit
+        @thread = nil
+      end
+
+      flush
+
+      if @socket
+        @socket.close
+        @socket = nil
+      end
+    end
+
+    def join
+      if @thread
+        @thread.join
+      end
+    end
+
+    def restart
+      stop
+      start
+    end
+
+    def flush
+      write
+    end
+
+    def write
+      @registry.each do |name, metric|
+        case metric
+        when Metriks::Meter
+          write_metric name, 'meter', metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate
+          ]
+        when Metriks::Counter
+          write_metric name, 'counter', metric, [
+            :count
+          ]
+        when Metriks::UtilizationTimer
+          write_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,
+          ], [
+            :median, :get_95th_percentile
+          ]
+        when Metriks::Timer
+          write_metric name, 'timer', metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
+        when Metriks::Histogram
+          write_metric name, 'histogram', metric, [
+            :count, :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
+        end
+      end
+
+      flush_packet
+    end
+
+    def append_to_packet(data)
+      @packet ||= ''
+      @packet << data.to_msgpack
+      flush_packet_if_full
+    end
+
+    def flush_packet_if_full
+      if @packet && @packet.length > 0 && @packet.length > max_packet_size_with_compression_ratio
+        flush_packet
+        sleep_for_up_to(0.6)
+      end
+    end
+
+    def flush_packet
+      if @packet && @packet.length > 0
+        compressed = Snappy.deflate(@packet)
+
+        # Calculate the compression ratio
+        @compression_ratio = @packet.length / compressed.length
+
+        # Send the packet
+        @socket.send(compressed, 0, @host, @port)
+        @packet = ''
+      end
+    end
+
+    def max_packet_size_with_compression_ratio
+      if @compression_ratio
+        @max_packet_size * @compression_ratio * 0.9
+      else
+        @max_packet_size
+      end
+    end
+
+    def extract_from_metric(metric, *keys)
+      h = {}
+
+      keys.flatten.collect do |key|
+        name = key.to_s.gsub(/^get_/, '')
+        h[name] = metric.send(key)
+      end
+      
+      h
+    end
+
+    def write_metric(name, type, metric, keys, snapshot_keys = [])
+      message = @extras.merge(
+        :client_id => @client_id,
+        :time => Time.now.to_i,
+        :name => name,
+        :type => type
+      )
+
+      message.merge!(extract_from_metric(metric, keys))
+
+      unless snapshot_keys.empty?
+        snapshot = metric.snapshot
+        message.merge!(extract_from_metric(snapshot, snapshot_keys))
+      end
+
+      append_to_packet(message)
+    end
+
+    def sleep_until_deadline
+      # Ensure we round up when we should
+      now = Time.now.to_f + @interval_offset
+
+      rounded      = now - (now % @interval)
+      next_rounded = rounded + @interval - @interval_offset
+      sleep_time   = next_rounded - Time.now.to_f
+
+      if sleep_time > 0
+        sleep(sleep_time)
+      end
+    end
+
+    def sleep_for_up_to(duration)
+      duration *= rand
+      if duration > 0
+        sleep(duration)
+      end
+    end
+  end
+end

data/metriksd_reporter.gemspec

@@ -0,0 +1,77 @@
+## 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              = 'metriksd_reporter'
+  s.version           = '0.5.0'
+  s.date              = '2012-07-29'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Metriks reporter for Metriks Server"
+  s.description = "Reporter component for the metriks metrics library to report to a metriks server"
+
+  ## 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_server_reporter'
+
+  ## 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]
+
+  ## This sections is only necessary if you have C extensions.
+  # s.require_paths << 'ext'
+  # s.extensions = %w[ext/extconf.rb]
+
+  ## 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('metriks', '>= 0.9.9')
+  s.add_dependency('snappy')
+  s.add_dependency('msgpack')
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## 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/metriksd_reporter.rb
+    lib/metriksd_reporter/reporter.rb
+    metriksd_reporter.gemspec
+    test/metriksd_reporter_test.rb
+    test/test_helper.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

data/test/metriksd_reporter_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'metriks'
+
+class MetriksdReporterTest < Test::Unit::TestCase
+  def setup
+    @registry = Metriks::Registry.new
+    @reporter = MetriksdReporter.new(:host => '127.0.0.1', :port => 8372, :registry => @registry)
+  end
+
+  def test_basic
+    @reporter.start
+    @registry.timer('testing').update(4)
+    @reporter.stop
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'pp'
+
+# require 'mocha'
+
+require 'metriksd_reporter'
+
+Thread.abort_on_exception = true

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: metriksd_reporter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Eric Lindvall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  name: metriks
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: snappy
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: msgpack
+  requirement: *id003
+  prerelease: false
+description: Reporter component for the metriks metrics library to report to a metriks server
+email: eric@sevenscale.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/metriksd_reporter.rb
+- lib/metriksd_reporter/reporter.rb
+- metriksd_reporter.gemspec
+- test/metriksd_reporter_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/eric/metriks_server_reporter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Metriks reporter for Metriks Server
+test_files: 
+- test/test_helper.rb