statsd-instrument 2.9.0 → 3.0.0

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

data/lib/statsd/instrument/legacy_client.rb

@@ -1,301 +0,0 @@
-# frozen_string_literal: true
-
-class StatsD::Instrument::LegacyClient
-  def self.singleton
-    @singleton ||= new
-  end
-
-  attr_accessor :default_sample_rate, :prefix
-  attr_writer :backend
-  attr_reader :default_tags
-
-  def default_tags=(tags)
-    @default_tags = StatsD::Instrument::Metric.normalize_tags(tags)
-  end
-
-  def backend
-    @backend ||= StatsD::Instrument::Environment.default_backend
-  end
-
-  # @!method measure(name, value = nil, sample_rate: nil, tags: nil, &block)
-  #
-  # Emits a timing metric
-  #
-  # @param [String] key The name of the metric.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  #
-  # @example Providing a value directly
-  #    start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
-  #    do_something
-  #    stop = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
-  #    http_response = StatsD.measure('HTTP.call.duration', stop - start)
-  #
-  # @example Providing a block to measure the duration of its execution
-  #    http_response = StatsD.measure('HTTP.call.duration') do
-  #      Net::HTTP.get(url)
-  #    end
-  #
-  # @overload measure(key, value, sample_rate: nil, tags: nil)
-  #   Emits a timing metric, by providing a duration in milliseconds.
-  #
-  #   @param [Float] value The measured duration in milliseconds
-  #   @return [void]
-  #
-  # @overload measure(key, sample_rate: nil, tags: nil, &block)
-  #   Emits a timing metric, after measuring the execution duration of the
-  #   block passed to this method.
-  #
-  #   @yield `StatsD.measure` will yield the block and measure the duration. After the block
-  #     returns, the duration in millisecond will be emitted as metric.
-  #   @return The value that was returned by the block passed through.
-  def measure(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false, as_dist: false,
-    &block
-  )
-    # TODO: in the next version, hardcode this to :ms when the as_dist argument is dropped.
-    type = as_dist ? :d : :ms
-    prefix = nil if no_prefix
-    if block_given?
-      measure_latency(type, key, sample_rate: sample_rate, tags: tags, prefix: prefix, &block)
-    else
-      collect_metric(type, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-    end
-  end
-
-  # @!method increment(name, value = 1, sample_rate: nil, tags: nil)
-  #
-  # Emits a counter metric.
-  #
-  # @param key [String] The name of the metric.
-  # @param value [Integer] The value to increment the counter by.
-  #
-  #   You should not compensate for the sample rate using the counter increment. E.g., if
-  #   your sample rate is 0.01, you should <b>not</b> use 100 as increment to compensate for it.
-  #   The sample rate is part of the packet that is being sent to the server, and the server
-  #   should know how to handle it.
-  #
-  # @param sample_rate [Float] (default: `StatsD.default_sample_rate`) The rate at which to sample
-  #   this metric call. This value should be between 0 and 1. This value can be used to reduce
-  #   the amount of network I/O (and CPU cycles) used for very frequent metrics.
-  #
-  #   - A value of `0.1` means that only 1 out of 10 calls will be emitted; the other 9 will
-  #     be short-circuited.
-  #   - When set to `1`, every metric will be emitted.
-  #   - If this parameter is not set, the default sample rate for this client will be used.
-  # @param tags [Array<String>, Hash<Symbol, String>] The tags to associate with this measurement.
-  #   They can be provided as an array of strings, or a hash of key/value pairs.
-  #   _Note:_ Tags are not supported by all implementations.
-  # @return [void]
-  def increment(
-    key, value_arg = 1, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:c, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # @!method gauge(name, value, sample_rate: nil, tags: nil)
-  #
-  # Emits a gauge metric.
-  #
-  # @param key The name of the metric.
-  # @param value [Numeric] The current value to record.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  # @return [void]
-  def gauge(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:g, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # @!method set(name, value, sample_rate: nil, tags: nil)
-  #
-  # Emits a set metric, which counts the number of distinct values that have occurred.
-  #
-  # @example Counting the number of unique visitors
-  #   StatsD.set('visitors.unique', Current.user.id)
-  #
-  # @param key [String] The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  # @return [void]
-  def set(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:s, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # @!method histogram(name, value, sample_rate: nil, tags: nil)
-  #
-  # Emits a histogram metric.
-  #
-  # @param key The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  # @return (see #collect_metric)
-  # @note Supported by the datadog implementation only.
-  def histogram(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:h, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # @!method distribution(name, value = nil, sample_rate: nil, tags: nil, &block)
-  #
-  # Emits a distribution metric.
-  #
-  # @param [String] key The name of the metric.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  #
-  # @note Supported by the datadog implementation only.
-  # @example
-  #    http_response = StatsD.distribution('HTTP.call.duration') do
-  #      Net::HTTP.get(url)
-  #    end
-  #
-  # @overload distribution(name, value, sample_rate: nil, tags: nil)
-  #
-  #   Emits a distribution metric, given a provided value to record.
-  #
-  #   @param [Numeric] value The value to record.
-  #   @return [void]
-  #
-  # @overload distribution(key, metric_options = {}, &block)
-  #
-  #   Emits a distribution metric for the duration of the provided block, in milliseconds.
-  #
-  #   @yield `StatsD.distribution` will yield the block and measure the duration. After
-  #     the block returns, the duration in millisecond will be emitted as metric.
-  #   @return The value that was returned by the block passed through.
-  def distribution(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false,
-    &block
-  )
-    prefix = nil if no_prefix
-    if block_given?
-      measure_latency(:d, key, sample_rate: sample_rate, tags: tags, prefix: prefix, &block)
-    else
-      collect_metric(:d, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-    end
-  end
-
-  # @!method key_value(name, value)
-  #
-  # Emits a key/value metric.
-  #
-  # @param key [String] The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @return [void]
-  #
-  # @note Supported by the statsite implementation only.
-  def key_value(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:kv, key, value, sample_rate: sample_rate, prefix: prefix)
-  end
-
-  # @!method event(title, text, tags: nil, hostname: nil, timestamp: nil, aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil) # rubocop:disable Metrics/LineLength
-  #
-  # Emits an event.
-  #
-  # @param title [String] Title of the event. A configured prefix may be applied to this title.
-  # @param text [String] Body of the event. Can contain newlines.
-  # @param [String] hostname The hostname to associate with the event.
-  # @param [Time] timestamp The moment the status of the service was checked. Defaults to now.
-  # @param [String] aggregation_key A key to aggregate similar events into groups.
-  # @param [String] priority The event's priority, either `"low"` or `"normal"` (default).
-  # @param [String] source_type_name The source type.
-  # @param [String] alert_type The type of alert. Either `"info"` (default), `"warning"`, `"error"`, or `"success"`.
-  # @param tags (see #increment)
-  # @return [void]
-  #
-  # @note Supported by the Datadog implementation only.
-  def event(
-    title, text,
-    deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false,
-    hostname: nil, date_happened: nil, timestamp: date_happened,
-    aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil,
-    **_ignored
-  )
-    prefix = nil if no_prefix
-    collect_metric(:_e, title, text, sample_rate: sample_rate, tags: tags, prefix: prefix, metadata: {
-      hostname: hostname, timestamp: timestamp, aggregation_key: aggregation_key,
-      priority: priority, source_type_name: source_type_name, alert_type: alert_type
-    })
-  end
-
-  # @!method service_check(name, status, tags: nil, hostname: nil, timestamp: nil, message: nil)
-  #
-  # Emits a service check.
-  #
-  # @param [String] name Name of the service. A configured prefix may be applied to this title.
-  # @param [Symbol] status Current status of the service. Either `:ok`, `:warning`, `:critical`, or `:unknown`.
-  # @param [String] hostname The hostname to associate with the event.
-  # @param [Time] timestamp The moment the status of the service was checked. Defaults to now.
-  # @param [String] message A message that describes the current status.
-  # @param tags (see #increment)
-  # @return [void]
-  #
-  # @note Supported by the Datadog implementation only.
-  def service_check(
-    name, status,
-    deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: self.prefix, no_prefix: false,
-    hostname: nil, timestamp: nil, message: nil, **_ignored
-  )
-    prefix = nil if no_prefix
-    collect_metric(:_sc, name, status, sample_rate: sample_rate, prefix: prefix, tags: tags, metadata: {
-      hostname: hostname, timestamp: timestamp, message: message
-    })
-  end
-
-  protected
-
-  def measure_latency(type, key, sample_rate:, tags:, prefix:)
-    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    begin
-      yield
-    ensure
-      # Ensure catches both a raised exception and a return in the invoked block
-      value = 1000.0 * (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start)
-      collect_metric(type, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-    end
-  end
-
-  # Instantiates a metric, and sends it to the backend for further processing.
-  # @param options (see StatsD::Instrument::Metric#initialize)
-  # @return [void]
-  def collect_metric(type, name, value, sample_rate:, tags: nil, prefix:, metadata: nil)
-    sample_rate ||= default_sample_rate
-    name = "#{prefix}.#{name}" if prefix
-
-    metric = StatsD::Instrument::Metric.new(type: type, name: name, value: value,
-      sample_rate: sample_rate, tags: tags, metadata: metadata)
-    backend.collect_metric(metric)
-    metric
-  end
-end