statsd-instrument 3.0.1 → 3.1.2

data/lib/statsd/instrument/client.rb

@@ -53,9 +53,9 @@ module StatsD
         #   supported.
         def datagram_builder_class_for_implementation(implementation)
           case implementation.to_s
-          when 'statsd'
+          when "statsd"
             StatsD::Instrument::StatsDDatagramBuilder
-          when 'datadog', 'dogstatsd'
+          when "datadog", "dogstatsd"
             StatsD::Instrument::DogStatsDDatagramBuilder
           else
             raise NotImplementedError, "Implementation named #{implementation} could not be found"
@@ -148,7 +148,7 @@ module StatsD
         prefix: nil,
         default_sample_rate: 1.0,
         default_tags: nil,
-        implementation: 'datadog',
+        implementation: "datadog",
         sink: StatsD::Instrument::NullSink.new,
         datagram_builder_class: self.class.datagram_builder_class_for_implementation(implementation)
       )

data/lib/statsd/instrument/datagram.rb

@@ -40,7 +40,7 @@ module StatsD
       end
 
       def tags
-        @tags ||= parsed_datagram[:tags] ? parsed_datagram[:tags].split(',') : nil
+        @tags ||= parsed_datagram[:tags] ? parsed_datagram[:tags].split(",") : nil
       end
 
       def inspect

data/lib/statsd/instrument/datagram_builder.rb

@@ -5,18 +5,6 @@ module StatsD
     # @note This class is part of the new Client implementation that is intended
     #   to become the new default in the next major release of this library.
     class DatagramBuilder
-      unless Regexp.method_defined?(:match?) # for ruby 2.3
-        module RubyBackports
-          refine Regexp do
-            def match?(str)
-              match(str) != nil
-            end
-          end
-        end
-
-        using(RubyBackports)
-      end
-
       def self.unsupported_datagram_types(*types)
         types.each do |type|
           define_method(type) do |_, _, _, _|
@@ -35,31 +23,31 @@ module StatsD
       end
 
       def c(name, value, sample_rate, tags)
-        generate_generic_datagram(name, value, 'c', sample_rate, tags)
+        generate_generic_datagram(name, value, "c", sample_rate, tags)
       end
 
       def g(name, value, sample_rate, tags)
-        generate_generic_datagram(name, value, 'g', sample_rate, tags)
+        generate_generic_datagram(name, value, "g", sample_rate, tags)
       end
 
       def ms(name, value, sample_rate, tags)
-        generate_generic_datagram(name, value, 'ms', sample_rate, tags)
+        generate_generic_datagram(name, value, "ms", sample_rate, tags)
       end
 
       def s(name, value, sample_rate, tags)
-        generate_generic_datagram(name, value, 's', sample_rate, tags)
+        generate_generic_datagram(name, value, "s", sample_rate, tags)
       end
 
       def h(name, value, sample_rate, tags)
-        generate_generic_datagram(name, value, 'h', sample_rate, tags)
+        generate_generic_datagram(name, value, "h", sample_rate, tags)
       end
 
       def d(name, value, sample_rate, tags)
-        generate_generic_datagram(name, value, 'd', sample_rate, tags)
+        generate_generic_datagram(name, value, "d", sample_rate, tags)
       end
 
       def kv(name, value, sample_rate, tags)
-        generate_generic_datagram(name, value, 'kv', sample_rate, tags)
+        generate_generic_datagram(name, value, "kv", sample_rate, tags)
       end
 
       def latency_metric_type
@@ -83,21 +71,21 @@ module StatsD
 
         # Fast path when no string replacement is needed
         return tags unless tags.any? { |tag| /[|,]/.match?(tag) }
-        tags.map { |tag| tag.tr('|,', '') }
+        tags.map { |tag| tag.tr("|,", "") }
       end
 
       # Utility function to remove invalid characters from a StatsD metric name
       def normalize_name(name)
         # Fast path when no normalization is needed to avoid copying the string
         return name unless /[:|@]/.match?(name)
-        name.tr(':|@', '_')
+        name.tr(":|@", "_")
       end
 
       def generate_generic_datagram(name, value, type, sample_rate, tags)
         tags = normalize_tags(tags) + default_tags
         datagram = +"#{@prefix}#{normalize_name(name)}:#{value}|#{type}"
         datagram << "|@#{sample_rate}" if sample_rate && sample_rate < 1
-        datagram << "|##{tags.join(',')}" unless tags.empty?
+        datagram << "|##{tags.join(",")}" unless tags.empty?
         datagram
       end
     end

data/lib/statsd/instrument/dogstatsd_datagram_builder.rb

@@ -44,7 +44,7 @@ module StatsD
         datagram << "|p:#{priority}" if priority
         datagram << "|s:#{source_type_name}" if source_type_name
         datagram << "|t:#{alert_type}" if alert_type
-        datagram << "|##{tags.join(',')}" unless tags.empty?
+        datagram << "|##{tags.join(",")}" unless tags.empty?
         datagram
       end
 
@@ -67,7 +67,7 @@ module StatsD
         datagram = +"_sc|#{@prefix}#{normalize_name(name)}|#{status_number}"
         datagram << "|h:#{hostname}" if hostname
         datagram << "|d:#{timestamp.to_i}" if timestamp
-        datagram << "|##{tags.join(',')}" unless tags.empty?
+        datagram << "|##{tags.join(",")}" unless tags.empty?
         datagram << "|m:#{normalize_name(message)}" if message
         datagram
       end

data/lib/statsd/instrument/environment.rb

@@ -49,33 +49,37 @@ module StatsD
       #
       # @return [String] The detected environment.
       def environment
-        if env['STATSD_ENV']
-          env['STATSD_ENV']
+        if env["STATSD_ENV"]
+          env["STATSD_ENV"]
         elsif defined?(Rails) && Rails.respond_to?(:env)
           Rails.env.to_s
         else
-          env['RAILS_ENV'] || env['RACK_ENV'] || env['ENV'] || 'development'
+          env["RAILS_ENV"] || env["RACK_ENV"] || env["ENV"] || "development"
         end
       end
 
       def statsd_implementation
-        env.fetch('STATSD_IMPLEMENTATION', 'datadog')
+        env.fetch("STATSD_IMPLEMENTATION", "datadog")
       end
 
       def statsd_sample_rate
-        env.fetch('STATSD_SAMPLE_RATE', 1.0).to_f
+        env.fetch("STATSD_SAMPLE_RATE", 1.0).to_f
       end
 
       def statsd_prefix
-        env.fetch('STATSD_PREFIX', nil)
+        env.fetch("STATSD_PREFIX", nil)
       end
 
       def statsd_addr
-        env.fetch('STATSD_ADDR', 'localhost:8125')
+        env.fetch("STATSD_ADDR", "localhost:8125")
       end
 
       def statsd_default_tags
-        env.key?('STATSD_DEFAULT_TAGS') ? env.fetch('STATSD_DEFAULT_TAGS').split(',') : nil
+        env.key?("STATSD_DEFAULT_TAGS") ? env.fetch("STATSD_DEFAULT_TAGS").split(",") : nil
+      end
+
+      def statsd_flush_interval
+        Float(env.fetch("STATSD_FLUSH_INTERVAL", 1.0))
       end
 
       def client
@@ -84,9 +88,13 @@ module StatsD
 
       def default_sink_for_environment
         case environment
-        when 'production', 'staging'
-          StatsD::Instrument::UDPSink.for_addr(statsd_addr)
-        when 'test'
+        when "production", "staging"
+          if statsd_flush_interval > 0.0
+            StatsD::Instrument::BatchedUDPSink.for_addr(statsd_addr, flush_interval: statsd_flush_interval)
+          else
+            StatsD::Instrument::UDPSink.for_addr(statsd_addr)
+          end
+        when "test"
           StatsD::Instrument::NullSink.new
         else
           StatsD::Instrument::LogSink.new(StatsD.logger)

data/lib/statsd/instrument/expectation.rb

@@ -32,11 +32,12 @@ module StatsD
 
       attr_accessor :times, :type, :name, :value, :sample_rate, :tags
 
-      def initialize(client: StatsD.singleton_client, type:, name:, value: nil,
+      def initialize(client: nil, type:, name:, value: nil,
         sample_rate: nil, tags: nil, no_prefix: false, times: 1)
 
+        client ||= StatsD.singleton_client
         @type = type
-        @name = client.prefix ? "#{client.prefix}.#{name}" : name unless no_prefix
+        @name = no_prefix || !client.prefix ? name : "#{client.prefix}.#{name}"
         @value = normalized_value_for_type(type, value) if value
         @sample_rate = sample_rate
         @tags = normalize_tags(tags)
@@ -65,9 +66,9 @@ module StatsD
       end
 
       def to_s
-        str = +"#{name}:#{value || '<anything>'}|#{type}"
+        str = +"#{name}:#{value || "<anything>"}|#{type}"
         str << "|@#{sample_rate}" if sample_rate
-        str << "|#" << tags.join(',') if tags
+        str << "|#" << tags.join(",") if tags
         str << " (expected #{times} times)" if times > 1
         str
       end
@@ -78,19 +79,6 @@ module StatsD
 
       private
 
-      # Needed for normalize_tags
-      unless Regexp.method_defined?(:match?) # for ruby 2.3
-        module RubyBackports
-          refine Regexp do
-            def match?(str)
-              (self =~ str) != nil
-            end
-          end
-        end
-
-        using(RubyBackports)
-      end
-
       # @private
       #
       # Utility function to convert tags to the canonical form.
@@ -109,7 +97,7 @@ module StatsD
 
         # Fast path when no string replacement is needed
         return tags unless tags.any? { |tag| /[|,]/.match?(tag) }
-        tags.map { |tag| tag.tr('|,', '') }
+        tags.map { |tag| tag.tr("|,", "") }
       end
     end
 

data/lib/statsd/instrument/matchers.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'rspec/expectations'
-require 'rspec/core/version'
+require "rspec/expectations"
+require "rspec/core/version"
 
 module StatsD
   module Instrument
     module Matchers
       class Matcher
-        include(RSpec::Matchers::Composable) if RSpec::Core::Version::STRING.start_with?('3')
+        include(RSpec::Matchers::Composable) if RSpec::Core::Version::STRING.start_with?("3")
         include StatsD::Instrument::Helpers
 
         def initialize(metric_type, metric_name, options = {})
@@ -35,6 +35,10 @@ module StatsD
           true
         end
 
+        def description
+          "trigger a statsd call for metric #{@metric_name}"
+        end
+
         private
 
         def expect_statsd_call(metric_type, metric_name, options, &block)
@@ -74,7 +78,7 @@ module StatsD
           message += options[:times] ? "exactly #{options[:times]} times" : "at least once"
           message += " with: #{options[expectation]}"
 
-          message += "\n  captured metric values: #{metrics.map(&expectation).join(', ')}"
+          message += "\n  captured metric values: #{metrics.map(&expectation).join(", ")}"
 
           message
         end

data/lib/statsd/instrument/railtie.rb

@@ -7,7 +7,7 @@ module StatsD
     #
     # @see StatsD::Instrument::Environment
     class Railtie < Rails::Railtie
-      initializer 'statsd-instrument.use_rails_logger' do
+      initializer "statsd-instrument.use_rails_logger" do
         ::StatsD.logger = Rails.logger
       end
     end

data/lib/statsd/instrument/rubocop/measure_as_dist_argument.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/metaprogramming_positional_arguments.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -19,7 +19,7 @@ module RuboCop
       class MetaprogrammingPositionalArguments < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Use keyword arguments for StatsD metaprogramming macros'
+        MSG = "Use keyword arguments for StatsD metaprogramming macros"
 
         def on_send(node)
           if metaprogramming_method?(node)

data/lib/statsd/instrument/rubocop/metric_prefix_argument.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/metric_return_value.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -17,9 +17,9 @@ module RuboCop
       class MetricReturnValue < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Do not use the return value of StatsD metric methods'
+        MSG = "Do not use the return value of StatsD metric methods"
 
-        INVALID_PARENTS = %i{lvasgn array pair send return yield}
+        INVALID_PARENTS = [:lvasgn, :array, :pair, :send, :return, :yield]
 
         def on_send(node)
           if metric_method?(node) && node.arguments.last&.type != :block_pass

data/lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/positional_arguments.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -17,7 +17,7 @@ module RuboCop
       class PositionalArguments < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Use keyword arguments for StatsD calls'
+        MSG = "Use keyword arguments for StatsD calls"
 
         POSITIONAL_ARGUMENT_TYPES = Set[:int, :float, :nil]
         UNKNOWN_ARGUMENT_TYPES = Set[:send, :const, :lvar, :splat]
@@ -80,7 +80,7 @@ module RuboCop
 
               tags = positional_arguments[1]
               if tags && tags.type != :nil
-                keyword_arguments << if tags.type == :hash && tags.source[0] != '{'
+                keyword_arguments << if tags.type == :hash && tags.source[0] != "{"
                   "tags: { #{tags.source} }"
                 else
                   "tags: #{tags.source}"
@@ -88,7 +88,7 @@ module RuboCop
               end
 
               unless keyword_arguments.empty?
-                corrector.insert_after(value_argument.source_range, ", #{keyword_arguments.join(', ')}")
+                corrector.insert_after(value_argument.source_range, ", #{keyword_arguments.join(", ")}")
               end
             end
           end

data/lib/statsd/instrument/rubocop/singleton_configuration.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/splat_arguments.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -16,7 +16,7 @@ module RuboCop
       class SplatArguments < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Do not use splat arguments in StatsD metric calls'
+        MSG = "Do not use splat arguments in StatsD metric calls"
 
         def on_send(node)
           if metric_method?(node)

data/lib/statsd/instrument/rubocop.rb

@@ -3,34 +3,13 @@
 module RuboCop
   module Cop
     module StatsD
-      METRIC_METHODS = %i{
-        increment
-        gauge
-        measure
-        set
-        histogram
-        distribution
-        key_value
-      }
+      METRIC_METHODS = [:increment, :gauge, :measure, :set, :histogram, :distribution, :key_value]
 
-      METAPROGRAMMING_METHODS = %i{
-        statsd_measure
-        statsd_distribution
-        statsd_count_success
-        statsd_count_if
-        statsd_count
-      }
+      METAPROGRAMMING_METHODS = [:statsd_measure, :statsd_distribution, :statsd_count_success, :statsd_count_if,
+                                 :statsd_count,]
 
-      SINGLETON_CONFIGURATION_METHODS = %i{
-        backend
-        backend=
-        prefix
-        prefix=
-        default_tags
-        default_tags=
-        default_sample_rate
-        default_sample_rate=
-      }
+      SINGLETON_CONFIGURATION_METHODS = [:backend, :"backend=", :prefix, :"prefix=", :default_tags, :"default_tags=",
+                                         :default_sample_rate, :"default_sample_rate=",]
 
       private
 
@@ -72,11 +51,11 @@ module RuboCop
   end
 end
 
-require_relative 'rubocop/metaprogramming_positional_arguments'
-require_relative 'rubocop/metric_return_value'
-require_relative 'rubocop/metric_value_keyword_argument'
-require_relative 'rubocop/positional_arguments'
-require_relative 'rubocop/splat_arguments'
-require_relative 'rubocop/measure_as_dist_argument'
-require_relative 'rubocop/metric_prefix_argument'
-require_relative 'rubocop/singleton_configuration'
+require_relative "rubocop/metaprogramming_positional_arguments"
+require_relative "rubocop/metric_return_value"
+require_relative "rubocop/metric_value_keyword_argument"
+require_relative "rubocop/positional_arguments"
+require_relative "rubocop/splat_arguments"
+require_relative "rubocop/measure_as_dist_argument"
+require_relative "rubocop/metric_prefix_argument"
+require_relative "rubocop/singleton_configuration"