statsd-instrument 2.3.5 → 2.4.0

data/lib/statsd/instrument/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 # The environment module is used to detect, and initialize the environment in

data/lib/statsd/instrument/helpers.rb

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 module StatsD::Instrument::Helpers
   def capture_statsd_calls(&block)
     mock_backend = StatsD::Instrument::Backends::CaptureBackend.new
-    old_backend, StatsD.backend = StatsD.backend, mock_backend
+    old_backend = StatsD.backend
+    StatsD.backend = mock_backend
+
     block.call
     mock_backend.collected_metrics
   ensure
-    if old_backend.kind_of?(StatsD::Instrument::Backends::CaptureBackend)
+    if old_backend.is_a?(StatsD::Instrument::Backends::CaptureBackend)
       old_backend.collected_metrics.concat(mock_backend.collected_metrics)
     end
 

data/lib/statsd/instrument/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
 require 'rspec/core/version'
 
@@ -9,7 +11,7 @@ module StatsD::Instrument::Matchers
     histogram: :h,
     distribution: :d,
     set: :s,
-    key_value: :kv
+    key_value: :kv,
   }
 
   class Matcher
@@ -23,13 +25,10 @@ module StatsD::Instrument::Matchers
     end
 
     def matches?(block)
-      begin
-        expect_statsd_call(@metric_type, @metric_name, @options, &block)
-      rescue RSpec::Expectations::ExpectationNotMetError => e
-        @message = e.message
-
-        false
-      end
+      expect_statsd_call(@metric_type, @metric_name, @options, &block)
+    rescue RSpec::Expectations::ExpectationNotMetError => e
+      @message = e.message
+      false
     end
 
     def failure_message
@@ -50,8 +49,12 @@ module StatsD::Instrument::Matchers
       metrics = capture_statsd_calls(&block)
       metrics = metrics.select { |m| m.type == metric_type && m.name == metric_name }
 
-      raise RSpec::Expectations::ExpectationNotMetError, "No StatsD calls for metric #{metric_name} were made." if metrics.empty?
-      raise RSpec::Expectations::ExpectationNotMetError, "The numbers of StatsD calls for metric #{metric_name} was unexpected. Expected #{options[:times].inspect}, got #{metrics.length}" if options[:times] && options[:times] != metrics.length
+      if metrics.empty?
+        raise RSpec::Expectations::ExpectationNotMetError, "No StatsD calls for metric #{metric_name} were made."
+      elsif options[:times] && options[:times] != metrics.length
+        raise RSpec::Expectations::ExpectationNotMetError, "The numbers of StatsD calls for metric #{metric_name} " \
+         "was unexpected. Expected #{options[:times].inspect}, got #{metrics.length}"
+      end
 
       [:sample_rate, :value, :tags].each do |expectation|
         next unless options[expectation]
@@ -63,7 +66,7 @@ module StatsD::Instrument::Matchers
 
         found = options[:times] ? num_matches == options[:times] : num_matches > 0
 
-        if !found
+        unless found
           message = metric_information(metric_name, options, metrics, expectation)
           raise RSpec::Expectations::ExpectationNotMetError, message
         end

data/lib/statsd/instrument/metric.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # The Metric class represents a metric sample to be send by a backend.
 #
 # @!attribute type
 #   @return [Symbol] The metric type. Must be one of {StatsD::Instrument::Metric::TYPES}
 # @!attribute name
 #   @return [String] The name of the metric. {StatsD#prefix} will automatically be applied
-#     to the metric in the constructor, unless the <tt>:no_prefix</tt> option is set or is 
+#     to the metric in the constructor, unless the <tt>:no_prefix</tt> option is set or is
 #     overridden by the <tt>:prefix</tt> option. Note that <tt>:no_prefix</tt> has greater
 #     precedence than <tt>:prefix</tt>.
 # @!attribute value
@@ -29,7 +31,6 @@
 # @see StatsD::Instrument::Backend A StatsD::Instrument::Backend is used to collect metrics.
 #
 class StatsD::Instrument::Metric
-
   attr_accessor :type, :name, :value, :sample_rate, :tags, :metadata
 
   # Initializes a new metric instance.
@@ -47,9 +48,18 @@ class StatsD::Instrument::Metric
   # @option options [Array<String>, Hash<String, String>, nil] :tags The tags to apply to this metric.
   #   See {.normalize_tags} for more information.
   def initialize(options = {})
-    @type = options[:type] or raise ArgumentError, "Metric :type is required."
-    @name = options[:name] or raise ArgumentError, "Metric :name is required."
-    @name = normalize_name(@name)
+    if options[:type]
+      @type = options[:type]
+    else
+      raise ArgumentError, "Metric :type is required."
+    end
+
+    if options[:name]
+      @name = normalize_name(options[:name])
+    else
+      raise ArgumentError, "Metric :name is required."
+    end
+
     unless options[:no_prefix]
       @name = if options[:prefix]
         "#{options[:prefix]}.#{@name}"
@@ -58,10 +68,13 @@ class StatsD::Instrument::Metric
       end
     end
 
-    @value       = options[:value] || default_value
+    @value = options[:value] || default_value
     @sample_rate = options[:sample_rate] || StatsD.default_sample_rate
-    @tags        = StatsD::Instrument::Metric.normalize_tags(options[:tags])
-    @metadata    = options.reject { |k, _| [:type, :name, :value, :sample_rate, :tags].include?(k) }
+    @tags = StatsD::Instrument::Metric.normalize_tags(options[:tags])
+    if StatsD.default_tags
+      @tags = Array(@tags) + StatsD.default_tags
+    end
+    @metadata = options.reject { |k, _| [:type, :name, :value, :sample_rate, :tags].include?(k) }
   end
 
   # The default value for this metric, which will be used if it is not set.
@@ -73,36 +86,36 @@ class StatsD::Instrument::Metric
   # @raise ArgumentError if the metric type doesn't have a default value
   def default_value
     case type
-      when :c; 1
-      else raise ArgumentError, "A value is required for metric type #{type.inspect}."
+    when :c then 1
+    else raise ArgumentError, "A value is required for metric type #{type.inspect}."
     end
   end
 
   # @private
   # @return [String]
   def to_s
-    str = "#{TYPES[type]} #{name}:#{value}"
+    str = +"#{TYPES[type]} #{name}:#{value}"
     str << " @#{sample_rate}" if sample_rate != 1.0
-    tags.each { |tag| str << " ##{tag}" } if tags
+    tags&.each { |tag| str << " ##{tag}" }
     str
   end
 
   # @private
   # @return [String]
   def inspect
-    "#<StatsD::Instrument::Metric #{self.to_s}>"
+    "#<StatsD::Instrument::Metric #{self}>"
   end
 
   # The metric types that are supported by this library. Note that every StatsD server
   # implementation only supports a subset of them.
   TYPES = {
-    c:  'increment',
+    c: 'increment',
     ms: 'measure',
-    g:  'gauge',
-    h:  'histogram',
-    d:  'distribution',
+    g: 'gauge',
+    h: 'histogram',
+    d: 'distribution',
     kv: 'key/value',
-    s:  'set',
+    s: 'set',
   }
 
   # Strip metric names of special characters used by StatsD line protocol, replace with underscore
@@ -110,7 +123,7 @@ class StatsD::Instrument::Metric
   # @param name [String]
   # @return [String]
   def normalize_name(name)
-    name.tr(':|@'.freeze, '_')
+    name.tr(':|@', '_')
   end
 
   # Utility function to convert tags to the canonical form.
@@ -122,7 +135,7 @@ class StatsD::Instrument::Metric
   # @return [Array<String>, nil] the list of tags in canonical form.
   def self.normalize_tags(tags)
     return unless tags
-    tags = tags.map { |k, v| k.to_s + ":".freeze + v.to_s } if tags.is_a?(Hash)
-    tags.map { |tag| tag.tr('|,'.freeze, ''.freeze) }
+    tags = tags.map { |k, v| k.to_s + ":" + v.to_s } if tags.is_a?(Hash)
+    tags.map { |tag| tag.tr('|,', '') }
   end
 end

data/lib/statsd/instrument/metric_expectation.rb

@@ -1,15 +1,31 @@
+# frozen_string_literal: true
+
 # @private
 class StatsD::Instrument::MetricExpectation
-
   attr_accessor :times, :type, :name, :value, :sample_rate, :tags
   attr_reader :ignore_tags
 
   def initialize(options = {})
-    @type = options[:type] or raise ArgumentError, "Metric :type is required."
-    @name = options[:name] or raise ArgumentError, "Metric :name is required."
+    if options[:type]
+      @type = options[:type]
+    else
+      raise ArgumentError, "Metric :type is required."
+    end
+
+    if options[:name]
+      @name = options[:name]
+    else
+      raise ArgumentError, "Metric :name is required."
+    end
+
+    if options[:times]
+      @times = options[:times]
+    else
+      raise ArgumentError, "Metric :times is required."
+    end
+
     @name = StatsD.prefix ? "#{StatsD.prefix}.#{@name}" : @name unless options[:no_prefix]
     @tags = StatsD::Instrument::Metric.normalize_tags(options[:tags])
-    @times = options[:times] or raise ArgumentError, "Metric :times is required."
     @sample_rate = options[:sample_rate]
     @value = options[:value]
     @ignore_tags = StatsD::Instrument::Metric.normalize_tags(options[:ignore_tags])
@@ -29,7 +45,7 @@ class StatsD::Instrument::MetricExpectation
         actual_tags -= ignored_tags
 
         if ignore_tags.is_a?(Array)
-          actual_tags.delete_if{ |key| ignore_tags.include?(key.split(":").first) }
+          actual_tags.delete_if { |key| ignore_tags.include?(key.split(":").first) }
         end
       end
 
@@ -39,30 +55,28 @@ class StatsD::Instrument::MetricExpectation
   end
 
   def default_value
-    case type
-      when :c; 1
-    end
+    1 if type == :c
   end
 
   TYPES = {
-      c:  'increment',
-      ms: 'measure',
-      g:  'gauge',
-      h:  'histogram',
-      d:  'distribution',
-      kv: 'key/value',
-      s:  'set',
+    c: 'increment',
+    ms: 'measure',
+    g: 'gauge',
+    h: 'histogram',
+    d: 'distribution',
+    kv: 'key/value',
+    s: 'set',
   }
 
   def to_s
-    str = "#{TYPES[type]} #{name}:#{value}"
+    str = +"#{TYPES[type]} #{name}:#{value}"
     str << " @#{sample_rate}" if sample_rate != 1.0
-    str << " " << tags.map { |t| "##{t}"}.join(' ') if tags
+    str << " " << tags.map { |t| "##{t}" }.join(' ') if tags
     str << " times:#{times}" if times > 1
     str
   end
 
   def inspect
-    "#<StatsD::Instrument::MetricExpectation #{self.to_s}>"
+    "#<StatsD::Instrument::MetricExpectation #{self}>"
   end
 end

data/lib/statsd/instrument/railtie.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 # This Railtie runs some initializers that will set the logger to <tt>Rails#logger</tt>,
 # and will initialize the {StatsD#backend} based on the Rails environment.
 #
 # @see StatsD::Instrument::Environment
 class StatsD::Instrument::Railtie < Rails::Railtie
-
   initializer 'statsd-instrument.use_rails_logger' do
     ::StatsD.logger = Rails.logger
   end

data/lib/statsd/instrument/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module StatsD
   module Instrument
-    VERSION = "2.3.5"
+    VERSION = "2.4.0"
   end
 end

data/statsd-instrument.gemspec

@@ -1,21 +1,23 @@
+# frozen-string-literal: true
 # encoding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'statsd/instrument/version'
 
 Gem::Specification.new do |spec|
-  spec.name        = "statsd-instrument"
-  spec.version     = StatsD::Instrument::VERSION
-  spec.authors     = ["Jesse Storimer", "Tobias Lutke", "Willem van Bergen"]
-  spec.email       = ["jesse@shopify.com"]
-  spec.homepage    = "https://github.com/Shopify/statsd-instrument"
-  spec.summary     = %q{A StatsD client for Ruby apps}
+  spec.name = "statsd-instrument"
+  spec.version = StatsD::Instrument::VERSION
+  spec.authors = ["Jesse Storimer", "Tobias Lutke", "Willem van Bergen"]
+  spec.email = ["jesse@shopify.com"]
+  spec.homepage = "https://github.com/Shopify/statsd-instrument"
+  spec.summary = %q{A StatsD client for Ruby apps}
   spec.description = %q{A StatsD client for Ruby apps. Provides metaprogramming methods to inject StatsD instrumentation into your code.}
-  spec.license     = "MIT"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'rake'
@@ -23,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'benchmark-ips'
 end

data/test/assertions_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class AssertionsTest < Minitest::Test
@@ -163,6 +165,15 @@ class AssertionsTest < Minitest::Test
     end
   end
 
+  def test_tags_friendly_error
+    @test_case.assert_statsd_increment('counter', tags: { class: "AnotherJob" }) do
+      StatsD.increment('counter', tags: { class: "MyJob" })
+    end
+  rescue MiniTest::Assertion => assertion
+    assert_match(/Captured metrics with the same key/, assertion.message)
+    assert_match(/MyJob/, assertion.message)
+  end
+
   def test_multiple_metrics_are_not_order_dependent
     assert_no_assertion_triggered do
       foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:1'])
@@ -262,7 +273,7 @@ class AssertionsTest < Minitest::Test
   def test_assert_statsd_call_with_wrong_sample_rate_type
     assert_assertion_triggered "Unexpected sample rate type for metric counter, must be numeric" do
       @test_case.assert_statsd_increment('counter', tags: ['a', 'b']) do
-        StatsD.increment('counter', sample_rate: 'abc', tags:  ['a', 'b'])
+        StatsD.increment('counter', sample_rate: 'abc', tags: ['a', 'b'])
       end
     end
   end
@@ -309,7 +320,7 @@ class AssertionsTest < Minitest::Test
   def assert_no_assertion_triggered(&block)
     block.call
   rescue MiniTest::Assertion => assertion
-    flunk "No assertion trigger expected, but one was triggered with message #{assertion.message}."
+    flunk("No assertion trigger expected, but one was triggered with message #{assertion.message}.")
   else
     pass
   end
@@ -318,12 +329,12 @@ class AssertionsTest < Minitest::Test
     block.call
   rescue MiniTest::Assertion => assertion
     if message
-      assert_equal message, assertion.message, "Assertion triggered, but message was not what was expected."
+      assert_equal(message, assertion.message, "Assertion triggered, but message was not what was expected.")
     else
       pass
     end
     assertion
   else
-    flunk "No assertion was triggered, but one was expected."
+    flunk("No assertion was triggered, but one was expected.")
   end
 end

data/test/benchmark/default_tags.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'statsd-instrument'
+require 'benchmark/ips'
+
+StatsD.logger = Logger.new('/dev/null')
+
+class Suite
+  def warming(*args)
+    StatsD.default_tags = if args[0] == "with default tags"
+      { first_tag: 'first_value', second_tag: 'second_value' }
+    end
+    puts "warming with default tags: #{StatsD.default_tags}"
+  end
+
+  def running(*args)
+    StatsD.default_tags = if args[0] == "with default tags"
+      { first_tag: 'first_value', second_tag: 'second_value' }
+    end
+    puts "running with default tags: #{StatsD.default_tags}"
+  end
+
+  def warmup_stats(*)
+  end
+
+  def add_report(*)
+  end
+end
+
+suite = Suite.new
+
+Benchmark.ips do |bench|
+  bench.config(suite: suite)
+  bench.report("without default tags") do
+    StatsD.increment('GoogleBase.insert', tags: {
+      first_tag: 'first_value',
+      second_tag: 'second_value',
+      third_tag: 'third_value',
+    })
+  end
+
+  bench.report("with default tags") do
+    StatsD.increment('GoogleBase.insert', tags: { third_tag: 'third_value' })
+  end
+
+  bench.compare!
+end