statsd-instrument 2.5.1 → 2.6.0

data/lib/statsd/instrument.rb

@@ -29,14 +29,13 @@ require 'logger'
 # @!attribute logger
 #   The logger to use in case of any errors. The logger is also used as default logger
 #   for the LoggerBackend (although this can be overwritten).
+#   @see StatsD::Instrument::Backends::LoggerBackend
+#   @return [Logger]
 #
 # @!attribute default_tags
 #   The tags to apply to all metrics.
 #   @return [Array<String>, Hash<String, String>, nil] The default tags, or <tt>nil</tt> when no default tags is used
 #
-#   @see StatsD::Instrument::Backends::LoggerBackend
-#   @return [Logger]
-#
 # @see StatsD::Instrument <tt>StatsD::Instrument</tt> contains module to instrument
 #    existing methods with StatsD metrics.
 module StatsD
@@ -98,7 +97,7 @@ module StatsD
         define_method(method) do |*args, &block|
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
           prefix ||= StatsD.prefix
-          StatsD.measure(
+          StatsD.measure( # rubocop:disable StatsD/MeasureAsDistArgument, StatsD/MetricPrefixArgument
             key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix, as_dist: as_dist
           ) do
             super(*args, &block)
@@ -122,7 +121,9 @@ module StatsD
         define_method(method) do |*args, &block|
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
           prefix ||= StatsD.prefix
-          StatsD.distribution(key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix) do
+          StatsD.distribution( # rubocop:disable StatsD/MetricPrefixArgument
+            key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix
+          ) do
             super(*args, &block)
           end
         end
@@ -167,7 +168,8 @@ module StatsD
             suffix = truthiness == false ? 'failure' : 'success'
             key = "#{StatsD::Instrument.generate_metric_name(name, self, *args)}.#{suffix}"
             prefix ||= StatsD.prefix
-            StatsD.increment(key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
+            StatsD.increment(key, prefix: prefix, # rubocop:disable StatsD/MetricPrefixArgument
+              sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
           end
         end
       end
@@ -208,7 +210,8 @@ module StatsD
             if truthiness
               key = StatsD::Instrument.generate_metric_name(name, self, *args)
               prefix ||= StatsD.prefix
-              StatsD.increment(key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
+              StatsD.increment(key, prefix: prefix, # rubocop:disable StatsD/MetricPrefixArgument
+                sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
             end
           end
         end
@@ -231,7 +234,8 @@ module StatsD
         define_method(method) do |*args, &block|
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
           prefix ||= StatsD.prefix
-          StatsD.increment(key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
+          StatsD.increment(key, prefix: prefix, # rubocop:disable StatsD/MetricPrefixArgument
+            sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
           super(*args, &block)
         end
       end
@@ -330,7 +334,7 @@ module StatsD
   end
 
   attr_accessor :logger, :default_sample_rate, :prefix
-  attr_writer :backend
+  attr_writer :backend, :client
   attr_reader :default_tags
 
   def default_tags=(tags)
@@ -341,54 +345,64 @@ module StatsD
     @backend ||= StatsD::Instrument::Environment.default_backend
   end
 
-  # Emits a duration metric.
+  def client
+    @client ||= begin
+      require 'statsd/instrument/client'
+      StatsD::Instrument::Environment.from_env.default_client
+    end
+  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.
   #
-  # @overload measure(key, value, metric_options = {})
-  #   Emits a measure metric, by providing a duration in milliseconds.
-  #   @param key [String] The name of the metric.
-  #   @param value [Float] The measured duration in milliseconds
-  #   @param metric_options [Hash] Options for the metric
-  #     the key :as_dist will submit the value as a distribution instead of a timing
-  #     (only supported by DataDog's implementation)
-  #   @return [StatsD::Instrument::Metric] The metric that was sent to the backend.
+  #   @param [Float] value The measured duration in milliseconds
+  #   @return [void]
   #
-  # @overload measure(key, metric_options = {}, &block)
-  #   Emits a measure metric, after measuring the execution duration of the
+  # @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.
-  #   @param key [String] The name of the metric.
-  #   @param metric_options [Hash] Options for the metric
-  #     the key :as_dist sets the metric type to a 'distribution' instead of a 'timing'
-  #     (only supported by DataDog's implementation)
-  #   @yield The method will yield the block that was passed to this method to measure its duration.
-  #   @return The value that was returns by the block passed to this method.
-  #
-  #   @example
-  #      http_response = StatsD.measure('HTTP.call.duration') do
-  #        HTTP.get(url)
-  #      end
+  #
+  #   @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: StatsD.prefix, no_prefix: false, as_dist: false,
     &block
   )
-    prefix = nil if no_prefix
+    # TODO: in the next version, hardcode this to :ms when the as_dist argument is dropped.
     type = as_dist ? :d : :ms
-    unless block_given?
-      return collect_metric(type, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix, &block)
-    end
-
-    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    begin
-      block.call
-    ensure
-      # Ensure catches both a raised exception and a return in the invoked block
-      value = 1000.0 * (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start)
+    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.
   #
@@ -397,7 +411,17 @@ module StatsD
   #   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 metric_options [Hash] (default: {}) Metric options
+  # @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,
@@ -408,11 +432,15 @@ module StatsD
     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 [String] The name of the metric.
+  #
+  # @param key The name of the metric.
   # @param value [Numeric] The current value to record.
-  # @param metric_options [Hash] (default: {}) Metric options
-  # @return (see #collect_metric)
+  # @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,
@@ -422,10 +450,35 @@ module StatsD
     collect_metric(:g, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
   end
 
-  # Emits a histogram metric.
+  # @!method set(name, value, sample_rate: nil, tags: nil)
+  #
+  # Emits a set metric, which counts the number of distinct values that have occurred.
+  #
+  # @example Couning 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 metric_options [Hash] (default: {}) Metric options
+  # @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: StatsD.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(
@@ -437,26 +490,34 @@ module StatsD
     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 key [String] The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @param metric_options [Hash] (default: {}) Metric options
-  # @return (see #collect_metric)
-  # @note Supported by the datadog implementation only (in beta)
+  #
+  # @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, after measuring the execution duration of the
-  #   block passed to this method.
-  #   @param key [String] The name of the metric.
-  #   @param metric_options [Hash] Options for the metric
-  #   @yield The method will yield the block that was passed to this method to measure its duration.
-  #   @return The value that was returns by the block passed to this method.
-  #   @note Supported by the datadog implementation only.
-  #
-  #   @example
-  #      http_response = StatsD.distribution('HTTP.call.duration') do
-  #        HTTP.get(url)
-  #      end
+  #
+  #   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,
@@ -464,14 +525,21 @@ module StatsD
     &block
   )
     prefix = nil if no_prefix
-    measure(key, value, as_dist: true, sample_rate: sample_rate, tags: tags, prefix: prefix, &block)
+    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.
-  # @param metric_options [Hash] (default: {}) Metric options
-  # @return (see #collect_metric)
+  # @return [void]
+  #
   # @note Supported by the statsite implementation only.
   def key_value(
     key, value_arg = nil, deprecated_sample_rate_arg = nil,
@@ -481,55 +549,77 @@ module StatsD
     collect_metric(:kv, key, value, sample_rate: sample_rate, prefix: prefix)
   end
 
-  # Emits a set metric.
-  # @param key [String] The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @param metric_options [Hash] (default: {}) Metric options
-  # @return (see #collect_metric)
-  # @note Supported by the datadog implementation only.
-  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: StatsD.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:s, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # Emits an event metric.
-  # @param title [String] Title of the event.
-  # @param text [String] Body of the event.
-  # @param metric_options [Hash] (default: {}) Metric options
-  # @return (see #collect_metric)
-  # @note Supported by the datadog implementation only.
+  # @!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 checkes. 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: StatsD.prefix, no_prefix: false, **metadata
+    prefix: StatsD.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: metadata)
+    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
 
-  # Emits a service check metric.
-  # @param title [String] Title of the event.
-  # @param text [String] Body of the event.
-  # @param metric_options [Hash] (default: {}) Metric options
-  # @return (see #collect_metric)
-  # @note Supported by the datadog implementation only.
+  # @!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 checkes. 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: StatsD.prefix, no_prefix: false, **metadata
+    prefix: StatsD.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, tags: tags, prefix: prefix, metadata: metadata)
+    collect_metric(:_sc, name, status, sample_rate: sample_rate, prefix: prefix, tags: tags, metadata: {
+      hostname: hostname, timestamp: timestamp, message: message
+    })
   end
 
   private
 
+  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]
@@ -552,4 +642,5 @@ require 'statsd/instrument/helpers'
 require 'statsd/instrument/assertions'
 require 'statsd/instrument/metric_expectation'
 require 'statsd/instrument/matchers' if defined?(::RSpec)
-require 'statsd/instrument/railtie' if defined?(Rails)
+require 'statsd/instrument/railtie' if defined?(::Rails::Railtie)
+require 'statsd/instrument/strict' if ENV['STATSD_STRICT_MODE']