metriks-librato_metrics 1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2014 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,18 @@
+# Metriks reporter for Librato Metrics
+
+This is the [metriks](https://github.com/eric/metriks) reporter for Librato Metrics.
+
+## How to use it
+
+Sends metrics to Librato Metrics every 60 seconds.
+
+``` ruby
+  reporter = Metriks::LibratoMetricsReporter.new('email', 'token')
+  reporter.start
+```
+
+# License
+
+Copyright (c) 2012 Eric Lindvall
+
+Published under the MIT License, see LICENSE

data/Rakefile

@@ -0,0 +1,150 @@
+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 rubyforge_project
+  name
+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 'rdoc/task'
+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)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # 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}", "lib/#{name[/^(.*?)-/, 1]}"]
+  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/metriks/librato_metrics_reporter.rb

@@ -0,0 +1,161 @@
+require 'metriks/time_tracker'
+require 'net/https'
+
+module Metriks
+  class LibratoMetricsReporter
+    attr_accessor :prefix, :source, :data
+
+    def initialize(email, token, options = {})
+      @email = email
+      @token = token
+
+      @prefix = options[:prefix]
+      @source = options[:source]
+
+      @registry     = options[:registry] || Metriks::Registry.default
+      @interval     = options[:interval] || 60
+      @time_tracker = Metriks::TimeTracker.new(@interval)
+      @on_error     = options[:on_error] || proc { |ex| }
+
+      @data = {}
+      @sent = {}
+
+      @last = Hash.new { |h,k| h[k] = 0 }
+
+      if options[:percentiles]
+        @percentiles = options[:percentiles]
+      else
+        @percentiles = [ 0.95, 0.999 ]
+      end
+    end
+
+    def start
+      @thread ||= Thread.new do
+        while true
+          @time_tracker.sleep
+
+          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 restart
+      stop
+      start
+    end
+
+    def submit
+      return if @data.empty?
+
+      url = URI.parse('https://metrics-api.librato.com/v1/metrics')
+      req = Net::HTTP::Post.new(url.path)
+      req.basic_auth(@email, @token)
+      req.set_form_data(@data)
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.use_ssl = true
+      store = OpenSSL::X509::Store.new
+      store.set_default_paths
+      http.cert_store = store
+
+      case res = http.start { |http| http.request(req) }
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        # OK
+      else
+        res.error!
+      end
+
+      @data.clear
+    end
+
+    def write
+      time = @time_tracker.now_floored
+
+      @registry.each do |name, metric|
+        next if name.nil? || name.empty?
+        name = name.to_s.gsub(/ +/, '_')
+
+        if prefix
+          name = "#{prefix}.#{name}"
+        end
+
+        case metric
+        when Metriks::Meter
+          count = metric.count
+          datapoint(name, count - @last[name], time, :display_min => 0,
+            :summarize_function => 'sum')
+          @last[name] = count
+        when Metriks::Counter
+          datapoint(name, metric.count, time, :summarize_function => 'average')
+        when Metriks::Gauge
+          datapoint(name, metric.value, time, :summarize_function => 'average')
+        when Metriks::Histogram, Metriks::Timer, Metriks::UtilizationTimer
+          if Metriks::UtilizationTimer === metric || Metriks::Timer === metric
+            count = metric.count
+            datapoint(name, count - @last[name], time, :display_min => 0,
+              :summarize_function => 'sum')
+            @last[name] = count
+          end
+
+          if Metriks::UtilizationTimer === metric
+            datapoint("#{name}.one_minute_utilization",
+              metric.one_minute_utilization, time,
+              :display_min => 0, :summarize_function => 'average')
+          end
+
+          snapshot = metric.snapshot
+
+          datapoint("#{name}.median", snapshot.median, time, :display_min => 0,
+            :summarize_function => 'average')
+
+          @percentiles.each do |percentile|
+            percentile_name = (percentile * 100).to_f.to_s.gsub(/0+$/, '').gsub('.', '')
+            datapoint("#{name}.#{percentile_name}th_percentile",
+              snapshot.value(percentile), time, :display_min => 0,
+              :summarize_function => 'max')
+          end
+        end
+      end
+
+      if @data.length > 0
+        submit
+      end
+    end
+
+    def datapoint(name, value, time, attributes = {})
+      idx = @data.length
+
+      if prefix
+        name = "#{prefix}.#{name}"
+      end
+
+      @data["gauges[#{idx}][name]"]         = name
+      @data["gauges[#{idx}][source]"]       = @source
+      @data["gauges[#{idx}][measure_time]"] = time.to_i
+      @data["gauges[#{idx}][value]"]        = value
+
+      unless @sent[name]
+        @sent[name] = true
+
+        @data["gauges[#{idx}][period]"] = @interval
+        @data["gauges[#{idx}][attributes][aggregate]"] = true
+
+        attributes.each do |k, v|
+          @data["gauges[#{idx}][attributes][#{k}]"] = v
+        end
+      end
+    end
+  end
+end

data/lib/metriks-librato_metrics.rb

@@ -0,0 +1,5 @@
+require 'metriks/reporter/librato_metrics'
+
+module MetriksLibratoMetrics
+  VERSION = '1.0.0'
+end

data/metriks-librato_metrics.gemspec

@@ -0,0 +1,75 @@
+## 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-librato_metrics'
+  s.version           = '1.0.0'
+  s.date              = '2014-04-24'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Librato Metrics reporter for Metriks."
+  s.description = "Librato Metrics reporter for Metriks."
+
+  ## 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@papertrailapp.com'
+  s.homepage = 'https://github.com/eric/metriks-librato_metrics'
+  
+  ## 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.6')
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('mocha', ['~> 0.10'])
+
+  ## 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-librato_metrics.rb
+    lib/metriks/librato_metrics_reporter.rb
+    metriks-librato_metrics.gemspec
+    test/librato_metrics_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/librato_metrics_reporter_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+require 'metriks/librato_metrics_reporter'
+
+class LibratoMetricsReporterTest < Test::Unit::TestCase
+  def build_reporter(options={})
+    Metriks::LibratoMetricsReporter.new('user', 'password', { :registry => @registry }.merge(options))
+  end
+
+  def setup
+    @registry = Metriks::Registry.new
+    @reporter = build_reporter
+  end
+
+  def teardown
+    @reporter.stop
+    @registry.stop
+  end
+
+  def test_write
+    @registry.meter('meter.testing').mark
+    @registry.counter('counter.testing').increment
+    @registry.timer('timer.testing').update(1.5)
+    @registry.histogram('histogram.testing').update(1.5)
+    @registry.utilization_timer('utilization_timer.testing').update(1.5)
+    @registry.gauge('gauge.testing') { 123 }
+
+    @reporter.expects(:submit)
+
+    @reporter.write
+
+    @reporter.data.detect { |(k,v)| k =~ /gauges\[\d+\]\[name\]/ && v == 'gauge.testing' } &&
+      @reporter.data.detect { |(k,v)| k =~ /gauges\[\d+\]\[value\]/ && v.to_s == '123' }
+  end
+
+  def test_empty_write
+    @reporter.expects(:submit).never
+    @reporter.write
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'test/unit'
+require 'pp'
+
+require 'mocha/setup'
+
+require 'metriks'
+
+Thread.abort_on_exception = true
+
+module ThreadHelper
+  require 'thread'
+
+  # Run the given block on n threads in parallel. Returns an array of the
+  # return values of each thread's last invocation of block. Options:
+
+  # :n: call block n times per thread. Default 1.
+  def thread(threads = 2, opts = {})
+    n = opts[:n] || 1
+    results = []
+
+    threads.times.map do |i|
+      Thread.new do
+        n.times do
+          results[i] = yield i
+        end
+      end
+    end.each do |thread|
+      thread.join
+    end
+
+    results
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: metriks-librato_metrics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric Lindvall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: metriks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.9.6
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Librato Metrics reporter for Metriks.
+email: eric@papertrailapp.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/metriks-librato_metrics.rb
+- lib/metriks/librato_metrics_reporter.rb
+- metriks-librato_metrics.gemspec
+- test/librato_metrics_reporter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/eric/metriks-librato_metrics
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 2
+summary: Librato Metrics reporter for Metriks.
+test_files:
+- test/librato_metrics_reporter_test.rb