metriks-librato_metrics 1.0.3 → 1.0.4

data/lib/metriks-librato_metrics.rb

@@ -1,5 +1,5 @@
 require 'metriks/librato_metrics_reporter'
 
 module MetriksLibratoMetrics
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/lib/metriks/librato_metrics_reporter.rb

@@ -16,6 +16,8 @@ module Metriks
       @interval     = options[:interval] || 60
       @time_tracker = Metriks::TimeTracker.new(@interval)
       @on_error     = options[:on_error] || proc { |ex| }
+      @sanitizer    = options[:sanitize] || proc { |key| key.to_s.gsub(/ +/, '_') }
+      @timeout      = options[:timeout]  || 10
 
       @data = {}
       @sent = {}
@@ -92,7 +94,7 @@ module Metriks
       when Net::HTTPSuccess, Net::HTTPRedirection
         # OK
       else
-        res.error!
+        raise RequestFailedError.new(req, res, @data.dup)
       end
     ensure
       @data.clear
@@ -103,7 +105,7 @@ module Metriks
 
       @registry.each do |name, metric|
         next if name.nil? || name.empty?
-        name = name.to_s.gsub(/ +/, '_')
+        name = sanitize_name(name)
 
         case metric
         when Metriks::Meter
@@ -171,5 +173,40 @@ module Metriks
         end
       end
     end
+
+    def sanitize_name(name)
+      case @sanitizer
+      when String
+        return name.gsub(/[^.:_\-0-9a-zA-Z]/, @sanitizer)[0...255]
+      when Proc
+        sanitized = @sanitizer.call(name)
+      else
+        raise RuntimeError, "The :sanitize option must be a replacement " \
+          "string or a Proc that will be passed the metric name to sanitize."
+      end
+
+      if sanitized.size > 255 || sanitized =~ /[^.:_\-0-9a-zA-Z]/
+        raise InvalidKeyError, "Librato metric names must match " \
+          "/[.:_\-0-9a-zA-Z]+/, and must be less than 255 characters."
+      else
+        sanitized
+      end
+    end
+
+    class InvalidKeyError < StandardError; end
+
+    class RequestFailedError < StandardError
+      attr_reader :req, :res, :data
+
+      def initialize(req, res, data = nil)
+        @req, @res = req, res
+        @data = data
+      end
+
+      def to_s
+        res.code + ' ' + res.message.dump
+      end
+    end
+
   end
 end

data/metriks-librato_metrics.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## 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.3'
-  s.date              = '2015-03-13'
+  s.version           = '1.0.4'
+  s.date              = '2015-09-25'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.

data/test/librato_metrics_reporter_test.rb

@@ -37,4 +37,39 @@ class LibratoMetricsReporterTest < Test::Unit::TestCase
     @reporter.expects(:submit).never
     @reporter.write
   end
+
+  def test_raises_on_invalid_keys
+    err = Metriks::LibratoMetricsReporter::InvalidKeyError
+    %w[invalid.utf8—key invalid.ascii?key invalid.punctuation/key].each do |key|
+      assert_raise(err, "error on invalid key #{key}") do
+        @registry.counter(key)
+        @reporter.write
+      end
+    end
+  end
+
+  def test_sanitizes_by_string
+    @reporter = build_reporter(:sanitize => ".")
+    @registry.counter("invalid.ascii?key")
+    @reporter.expects(:submit)
+    @reporter.write
+    assert_equal(@reporter.data["gauges[0][name]"], "invalid.ascii.key")
+  end
+
+  def test_sanitizes_by_proc
+    @reporter = build_reporter(:sanitize => Proc.new { |key| "bats" })
+    @registry.counter("invalid.ascii?key")
+    @reporter.expects(:submit)
+    @reporter.write
+    assert_equal(@reporter.data["gauges[0][name]"], "bats")
+  end
+
+  def test_raises_on_invalid_sanitized_key
+    @reporter = build_reporter(:sanitize => Proc.new { |key| "bats" * 100 })
+    assert_raise Metriks::LibratoMetricsReporter::InvalidKeyError do
+      @registry.counter("invalid.ascii?key")
+      @reporter.write
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metriks-librato_metrics
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks