statsd-instrument 2.9.2 → 3.0.0.pre1

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

data/lib/statsd/instrument/metric.rb

@@ -1,155 +0,0 @@
-# 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
-#     overridden by the <tt>:prefix</tt> option. Note that <tt>:no_prefix</tt> has greater
-#     precedence than <tt>:prefix</tt>.
-# @!attribute value
-#   @see #default_value
-#   @return [Numeric, String] The value to collect for the metric. Depending on the metric
-#     type, <tt>value</tt> can be a string, integer, or float.
-# @!attribute sample_rate
-#   The sample rate to use for the metric. How the sample rate is handled differs per backend.
-#   The UDP backend will actually sample metric submissions based on the sample rate, while
-#   the logger backend will just include the sample rate in its output for debugging purposes.
-#   @see StatsD#default_sample_rate
-#   @return [Float] The sample rate to use for this metric. This should be a value between
-#     0 and 1. If not set, it will use the default sample rate set to {StatsD#default_sample_rate}.
-# @!attribute tags
-#   The tags to associate with the metric.
-#   @note Only the Datadog implementation supports tags.
-#   @see .normalize_tags
-#   @return [Array<String>, Hash<String, String>, nil] the tags to associate with the metric.
-#     You can either specify the tags as an array of strings, or a Hash of key/value pairs.
-#
-# @see StatsD The StatsD module contains methods that generate metric instances.
-# @see StatsD::Instrument::Backend A StatsD::Instrument::Backend is used to collect metrics.
-#
-class StatsD::Instrument::Metric
-  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
-
-  def self.new(type:, name:, value: default_value(type), tags: nil, metadata: nil,
-    sample_rate: StatsD.legacy_singleton_client.default_sample_rate)
-
-    # pass keyword arguments as positional arguments for performance reasons,
-    # since MRI's C implementation of new turns keyword arguments into a hash
-    super(type, name, value, sample_rate, tags, metadata)
-  end
-
-  # The default value for this metric, which will be used if it is not set.
-  #
-  # A default value is only defined for counter metrics (<tt>1</tt>). For all other
-  # metric types, this method will raise an <tt>ArgumentError</tt>.
-  #
-  #
-  # A default value is only defined for counter metrics (<tt>1</tt>). For all other
-  # metric types, this method will raise an <tt>ArgumentError</tt>.
-  #
-  # @return [Numeric, String] The default value for this metric.
-  # @raise ArgumentError if the metric type doesn't have a default value
-  def self.default_value(type)
-    case type
-    when :c then 1
-    else raise ArgumentError, "A value is required for metric type #{type.inspect}."
-    end
-  end
-
-  attr_accessor :type, :name, :value, :sample_rate, :tags, :metadata
-
-  # Initializes a new metric instance.
-  # Normally, you don't want to call this method directly, but use one of the metric collection
-  # methods on the {StatsD} module.
-  #
-  # @param type [Symbol] The type of the metric.
-  # @option name [String] :name The name of the metric without prefix.
-  # @option value [Numeric, String, nil] The value to collect for the metric.
-  # @option sample_rate [Numeric, nil] The sample rate to use. If not set, it will use
-  #   {StatsD#default_sample_rate}.
-  # @option tags [Array<String>, Hash<String, String>, nil] :tags The tags to apply to this metric.
-  #   See {.normalize_tags} for more information.
-  def initialize(type, name, value, sample_rate, tags, metadata) # rubocop:disable Metrics/ParameterLists
-    raise ArgumentError, "Metric :type is required." unless type
-    raise ArgumentError, "Metric :name is required." unless name
-    raise ArgumentError, "Metric :value is required." unless value
-
-    @type = type
-    @name = normalize_name(name)
-    @value = value
-    @sample_rate = sample_rate
-    @tags = StatsD::Instrument::Metric.normalize_tags(tags)
-    if StatsD.legacy_singleton_client.default_tags
-      @tags = Array(@tags) + StatsD.legacy_singleton_client.default_tags
-    end
-    @metadata = metadata
-  end
-
-  # @private
-  # @return [String]
-  def to_s
-    str = +"#{name}:#{value}|#{type}"
-    str << "|@#{sample_rate}" if sample_rate && sample_rate != 1.0
-    str << "|#" << tags.join(',') if tags && !tags.empty?
-    str
-  end
-
-  # @private
-  # @return [String]
-  def inspect
-    "#<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',
-    ms: 'measure',
-    g: 'gauge',
-    h: 'histogram',
-    d: 'distribution',
-    kv: 'key/value',
-    s: 'set',
-  }
-
-  # Strip metric names of special characters used by StatsD line protocol, replace with underscore
-  #
-  # @param name [String]
-  # @return [String]
-  def normalize_name(name)
-    # fast path when no normalization is needed to avoid copying the string
-    return name unless /[:|@]/.match?(name)
-
-    name.tr(':|@', '_')
-  end
-
-  # Utility function to convert tags to the canonical form.
-  #
-  # - Tags specified as key value pairs will be converted into an array
-  # - Tags are normalized to only use word characters and underscores.
-  #
-  # @param tags [Array<String>, Hash<String, String>, nil] Tags specified in any form.
-  # @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 + ":" + v.to_s } if tags.is_a?(Hash)
-
-    # fast path when no string replacement is needed
-    return tags unless tags.any? { |tag| /[|,]/.match?(tag) }
-
-    tags.map { |tag| tag.tr('|,', '') }
-  end
-end