statsd-instrument 2.9.2 → 3.0.0.pre1

data/test/statsd_test.rb

@@ -5,15 +5,6 @@ require 'test_helper'
 class StatsDTest < Minitest::Test
   include StatsD::Instrument::Assertions
 
-  def teardown
-    StatsD.default_tags = nil
-  end
-
-  def test_statsd_passed_collections_to_backend
-    StatsD.backend.expects(:collect_metric).with(instance_of(StatsD::Instrument::Metric))
-    StatsD.increment('test')
-  end
-
   def test_statsd_measure_with_explicit_value
     metric = capture_statsd_call { StatsD.measure('values.foobar', 42) }
     assert_equal 'values.foobar', metric.name
@@ -21,10 +12,6 @@ class StatsDTest < Minitest::Test
     assert_equal :ms, metric.type
   end
 
-  def test_statsd_measure_without_value_or_block
-    assert_raises(ArgumentError) { StatsD.measure('values.foobar', tags: 123) }
-  end
-
   def test_statsd_measure_with_explicit_value_and_sample_rate
     metric = capture_statsd_call { StatsD.measure('values.foobar', 42, sample_rate: 0.1) }
     assert_equal 0.1, metric.sample_rate
@@ -85,7 +72,7 @@ class StatsDTest < Minitest::Test
 
   def test_statsd_increment_with_hash_argument
     metric = capture_statsd_call { StatsD.increment('values.foobar', tags: ['test']) }
-    assert_equal StatsD.default_sample_rate, metric.sample_rate
+    assert_equal StatsD.singleton_client.default_sample_rate, metric.sample_rate
     assert_equal ['test'], metric.tags
     assert_equal 1, metric.value
   end
@@ -98,7 +85,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_gauge_without_value
-    assert_raises(ArgumentError) { StatsD.gauge('values.foobar', tags: 123) }
+    assert_raises(ArgumentError) { StatsD.gauge('values.foobar') }
   end
 
   def test_statsd_set
@@ -200,20 +187,6 @@ class StatsDTest < Minitest::Test
     end
   end
 
-  def test_statsd_default_tags_get_normalized
-    StatsD.default_tags = { first_tag: 'first_value', second_tag: 'second_value' }
-    assert_equal ['first_tag:first_value', 'second_tag:second_value'], StatsD.default_tags
-  end
-
-  def test_name_prefix
-    StatsD.legacy_singleton_client.stubs(:prefix).returns('prefix')
-    m = capture_statsd_call { StatsD.increment('counter') }
-    assert_equal 'prefix.counter', m.name
-
-    m = capture_statsd_call { StatsD.increment('counter', no_prefix: true) }
-    assert_equal 'counter', m.name
-  end
-
   protected
 
   def capture_statsd_call(&block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.9.2
+  version: 3.0.0.pre1
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -133,17 +133,11 @@ files:
 - README.md
 - Rakefile
 - benchmark/README.md
-- benchmark/datagram-client
 - benchmark/send-metrics-to-dev-null-log
 - benchmark/send-metrics-to-local-udp-receiver
 - lib/statsd-instrument.rb
 - lib/statsd/instrument.rb
 - lib/statsd/instrument/assertions.rb
-- lib/statsd/instrument/backend.rb
-- lib/statsd/instrument/backends/capture_backend.rb
-- lib/statsd/instrument/backends/logger_backend.rb
-- lib/statsd/instrument/backends/null_backend.rb
-- lib/statsd/instrument/backends/udp_backend.rb
 - lib/statsd/instrument/capture_sink.rb
 - lib/statsd/instrument/client.rb
 - lib/statsd/instrument/datagram.rb
@@ -153,10 +147,8 @@ files:
 - lib/statsd/instrument/environment.rb
 - lib/statsd/instrument/expectation.rb
 - lib/statsd/instrument/helpers.rb
-- lib/statsd/instrument/legacy_client.rb
 - lib/statsd/instrument/log_sink.rb
 - lib/statsd/instrument/matchers.rb
-- lib/statsd/instrument/metric.rb
 - lib/statsd/instrument/null_sink.rb
 - lib/statsd/instrument/railtie.rb
 - lib/statsd/instrument/rubocop.rb
@@ -174,28 +166,22 @@ files:
 - lib/statsd/instrument/version.rb
 - shipit.rubygems.yml
 - statsd-instrument.gemspec
-- test/assertions_on_legacy_client_test.rb
 - test/assertions_test.rb
 - test/benchmark/clock_gettime.rb
 - test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
-- test/capture_backend_test.rb
 - test/capture_sink_test.rb
 - test/client_test.rb
-- test/compatibility/dogstatsd_datagram_compatibility_test.rb
 - test/datagram_builder_test.rb
 - test/datagram_test.rb
-- test/deprecations_test.rb
 - test/dogstatsd_datagram_builder_test.rb
 - test/environment_test.rb
 - test/helpers/rubocop_helper.rb
 - test/helpers_test.rb
 - test/integration_test.rb
 - test/log_sink_test.rb
-- test/logger_backend_test.rb
 - test/matchers_test.rb
-- test/metric_test.rb
 - test/null_sink_test.rb
 - test/rubocop/measure_as_dist_argument_test.rb
 - test/rubocop/metaprogramming_positional_arguments_test.rb
@@ -209,7 +195,6 @@ files:
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb
 - test/test_helper.rb
-- test/udp_backend_test.rb
 - test/udp_sink_test.rb
 homepage: https://github.com/Shopify/statsd-instrument
 licenses:
@@ -226,37 +211,31 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A StatsD client for Ruby apps
 test_files:
-- test/assertions_on_legacy_client_test.rb
 - test/assertions_test.rb
 - test/benchmark/clock_gettime.rb
 - test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
-- test/capture_backend_test.rb
 - test/capture_sink_test.rb
 - test/client_test.rb
-- test/compatibility/dogstatsd_datagram_compatibility_test.rb
 - test/datagram_builder_test.rb
 - test/datagram_test.rb
-- test/deprecations_test.rb
 - test/dogstatsd_datagram_builder_test.rb
 - test/environment_test.rb
 - test/helpers/rubocop_helper.rb
 - test/helpers_test.rb
 - test/integration_test.rb
 - test/log_sink_test.rb
-- test/logger_backend_test.rb
 - test/matchers_test.rb
-- test/metric_test.rb
 - test/null_sink_test.rb
 - test/rubocop/measure_as_dist_argument_test.rb
 - test/rubocop/metaprogramming_positional_arguments_test.rb
@@ -270,5 +249,4 @@ test_files:
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb
 - test/test_helper.rb
-- test/udp_backend_test.rb
 - test/udp_sink_test.rb

data/benchmark/datagram-client

@@ -1,40 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'benchmark/ips'
-require 'socket'
-
-# Set up an UDP listener to which we can send StatsD packets
-legacy_receiver = UDPSocket.new
-legacy_receiver.bind('localhost', 0)
-
-ENV['ENV'] = "production"
-ENV['STATSD_ADDR'] = "#{legacy_receiver.addr[2]}:#{legacy_receiver.addr[1]}"
-ENV['STATSD_IMPLEMENTATION'] ||= 'datadog'
-
-require 'statsd-instrument'
-
-legacy_client = StatsD
-
-# Set up an UDP listener to which we can send StatsD packets
-new_client_receiver = UDPSocket.new
-new_client_receiver.bind('localhost', 0)
-
-udp_sink = StatsD::Instrument::UDPSink.new(new_client_receiver.addr[2], new_client_receiver.addr[1])
-new_client = StatsD::Instrument::Client.new(sink: udp_sink, default_sample_rate: StatsD.default_sample_rate)
-
-Benchmark.ips do |bench|
-  bench.report("Legacy client (sample rate: #{StatsD.default_sample_rate})") do
-    legacy_client.increment('StatsD.increment')
-  end
-
-  bench.report("New client (sample rate: #{StatsD.default_sample_rate})") do
-    new_client.increment('StatsD.increment')
-  end
-
-  bench.compare!
-end
-
-legacy_receiver.close
-new_client_receiver.close

data/lib/statsd/instrument/backend.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# This abstract class specifies the interface a backend implementation should conform to.
-# @abstract
-class StatsD::Instrument::Backend
-  # Collects a metric.
-  #
-  # @param metric [StatsD::Instrument::Metric] The metric to collect
-  # @return [void]
-  def collect_metric(_metric)
-    raise NotImplementedError, "Use a concrete backend implementation"
-  end
-end
-
-require 'statsd/instrument/backends/logger_backend'
-require 'statsd/instrument/backends/null_backend'
-require 'statsd/instrument/backends/capture_backend'
-require 'statsd/instrument/backends/udp_backend'

data/lib/statsd/instrument/backends/capture_backend.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module StatsD::Instrument::Backends
-  # The capture backend is used to capture the metrics that are collected, so you can
-  # run assertions on them.
-  #
-  # @!attribute collected_metrics [r]
-  #   @return [Array<StatsD::Instrument::Metric>] The list of metrics that were collected.
-  # @see StatsD::Instrument::Assertions
-  class CaptureBackend < StatsD::Instrument::Backend
-    attr_reader :collected_metrics
-    attr_accessor :parent
-
-    def initialize
-      reset
-    end
-
-    # Adds a metric to the ist of collected metrics.
-    # @param metric [StatsD::Instrument::Metric]  The metric to collect.
-    # @return [void]
-    def collect_metric(metric)
-      parent&.collect_metric(metric)
-      @collected_metrics << metric
-    end
-
-    # Resets the list of collected metrics to an empty list.
-    # @return [void]
-    def reset
-      @collected_metrics = []
-    end
-  end
-end

data/lib/statsd/instrument/backends/logger_backend.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module StatsD::Instrument::Backends
-  # The logger backend simply logs every metric to a logger
-  # @!attribute logger
-  #    @return [Logger]
-  class LoggerBackend < StatsD::Instrument::Backend
-    attr_accessor :logger
-
-    def initialize(logger)
-      @logger = logger
-    end
-
-    # @param metric [StatsD::Instrument::Metric]
-    # @return [void]
-    def collect_metric(metric)
-      logger.info("[StatsD] #{metric}")
-    end
-  end
-end

data/lib/statsd/instrument/backends/null_backend.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module StatsD::Instrument::Backends
-  # The null backend does nothing when receiving a metric, effectively disabling the gem completely.
-  class NullBackend < StatsD::Instrument::Backend
-    def collect_metric(metric)
-    end
-  end
-end

data/lib/statsd/instrument/backends/udp_backend.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-require 'monitor'
-
-module StatsD::Instrument::Backends
-  class UDPBackend < StatsD::Instrument::Backend
-    BASE_SUPPORTED_METRIC_TYPES = { c: true, ms: true, g: true, s: true }
-
-    class DogStatsDProtocol
-      SUPPORTED_METRIC_TYPES = BASE_SUPPORTED_METRIC_TYPES.merge(h: true, _e: true, _sc: true, d: true)
-
-      SERVICE_CHECK_STATUSES = { ok: 0, warning: 1, critical: 2, unknown: 3 }
-
-      def generate_packet(metric)
-        packet = +""
-
-        if metric.type == :_e
-          escaped_title = metric.name.gsub("\n", "\\n")
-          escaped_text = metric.value.gsub("\n", "\\n")
-
-          packet << "_e{#{escaped_title.size},#{escaped_text.size}}:#{escaped_title}|#{escaped_text}"
-          packet << "|h:#{metric.metadata[:hostname]}" if metric.metadata[:hostname]
-          packet << "|d:#{metric.metadata[:timestamp].to_i}" if metric.metadata[:timestamp]
-          packet << "|k:#{metric.metadata[:aggregation_key]}" if metric.metadata[:aggregation_key]
-          packet << "|p:#{metric.metadata[:priority]}" if metric.metadata[:priority]
-          packet << "|s:#{metric.metadata[:source_type_name]}" if metric.metadata[:source_type_name]
-          packet << "|t:#{metric.metadata[:alert_type]}" if metric.metadata[:alert_type]
-          packet << "|##{metric.tags.join(',')}" if metric.tags
-
-        elsif metric.type == :_sc
-          status = metric.value.is_a?(Integer) ? metric.value : SERVICE_CHECK_STATUSES.fetch(metric.value.to_sym)
-
-          packet << "_sc|#{metric.name}|#{status}"
-          packet << "|h:#{metric.metadata[:hostname]}" if metric.metadata[:hostname]
-          packet << "|d:#{metric.metadata[:timestamp].to_i}" if metric.metadata[:timestamp]
-          packet << "|##{metric.tags.join(',')}" if metric.tags
-          packet << "|m:#{metric.metadata[:message]}" if metric.metadata[:message]
-
-        else
-          packet << "#{metric.name}:#{metric.value}|#{metric.type}"
-          packet << "|@#{metric.sample_rate}" if metric.sample_rate < 1
-          packet << "|##{metric.tags.join(',')}" if metric.tags
-        end
-
-        packet
-      end
-    end
-
-    class StatsiteStatsDProtocol
-      SUPPORTED_METRIC_TYPES = BASE_SUPPORTED_METRIC_TYPES.merge(kv: true)
-
-      def generate_packet(metric)
-        packet = +"#{metric.name}:#{metric.value}|#{metric.type}"
-        packet << "|@#{metric.sample_rate}" unless metric.sample_rate == 1
-        packet << "\n"
-        packet
-      end
-    end
-
-    class StatsDProtocol
-      SUPPORTED_METRIC_TYPES = BASE_SUPPORTED_METRIC_TYPES
-
-      def generate_packet(metric)
-        packet = +"#{metric.name}:#{metric.value}|#{metric.type}"
-        packet << "|@#{metric.sample_rate}" if metric.sample_rate < 1
-        packet
-      end
-    end
-
-    DEFAULT_IMPLEMENTATION = :statsd
-
-    include MonitorMixin
-
-    attr_reader :host, :port, :implementation
-
-    def initialize(server = nil, implementation = nil)
-      super()
-      self.server = server || "localhost:8125"
-      self.implementation = (implementation || DEFAULT_IMPLEMENTATION).to_sym
-    end
-
-    def implementation=(value)
-      @packet_factory = case value
-      when :datadog
-        DogStatsDProtocol.new
-      when :statsite
-        StatsiteStatsDProtocol.new
-      else
-        StatsDProtocol.new
-      end
-      @implementation = value
-    end
-
-    def collect_metric(metric)
-      unless @packet_factory.class::SUPPORTED_METRIC_TYPES[metric.type]
-        StatsD.logger.warn("[StatsD] Metric type #{metric.type.inspect} is not supported " \
-          "on #{implementation} implementation.")
-        return false
-      end
-
-      if metric.sample_rate < 1.0 && rand > metric.sample_rate
-        return false
-      end
-
-      write_packet(@packet_factory.generate_packet(metric))
-    end
-
-    def server=(connection_string)
-      @host, @port = connection_string.split(':', 2)
-      @port = @port.to_i
-      invalidate_socket
-    end
-
-    def host=(host)
-      @host = host
-      invalidate_socket
-    end
-
-    def port=(port)
-      @port = port
-      invalidate_socket
-    end
-
-    def socket
-      if @socket.nil?
-        @socket = UDPSocket.new
-        @socket.connect(host, port)
-      end
-      @socket
-    end
-
-    def write_packet(command)
-      synchronize do
-        socket.send(command, 0) > 0
-      end
-    rescue ThreadError
-      # In cases where a TERM or KILL signal has been sent, and we send stats as
-      # part of a signal handler, locks cannot be acquired, so we do our best
-      # to try and send the command without a lock.
-      socket.send(command, 0) > 0
-    rescue SocketError, IOError, SystemCallError => e
-      StatsD.logger.error("[StatsD] #{e.class.name}: #{e.message}")
-      invalidate_socket
-    end
-
-    def invalidate_socket
-      synchronize do
-        @socket = nil
-      end
-    end
-  end
-end