dogstatsd-ruby 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 046a0af9f230451c91fdeb9ae128c550b1c20623fa017d326e63a2f053f7cc9a
-  data.tar.gz: e2ba838497de521e89d386645a0228f819fdd03c28acc05a4789aa7f8d979de8
+  metadata.gz: 6d2b1b9e7ec2a48c5305f6acda103d0b7a09787801dd899a38fb665f5389e4f3
+  data.tar.gz: 3d974fffb4ace3bc248e69dcdaabb4c556e6783a25d65af98cb65bdccafc52ee
 SHA512:
-  metadata.gz: f2048376477bd1af31a63b75d17638df999c9f6341f967b2c826177add2a13831a54a72729e2a5c62aa09fa4aca6dccbaba308c79d9adcd470808d3bb80cde59
-  data.tar.gz: 2e0ac5fc90f8a2359f35a754034bb6474c1169ac8c8f3301257555553e1aca4f708cecd4d9245ff835cbe4396561a89d3bd3700ef6cea6c92c343a1e41ca2055
+  metadata.gz: 16c82cb62bfd324d5e1dc1c6293fa121b92bd0c88d00474210c5da67f2cb07ae350cc0b717b15739c7a6f09e9021323ba348cec70ec2d0ac66a362f15f81007b
+  data.tar.gz: 6e82cef56d746ecf7b10890d397e313c143611b18b4ae65db67eb2f252cb27acacb45de03f6447b7b4ebb1666209806d6b048fb2857c5c8790f1f6729f4ae806

data/README.md

@@ -49,6 +49,11 @@ end
 
 # Tag a metric.
 statsd.histogram('query.time', 10, :tags => ["version:1"])
+
+# Auto-close socket after end of block
+Datadog::Statsd.open('localhost', 8125) do |s|
+  s.increment('page.views')
+end
 ```
 
 You can also post events to your stream. You can tag them, set priority and even aggregate them with other events.

data/lib/datadog/statsd.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'socket'
 
 # = Datadog::Statsd: A DogStatsd client (https://www.datadoghq.com)
@@ -15,12 +16,137 @@ require 'socket'
 #   statsd = Datadog::Statsd.new 'localhost', 8125, :namespace => 'account'
 #   statsd.increment 'activate'
 # @example Create a statsd client with global tags
-#   statsd = Datadog::Statsd.new 'localhost', 8125, :tags => 'tag1:true'
+#   statsd = Datadog::Statsd.new 'localhost', 8125, tags: 'tag1:true'
 module Datadog
   class Statsd
 
-    DEFAULT_HOST = '127.0.0.1'
-    DEFAULT_PORT = 8125
+    class Connection
+      DEFAULT_HOST = '127.0.0.1'
+      DEFAULT_PORT = 8125
+
+      # StatsD host. Defaults to 127.0.0.1.
+      attr_reader :host
+
+      # StatsD port. Defaults to 8125.
+      attr_reader :port
+
+      # DogStatsd unix socket path. Not used by default.
+      attr_reader :socket_path
+
+      def initialize(host, port, socket_path, logger)
+        @host = host || DEFAULT_HOST
+        @port = port || DEFAULT_PORT
+        @socket_path = socket_path
+        @logger = logger
+      end
+
+      def write(message)
+        @logger.debug { "Statsd: #{message}" } if @logger
+        if @socket_path.nil?
+          socket.send(message, 0)
+        else
+          socket.sendmsg_nonblock(message)
+        end
+      rescue StandardError => boom
+        # Give up on this socket if it looks like it is bad
+        bad_socket = !@socket_path.nil? && (
+          boom.is_a?(Errno::ECONNREFUSED) ||
+          boom.is_a?(Errno::ECONNRESET) ||
+          boom.is_a?(Errno::ENOENT)
+        )
+        if bad_socket
+          @socket = nil
+          return
+        end
+
+        # Try once to reconnect if the socket has been closed
+        retries ||= 1
+        if retries <= 1 && boom.is_a?(IOError) && boom.message =~ /closed stream/i
+          retries += 1
+          begin
+            @socket = connect
+            retry
+          rescue StandardError => e
+            boom = e
+          end
+        end
+
+        @logger.error { "Statsd: #{boom.class} #{boom}" } if @logger
+        nil
+      end
+
+      # Close the underlying socket
+      def close
+        @socket && @socket.close
+      end
+
+      private
+
+      def socket
+        @socket ||= connect
+      end
+
+      def connect
+        if @socket_path.nil?
+          socket = UDPSocket.new
+          socket.connect(@host, @port)
+        else
+          socket = Socket.new(Socket::AF_UNIX, Socket::SOCK_DGRAM)
+          socket.connect(Socket.pack_sockaddr_un(@socket_path))
+        end
+        socket
+      end
+    end
+
+    class Batch
+      def initialize(connection, max_buffer_bytes)
+        @connection = connection
+        @max_buffer_bytes = max_buffer_bytes
+        @depth = 0
+        reset
+      end
+
+      def open
+        @depth += 1
+        yield
+      ensure
+        @depth -= 1
+        flush if !open?
+      end
+
+      def open?
+        @depth > 0
+      end
+
+      def add(message)
+        message_bytes = message.bytesize
+
+        unless @buffer_bytes == 0
+          if @buffer_bytes + 1 + message_bytes >= @max_buffer_bytes
+            flush
+          else
+            @buffer << NEW_LINE
+            @buffer_bytes += 1
+          end
+        end
+
+        @buffer << message
+        @buffer_bytes += message_bytes
+      end
+
+      def flush
+        return if @buffer_bytes == 0
+        @connection.write @buffer
+        reset
+      end
+
+      private
+
+      def reset
+        @buffer = String.new
+        @buffer_bytes = 0
+      end
+    end
 
     # Create a dictionary to assign a key to every parameter's name, except for tags (treated differently)
     # Goal: Simple and fast to add some other parameters
@@ -46,78 +172,66 @@ module Datadog
     CRITICAL  = 2
     UNKNOWN   = 3
 
+    MAX_EVENT_SIZE = 8 * 1024
+
     COUNTER_TYPE = 'c'.freeze
     GAUGE_TYPE = 'g'.freeze
     HISTOGRAM_TYPE = 'h'.freeze
     DISTRIBUTION_TYPE = 'd'.freeze
     TIMING_TYPE = 'ms'.freeze
     SET_TYPE = 's'.freeze
-    VERSION = "3.3.0".freeze
+    VERSION = "4.0.0".freeze
 
     # A namespace to prepend to all statsd calls. Defaults to no namespace.
     attr_reader :namespace
 
-    # StatsD host. Defaults to 127.0.0.1.
-    attr_reader :host
-
-    # StatsD port. Defaults to 8125.
-    attr_reader :port
-
-    # DogStatsd unix socket path. Not used by default.
-    attr_reader :socket_path
-
     # Global tags to be added to every statsd call. Defaults to no tags.
     attr_reader :tags
 
     # Buffer containing the statsd message before they are sent in batch
     attr_reader :buffer
 
-    # Maximum number of metrics in the buffer before it is flushed
-    attr_accessor :max_buffer_size
+    # Maximum buffer size in bytes before it is flushed
+    attr_reader :max_buffer_bytes
 
-    class << self
-      # Set to a standard logger instance to enable debug logging.
-      attr_accessor :logger
-    end
-
-    # Return the current version of the library.
-    # deprecated, but cannot be removed since uses might use it to check the version against older releases
-    def self.VERSION
-      VERSION
-    end
+    # Connection
+    attr_reader :connection
 
     # @param [String] host your statsd host
     # @param [Integer] port your statsd port
-    # @option opts [String] :namespace set a namespace to be prepended to every metric name
-    # @option opts [Array<String>] :tags tags to be added to every metric
-    def initialize(host = DEFAULT_HOST, port = DEFAULT_PORT, opts = {}, max_buffer_size=50)
-      self.host, self.port = host, port
-      @socket_path = opts[:socket_path]
-      @prefix = nil
-      @socket = connect_to_socket if @socket_path.nil?
-      self.namespace = opts[:namespace]
-      self.tags = opts[:tags]
-      @buffer = Array.new
-      self.max_buffer_size = max_buffer_size
-      @batch_nesting_depth = 0
-    end
+    # @option [String] namespace set a namespace to be prepended to every metric name
+    # @option [Array<String>] tags tags to be added to every metric
+    # @option [Loger] logger for debugging
+    # @option [Integer] max_buffer_bytes max bytes to buffer when using #batch
+    # @option [String] socket_path unix socket path
+    def initialize(
+      host = nil,
+      port = nil,
+      namespace: nil,
+      tags: nil,
+      max_buffer_bytes: 8192,
+      socket_path: nil,
+      logger: nil
+    )
+      @connection = Connection.new(host, port, socket_path, logger)
+      @logger = logger
 
-    def namespace=(namespace) #:nodoc:
       @namespace = namespace
-      @prefix = namespace.nil? ? nil : "#{namespace}.".freeze
-    end
+      @prefix = @namespace ? "#{@namespace}.".freeze : nil
 
-    def host=(host) #:nodoc:
-      @host = host || DEFAULT_HOST
-    end
+      raise ArgumentError, 'tags must be a Array<String>' unless tags.nil? or tags.is_a? Array
+      @tags = (tags || []).compact.map! {|tag| escape_tag_content(tag)}
 
-    def port=(port) #:nodoc:
-      @port = port || DEFAULT_PORT
+      @batch = Batch.new @connection, max_buffer_bytes
     end
 
-    def tags=(tags) #:nodoc:
-      raise ArgumentError, 'tags must be a Array<String>' unless tags.nil? or tags.is_a? Array
-      @tags = (tags || []).compact.map! {|tag| escape_tag_content(tag)}
+    # yield a new instance to a block and close it when done
+    # for short-term use-cases that don't want to close the socket manually
+    def self.open(*args)
+      instance = new(*args)
+      yield instance
+    ensure
+      instance.close
     end
 
     # Sends an increment (count = 1) for the given stat to the statsd server.
@@ -128,7 +242,7 @@ module Datadog
     # @option opts [Array<String>] :tags An array of tags
     # @option opts [Numeric] :by increment value, default 1
     # @see #count
-    def increment(stat, opts={})
+    def increment(stat, opts=EMPTY_OPTIONS)
       opts = {:sample_rate => opts} if opts.is_a? Numeric
       incr_value = opts.fetch(:by, 1)
       count stat, incr_value, opts
@@ -142,7 +256,7 @@ module Datadog
     # @option opts [Array<String>] :tags An array of tags
     # @option opts [Numeric] :by decrement value, default 1
     # @see #count
-    def decrement(stat, opts={})
+    def decrement(stat, opts=EMPTY_OPTIONS)
       opts = {:sample_rate => opts} if opts.is_a? Numeric
       decr_value = - opts.fetch(:by, 1)
       count stat, decr_value, opts
@@ -155,7 +269,7 @@ module Datadog
     # @param [Hash] opts the options to create the metric with
     # @option opts [Numeric] :sample_rate sample rate, 1 for always
     # @option opts [Array<String>] :tags An array of tags
-    def count(stat, count, opts={})
+    def count(stat, count, opts=EMPTY_OPTIONS)
       opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, count, COUNTER_TYPE, opts
     end
@@ -173,7 +287,7 @@ module Datadog
     # @option opts [Array<String>] :tags An array of tags
     # @example Report the current user count:
     #   $statsd.gauge('user.count', User.count)
-    def gauge(stat, value, opts={})
+    def gauge(stat, value, opts=EMPTY_OPTIONS)
       opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, value, GAUGE_TYPE, opts
     end
@@ -187,7 +301,7 @@ module Datadog
     # @option opts [Array<String>] :tags An array of tags
     # @example Report the current user count:
     #   $statsd.histogram('user.count', User.count)
-    def histogram(stat, value, opts={})
+    def histogram(stat, value, opts=EMPTY_OPTIONS)
       send_stats stat, value, HISTOGRAM_TYPE, opts
     end
 
@@ -203,7 +317,7 @@ module Datadog
     # @option opts [Array<String>] :tags An array of tags
     # @example Report the current user count:
     #   $statsd.distribution('user.count', User.count)
-    def distribution(stat, value, opts={})
+    def distribution(stat, value, opts=EMPTY_OPTIONS)
       send_stats stat, value, DISTRIBUTION_TYPE, opts
     end
 
@@ -217,7 +331,7 @@ module Datadog
     # @param [Hash] opts the options to create the metric with
     # @option opts [Numeric] :sample_rate sample rate, 1 for always
     # @option opts [Array<String>] :tags An array of tags
-    def timing(stat, ms, opts={})
+    def timing(stat, ms, opts=EMPTY_OPTIONS)
       opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, ms, TIMING_TYPE, opts
     end
@@ -235,7 +349,7 @@ module Datadog
     # @see #timing
     # @example Report the time (in ms) taken to activate an account
     #   $statsd.time('account.activate') { @account.activate! }
-    def time(stat, opts={})
+    def time(stat, opts=EMPTY_OPTIONS)
       opts = {:sample_rate => opts} if opts.is_a? Numeric
       start = (PROCESS_TIME_SUPPORTED ? Process.clock_gettime(Process::CLOCK_MONOTONIC) : Time.now.to_f)
       return yield
@@ -243,6 +357,7 @@ module Datadog
       finished = (PROCESS_TIME_SUPPORTED ? Process.clock_gettime(Process::CLOCK_MONOTONIC) : Time.now.to_f)
       timing(stat, ((finished - start) * 1000).round, opts)
     end
+
     # Sends a value to be tracked as a set to the statsd server.
     #
     # @param [String] stat stat name.
@@ -252,7 +367,7 @@ module Datadog
     # @option opts [Array<String>] :tags An array of tags
     # @example Record a unique visitory by id:
     #   $statsd.set('visitors.uniques', User.id)
-    def set(stat, value, opts={})
+    def set(stat, value, opts=EMPTY_OPTIONS)
       opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, value, SET_TYPE, opts
     end
@@ -268,31 +383,8 @@ module Datadog
       # @option opts [String, nil] :message (nil) A message to associate with this service check status
     # @example Report a critical service check status
     #   $statsd.service_check('my.service.check', Statsd::CRITICAL, :tags=>['urgent'])
-    def service_check(name, status, opts={})
-      service_check_string = format_service_check(name, status, opts)
-      send_to_socket service_check_string
-    end
-
-    def format_service_check(name, status, opts={})
-      sc_string = "_sc|#{name}|#{status}"
-
-      SC_OPT_KEYS.each do |key, shorthand_key|
-        next unless opts[key]
-
-        if key == :tags
-          if tags_string = tags_as_string(opts)
-            sc_string << "|##{tags_string}"
-          end
-        elsif key == :message
-          message = remove_pipes(opts[:message])
-          escaped_message = escape_service_check_message(message)
-          sc_string << "|m:#{escaped_message}"
-        else
-          value = remove_pipes(opts[key])
-          sc_string << "|#{shorthand_key}#{value}"
-        end
-      end
-      return sc_string
+    def service_check(name, status, opts=EMPTY_OPTIONS)
+      send_stat format_service_check(name, status, opts)
     end
 
     # This end point allows you to post events to the stream. You can tag them, set priority and even aggregate them with other events.
@@ -313,11 +405,8 @@ module Datadog
     # @option opts [Array<String>] :tags tags to be added to every metric
     # @example Report an awful event:
     #   $statsd.event('Something terrible happened', 'The end is near if we do nothing', :alert_type=>'warning', :tags=>['end_of_times','urgent'])
-    def event(title, text, opts={})
-      event_string = format_event(title, text, opts)
-      raise "Event #{title} payload is too big (more that 8KB), event discarded" if event_string.length > 8 * 1024
-
-      send_to_socket event_string
+    def event(title, text, opts=EMPTY_OPTIONS)
+      send_stat format_event(title, text, opts)
     end
 
     # Send several metrics in the same UDP Packet
@@ -328,18 +417,56 @@ module Datadog
     #      s.gauge('users.online',156)
     #      s.increment('page.views')
     #    end
-    def batch()
-      @batch_nesting_depth += 1
-      yield self
-    ensure
-      @batch_nesting_depth -= 1
-      flush_buffer if @batch_nesting_depth == 0
+    def batch
+      @batch.open { yield self }
     end
 
-    def format_event(title, text, opts={})
+    # Close the underlying socket
+    def close
+      @connection.close
+    end
+
+    private
+
+    NEW_LINE = "\n".freeze
+    ESC_NEW_LINE = "\\n".freeze
+    COMMA = ",".freeze
+    PIPE = "|".freeze
+    DOT = ".".freeze
+    DOUBLE_COLON = "::".freeze
+    UNDERSCORE = "_".freeze
+    PROCESS_TIME_SUPPORTED = (RUBY_VERSION >= "2.1.0")
+    EMPTY_OPTIONS = {}.freeze
+
+    private_constant :NEW_LINE, :ESC_NEW_LINE, :COMMA, :PIPE, :DOT,
+      :DOUBLE_COLON, :UNDERSCORE, :EMPTY_OPTIONS
+
+    def format_service_check(name, status, opts=EMPTY_OPTIONS)
+      sc_string = "_sc|#{name}|#{status}".dup
+
+      SC_OPT_KEYS.each do |key, shorthand_key|
+        next unless opts[key]
+
+        if key == :tags
+          if tags_string = tags_as_string(opts)
+            sc_string << "|##{tags_string}"
+          end
+        elsif key == :message
+          message = remove_pipes(opts[:message])
+          escaped_message = escape_service_check_message(message)
+          sc_string << "|m:#{escaped_message}"
+        else
+          value = remove_pipes(opts[key])
+          sc_string << "|#{shorthand_key}#{value}"
+        end
+      end
+      sc_string
+    end
+
+    def format_event(title, text, opts=EMPTY_OPTIONS)
       escaped_title = escape_event_content(title)
       escaped_text = escape_event_content(text)
-      event_string_data = "_e{#{escaped_title.length},#{escaped_text.length}}:#{escaped_title}|#{escaped_text}"
+      event_string_data = "_e{#{escaped_title.length},#{escaped_text.length}}:#{escaped_title}|#{escaped_text}".dup
 
       # We construct the string to be sent by adding '|key:value' parts to it when needed
       # All pipes ('|') in the metadata are removed. Title and Text can keep theirs
@@ -355,33 +482,17 @@ module Datadog
         event_string_data << "|##{tags_string}"
       end
 
-      raise "Event #{title} payload is too big (more that 8KB), event discarded" if event_string_data.length > 8192 # 8 * 1024 = 8192
-      return event_string_data
-    end
-
-    # Close the underlying socket
-    def close()
-      @socket.close
+      raise "Event #{title} payload is too big (more that 8KB), event discarded" if event_string_data.length > MAX_EVENT_SIZE
+      event_string_data
     end
 
-    private
-
-    NEW_LINE = "\n".freeze
-    ESC_NEW_LINE = "\\n".freeze
-    COMMA = ",".freeze
-    PIPE = "|".freeze
-    DOT = ".".freeze
-    DOUBLE_COLON = "::".freeze
-    UNDERSCORE = "_".freeze
-    PROCESS_TIME_SUPPORTED = (RUBY_VERSION >= "2.1.0")
-
-    private_constant :NEW_LINE, :ESC_NEW_LINE, :COMMA, :PIPE, :DOT,
-      :DOUBLE_COLON, :UNDERSCORE
-
     def tags_as_string(opts)
-      tag_arr = opts[:tags] || []
-      tag_arr = tag_arr.map { |tag| escape_tag_content(tag) }
-      tag_arr = tags + tag_arr # @tags are normalized when set, so not need to normalize them again
+      if tag_arr = opts[:tags]
+        tag_arr = tag_arr.map { |tag| escape_tag_content(tag) }
+        tag_arr = tags + tag_arr # @tags are normalized when set, so not need to normalize them again
+      else
+        tag_arr = tags
+      end
       tag_arr.join(COMMA) unless tag_arr.empty?
     end
 
@@ -403,10 +514,10 @@ module Datadog
       escape_event_content(msg).gsub('m:'.freeze, 'm\:'.freeze)
     end
 
-    def send_stats(stat, delta, type, opts={})
+    def send_stats(stat, delta, type, opts=EMPTY_OPTIONS)
       sample_rate = opts[:sample_rate] || 1
       if sample_rate == 1 or rand < sample_rate
-        full_stat = ''
+        full_stat = ''.dup
         full_stat << @prefix if @prefix
 
         stat = stat.is_a?(String) ? stat.dup : stat.to_s
@@ -437,62 +548,11 @@ module Datadog
     end
 
     def send_stat(message)
-      if @batch_nesting_depth > 0
-        @buffer << message
-        flush_buffer if @buffer.length >= @max_buffer_size
-      else
-        send_to_socket(message)
-      end
-    end
-
-    def flush_buffer
-      return @buffer if @buffer.empty?
-      send_to_socket(@buffer.join(NEW_LINE))
-      @buffer = Array.new
-    end
-
-    def connect_to_socket
-      if !@socket_path.nil?
-        socket = Socket.new(Socket::AF_UNIX, Socket::SOCK_DGRAM)
-        socket.connect(Socket.pack_sockaddr_un(@socket_path))
-      else
-        socket = UDPSocket.new
-        socket.connect(@host, @port)
-      end
-      socket
-    end
-
-    def sock
-      @socket ||= connect_to_socket
-    end
-
-    def send_to_socket(message)
-      self.class.logger.debug { "Statsd: #{message}" } if self.class.logger
-      if @socket_path.nil?
-        sock.send(message, 0)
+      if @batch.open?
+        @batch.add message
       else
-        sock.sendmsg_nonblock(message)
+        @connection.write(message)
       end
-    rescue => boom
-      if @socket_path && (boom.is_a?(Errno::ECONNREFUSED) ||
-                          boom.is_a?(Errno::ECONNRESET) ||
-                          boom.is_a?(Errno::ENOENT))
-        return @socket = nil
-      end
-      # Try once to reconnect if the socket has been closed
-      retries ||= 1
-      if retries <= 1 && boom.is_a?(IOError) && boom.message =~ /closed stream/i
-        retries += 1
-        begin
-          @socket = connect_to_socket
-          retry
-        rescue => e
-          boom = e
-        end
-      end
-
-      self.class.logger.error { "Statsd: #{boom.class} #{boom}" } if self.class.logger
-      nil
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Rein Henrichs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby DogStastd client
 email: code@datadoghq.com
@@ -33,7 +33,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A Ruby DogStatsd client