dogstatsd-ruby 3.0.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58a9207adf16ba8265e91fd56b6315b35ecc9b58
-  data.tar.gz: 9fc64d84a4b0277752bad6a5b523f1ab1ac989c2
+SHA256:
+  metadata.gz: 046a0af9f230451c91fdeb9ae128c550b1c20623fa017d326e63a2f053f7cc9a
+  data.tar.gz: e2ba838497de521e89d386645a0228f819fdd03c28acc05a4789aa7f8d979de8
 SHA512:
-  metadata.gz: 89574d06e8d66f00a203d6d84b9e20f70b1d64e90fd2dfa644bdab8993a0420065b2e426d574fc0c0239fc69f49a65b0d215359c50ec2fd00dd9b9214f8c9f13
-  data.tar.gz: d97dc13266fe51bc7d49ebb8e56235aef70a6773e89d890ffe4774e0406489f6a7fadb43818f1000fc70f7520d6baec19d05b395c732cce9ea22ef9107597de9
+  metadata.gz: f2048376477bd1af31a63b75d17638df999c9f6341f967b2c826177add2a13831a54a72729e2a5c62aa09fa4aca6dccbaba308c79d9adcd470808d3bb80cde59
+  data.tar.gz: 2e0ac5fc90f8a2359f35a754034bb6474c1169ac8c8f3301257555553e1aca4f708cecd4d9245ff835cbe4396561a89d3bd3700ef6cea6c92c343a1e41ca2055

data/lib/datadog/statsd.rb

@@ -49,8 +49,10 @@ module Datadog
     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
 
     # A namespace to prepend to all statsd calls. Defaults to no namespace.
     attr_reader :namespace
@@ -61,13 +63,12 @@ module Datadog
     # 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
 
-    # True if we should batch up data before sending it, or false if we
-    # want to send data immediately.
-    attr_reader :should_batch
-
     # Buffer containing the statsd message before they are sent in batch
     attr_reader :buffer
 
@@ -80,8 +81,9 @@ module Datadog
     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
-      "3.0.0"
+      VERSION
     end
 
     # @param [String] host your statsd host
@@ -90,13 +92,14 @@ module Datadog
     # @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(host, port)
+      @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
-      @should_batch = false
+      @batch_nesting_depth = 0
     end
 
     def namespace=(namespace) #:nodoc:
@@ -114,7 +117,7 @@ module Datadog
 
     def tags=(tags) #:nodoc:
       raise ArgumentError, 'tags must be a Array<String>' unless tags.nil? or tags.is_a? Array
-      @tags = (tags || []).map {|tag| escape_tag_content(tag)}
+      @tags = (tags || []).compact.map! {|tag| escape_tag_content(tag)}
     end
 
     # Sends an increment (count = 1) for the given stat to the statsd server.
@@ -126,6 +129,7 @@ module Datadog
     # @option opts [Numeric] :by increment value, default 1
     # @see #count
     def increment(stat, opts={})
+      opts = {:sample_rate => opts} if opts.is_a? Numeric
       incr_value = opts.fetch(:by, 1)
       count stat, incr_value, opts
     end
@@ -139,6 +143,7 @@ module Datadog
     # @option opts [Numeric] :by decrement value, default 1
     # @see #count
     def decrement(stat, opts={})
+      opts = {:sample_rate => opts} if opts.is_a? Numeric
       decr_value = - opts.fetch(:by, 1)
       count stat, decr_value, opts
     end
@@ -151,6 +156,7 @@ module Datadog
     # @option opts [Numeric] :sample_rate sample rate, 1 for always
     # @option opts [Array<String>] :tags An array of tags
     def count(stat, count, opts={})
+      opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, count, COUNTER_TYPE, opts
     end
 
@@ -168,6 +174,7 @@ module Datadog
     # @example Report the current user count:
     #   $statsd.gauge('user.count', User.count)
     def gauge(stat, value, opts={})
+      opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, value, GAUGE_TYPE, opts
     end
 
@@ -184,6 +191,22 @@ module Datadog
       send_stats stat, value, HISTOGRAM_TYPE, opts
     end
 
+    # Sends a value to be tracked as a distribution to the statsd server.
+    # Note: Distributions are a beta feature of Datadog and not generally
+    # available. Distributions must be specifically enabled for your
+    # organization.
+    #
+    # @param [String] stat stat name.
+    # @param [Numeric] value distribution value.
+    # @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
+    # @example Report the current user count:
+    #   $statsd.distribution('user.count', User.count)
+    def distribution(stat, value, opts={})
+      send_stats stat, value, DISTRIBUTION_TYPE, opts
+    end
+
     # Sends a timing (in ms) for the given stat to the statsd server. The
     # sample_rate determines what percentage of the time this report is sent. The
     # statsd server then uses the sample_rate to correctly track the average
@@ -195,6 +218,7 @@ module Datadog
     # @option opts [Numeric] :sample_rate sample rate, 1 for always
     # @option opts [Array<String>] :tags An array of tags
     def timing(stat, ms, opts={})
+      opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, ms, TIMING_TYPE, opts
     end
 
@@ -212,10 +236,12 @@ module Datadog
     # @example Report the time (in ms) taken to activate an account
     #   $statsd.time('account.activate') { @account.activate! }
     def time(stat, opts={})
-      start = Time.now
+      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
     ensure
-      time_since(stat, start, opts)
+      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.
     #
@@ -227,10 +253,10 @@ module Datadog
     # @example Record a unique visitory by id:
     #   $statsd.set('visitors.uniques', User.id)
     def set(stat, value, opts={})
+      opts = {:sample_rate => opts} if opts.is_a? Numeric
       send_stats stat, value, SET_TYPE, opts
     end
 
-
     # This method allows you to send custom service check statuses.
     #
     # @param [String] name Service check name
@@ -254,9 +280,9 @@ module Datadog
         next unless opts[key]
 
         if key == :tags
-          tags = opts[:tags].map {|tag| escape_tag_content(tag) }
-          tags = "#{tags.join(COMMA)}" unless tags.empty?
-          sc_string << "|##{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)
@@ -303,11 +329,11 @@ module Datadog
     #      s.increment('page.views')
     #    end
     def batch()
-      @should_batch = true
+      @batch_nesting_depth += 1
       yield self
-      flush_buffer
     ensure
-      @should_batch = false
+      @batch_nesting_depth -= 1
+      flush_buffer if @batch_nesting_depth == 0
     end
 
     def format_event(title, text, opts={})
@@ -325,9 +351,8 @@ module Datadog
       end
 
       # Tags are joined and added as last part to the string to be sent
-      full_tags = (tags + (opts[:tags] || [])).map {|tag| escape_tag_content(tag) }
-      unless full_tags.empty?
-        event_string_data << "|##{full_tags.join(COMMA)}"
+      if tags_string = tags_as_string(opts)
+        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
@@ -344,48 +369,40 @@ module Datadog
     NEW_LINE = "\n".freeze
     ESC_NEW_LINE = "\\n".freeze
     COMMA = ",".freeze
-    BLANK = "".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, :BLANK, :PIPE, :DOT,
+    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
+      tag_arr.join(COMMA) unless tag_arr.empty?
+    end
+
     def escape_event_content(msg)
       msg.gsub NEW_LINE, ESC_NEW_LINE
     end
 
     def escape_tag_content(tag)
-      remove_pipes(tag).gsub COMMA, BLANK
-    end
-
-    def escape_tag_content!(tag)
-      tag.gsub!(PIPE, BLANK)
-      tag.gsub!(COMMA, BLANK)
+      tag = remove_pipes(tag.to_s)
+      tag.delete! COMMA
       tag
     end
 
     def remove_pipes(msg)
-      msg.gsub PIPE, BLANK
+      msg.delete PIPE
     end
 
     def escape_service_check_message(msg)
       escape_event_content(msg).gsub('m:'.freeze, 'm\:'.freeze)
     end
 
-    def time_since(stat, start, opts)
-      timing(stat, ((Time.now - start) * 1000).round, opts)
-    end
-
-    def join_array_to_str(str, array, joiner)
-      array.each_with_index do |item, i|
-        str << joiner unless i == 0
-        str << item
-      end
-    end
-
     def send_stats(stat, delta, type, opts={})
       sample_rate = opts[:sample_rate] || 1
       if sample_rate == 1 or rand < sample_rate
@@ -409,14 +426,10 @@ module Datadog
           full_stat << sample_rate.to_s
         end
 
-
-        tag_arr = opts[:tags].to_a
-        tag_arr.map! { |tag| t = tag.dup; escape_tag_content!(t); t }
-        ts = tags.to_a + tag_arr
-        unless ts.empty?
+        if tags_string = tags_as_string(opts)
           full_stat << PIPE
           full_stat << '#'.freeze
-          join_array_to_str(full_stat, ts, COMMA)
+          full_stat << tags_string
         end
 
         send_stat(full_stat)
@@ -424,7 +437,7 @@ module Datadog
     end
 
     def send_stat(message)
-      if @should_batch
+      if @batch_nesting_depth > 0
         @buffer << message
         flush_buffer if @buffer.length >= @max_buffer_size
       else
@@ -432,27 +445,46 @@ module Datadog
       end
     end
 
-    def flush_buffer()
+    def flush_buffer
+      return @buffer if @buffer.empty?
       send_to_socket(@buffer.join(NEW_LINE))
       @buffer = Array.new
     end
 
-    def connect_to_socket(host, port)
-      socket = UDPSocket.new
-      socket.connect(host, port)
+    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
-      @socket.send(message, 0)
+      if @socket_path.nil?
+        sock.send(message, 0)
+      else
+        sock.sendmsg_nonblock(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(host, port)
+          @socket = connect_to_socket
           retry
         rescue => e
           boom = e

metadata

@@ -1,71 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Rein Henrichs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2018-02-04 00:00:00.000000000 Z
+dependencies: []
 description: A Ruby DogStastd client
 email: code@datadoghq.com
 executables: []
@@ -97,9 +41,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.1
 signing_key: 
 specification_version: 4
 summary: A Ruby DogStatsd client
 test_files: []
-has_rdoc: