dogstatsd-ruby 4.2.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e8d0982550cf2f3e3dddee6eee8dcf88534ccf4e26ef47731c2866b85e81f2
-  data.tar.gz: 8f9d33a02a6b86e343144c98511e243a65bdaeb2f881ae00cd7842528158f3f6
+  metadata.gz: 25baf4b0dc57e8ed9a79bd2115224f22de9097200ccf4931b54fbb1e40905363
+  data.tar.gz: a51c91dc366316b6edbadc64eb5e7383b6b100c9a2a859eb9bc31b9bef9ec7e2
 SHA512:
-  metadata.gz: 68e6cc9c4bbbbffa546eaefd643785ca945ae00dfd03d84d5984262d0061f25b059c325063220fd15bdd354d6ec721ba7d50ad7b7c2310d2b64c24b49314ba36
-  data.tar.gz: c070c0fd60a513b3c89a8eff5c4c755e38b5d646529840adca886a52651831f7bef1bdf437723329237f1faf4066960bee32ae5e5b6b9f4ddeb1eb69bfb87afe
+  metadata.gz: 225ef009dcb475534ec746d9eaa6e8b156ad7b50291c2894ba9171806bc91231150510a65a47ec754dbf519f80fe7381c589d34f35e983519fb8e991347e1a12
+  data.tar.gz: e8609033506332625db4a6655adceacfb7fd1b85346020c1582dd032815ea56158d46442cecafd40fdd7bf098745e41ab1e70323b323ff63dd8bb43be3be8b88

data/README.md

@@ -28,9 +28,10 @@ statsd = Datadog::Statsd.new('localhost', 8125)
 
 # Increment a counter.
 statsd.increment('page.views')
+statsd.increment('messages.count', by: 2, tags: ['kind:incoming'])
 
 # Record a gauge 50% of the time.
-statsd.gauge('users.online', 123, :sample_rate=>0.5)
+statsd.gauge('users.online', 123, sample_rate: 0.5)
 
 # Sample a histogram
 statsd.histogram('file.upload.size', 1234)
@@ -48,7 +49,10 @@ statsd.batch do |s|
 end
 
 # Tag a metric.
-statsd.histogram('query.time', 10, :tags => ["version:1"])
+statsd.histogram('query.time', 10, tags: ['version:1'])
+
+# Tag a metric by passing in a Hash
+statsd.histogram('query.time', 10, :tags => {version: 1})
 
 # Auto-close socket after end of block
 Datadog::Statsd.open('localhost', 8125) do |s|
@@ -62,14 +66,34 @@ Aggregation in the stream is made on hostname/event_type/source_type/aggregation
 
 ``` ruby
 # Post a simple message
-statsd.event("There might be a storm tomorrow", "A friend warned me earlier.")
+statsd.event('There might be a storm tomorrow', 'A friend warned me earlier.')
 
 # Cry for help
-statsd.event("SO MUCH SNOW", "Started yesterday and it won't stop !!", :alert_type => "error", :tags => ["urgent", "endoftheworld"])
+statsd.event(
+  'SO MUCH SNOW',
+  "Started yesterday and it won't stop !!",
+  alert_type: 'error',
+  tags: ['urgent', 'endoftheworld']
+)
 ```
 
 
 
+Origin detection over UDP
+-------------
+Origin detection is a method to detect which pod DogStatsD packets are coming from in order to add the pod's tags to the tag list.
+
+To enable origin detection over UDP, add the following lines to your application manifest
+```yaml
+env:
+  - name: DD_ENTITY_ID
+    valueFrom:
+      fieldRef:
+        fieldPath: metadata.uid
+```
+The DogStatsD client attaches an internal tag, `entity_id`. The value of this tag is the content of the `DD_ENTITY_ID` environment variable, which is the pod’s UID.
+
+
 Documentation
 -------------
 

data/lib/datadog/statsd.rb

@@ -33,32 +33,15 @@ module Datadog
       # DogStatsd unix socket path. Not used by default.
       attr_reader :socket_path
 
-      def initialize(host, port, socket_path, logger)
-        @host = host || ENV.fetch('DD_AGENT_HOST', nil) || DEFAULT_HOST
-        @port = port || ENV.fetch('DD_DOGSTATSD_PORT', nil) || DEFAULT_PORT
-        @socket_path = socket_path
-        @logger = logger
+      # Close the underlying socket
+      def close
+        @socket && @socket.close
       end
 
       def write(message)
         @logger.debug { "Statsd: #{message}" } if @logger
-        if @socket_path.nil?
-          socket.send(message, 0)
-        else
-          socket.sendmsg_nonblock(message)
-        end
+        send_message(message)
       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?(Errno::ENOTCONN) or
@@ -76,27 +59,55 @@ module Datadog
         nil
       end
 
-      # Close the underlying socket
-      def close
-        @socket && @socket.close
-      end
-
       private
 
       def socket
         @socket ||= connect
       end
+    end
+
+    class UDPConnection < Connection
+      def initialize(host, port, logger)
+        @host = host || ENV.fetch('DD_AGENT_HOST', nil) || DEFAULT_HOST
+        @port = port || ENV.fetch('DD_DOGSTATSD_PORT', nil) || DEFAULT_PORT
+        @logger = logger
+      end
+
+      private
 
       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 = UDPSocket.new
+        socket.connect(@host, @port)
+        socket
+      end
+
+      def send_message(message)
+        socket.send(message, 0)
+      end
+    end
+
+    class UDSConnection < Connection
+      class BadSocketError < StandardError; end
+
+      def initialize(socket_path, logger)
+        @socket_path = socket_path
+        @logger = logger
+      end
+
+      private
+
+      def connect
+        socket = Socket.new(Socket::AF_UNIX, Socket::SOCK_DGRAM)
+        socket.connect(Socket.pack_sockaddr_un(@socket_path))
         socket
       end
+
+      def send_message(message)
+        socket.sendmsg_nonblock(message)
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ENOENT => e
+        @socket = nil
+        raise BadSocketError, "#{e.class}: #{e}"
+      end
     end
 
     class Batch
@@ -181,7 +192,7 @@ module Datadog
     DISTRIBUTION_TYPE = 'd'.freeze
     TIMING_TYPE = 'ms'.freeze
     SET_TYPE = 's'.freeze
-    VERSION = "4.2.0".freeze
+    VERSION = "4.4.0".freeze
 
     # A namespace to prepend to all statsd calls. Defaults to no namespace.
     attr_reader :namespace
@@ -195,16 +206,20 @@ module Datadog
     # Maximum buffer size in bytes before it is flushed
     attr_reader :max_buffer_bytes
 
+    # Default sample rate
+    attr_reader :sample_rate
+
     # Connection
     attr_reader :connection
 
     # @param [String] host your statsd host
     # @param [Integer] port your statsd port
     # @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 [Array<String>|Hash] tags tags to be added to every metric
+    # @option [Logger] logger for debugging
     # @option [Integer] max_buffer_bytes max bytes to buffer when using #batch
     # @option [String] socket_path unix socket path
+    # @option [Float] default sample rate if not overridden
     def initialize(
       host = nil,
       port = nil,
@@ -212,15 +227,26 @@ module Datadog
       tags: nil,
       max_buffer_bytes: 8192,
       socket_path: nil,
-      logger: nil
+      logger: nil,
+      sample_rate: nil
     )
-      @connection = Connection.new(host, port, socket_path, logger)
+      if socket_path.nil?
+        @connection = UDPConnection.new(host, port, logger)
+      else
+        @connection = UDSConnection.new(socket_path, logger)
+      end
       @logger = logger
 
       @namespace = namespace
       @prefix = @namespace ? "#{@namespace}.".freeze : nil
 
-      raise ArgumentError, 'tags must be a Array<String>' unless tags.nil? or tags.is_a? Array
+      @sample_rate = sample_rate
+
+      unless tags.nil? or tags.is_a? Array or tags.is_a? Hash
+        raise ArgumentError, 'tags must be a Array<String> or a Hash'
+      end
+
+      tags = tag_hash_to_array(tags) if tags.is_a? Hash
       @tags = (tags || []).compact.map! {|tag| escape_tag_content(tag)}
 
       # append the entity id to tags if DD_ENTITY_ID env var is not nil
@@ -381,8 +407,8 @@ module Datadog
     # @param [String] name Service check name
     # @param [String] status Service check status.
     # @param [Hash] opts the additional data about the service check
-      # @option opts [Integer, nil] :timestamp (nil) Assign a timestamp to the event. Default is now when none
-      # @option opts [String, nil] :hostname (nil) Assign a hostname to the event.
+      # @option opts [Integer, String, nil] :timestamp (nil) Assign a timestamp to the service check. Default is now when none
+      # @option opts [String, nil] :hostname (nil) Assign a hostname to the service check.
       # @option opts [Array<String>, nil] :tags (nil) An array of tags
       # @option opts [String, nil] :message (nil) A message to associate with this service check status
     # @example Report a critical service check status
@@ -398,9 +424,9 @@ module Datadog
     # it will be grouped with other events that don't have an event type.
     #
     # @param [String] title Event title
-    # @param [String] text Event text. Supports \n
+    # @param [String] text Event text. Supports newlines (+\n+)
     # @param [Hash] opts the additional data about the event
-    # @option opts [Integer, nil] :date_happened (nil) Assign a timestamp to the event. Default is now when none
+    # @option opts [Integer, String, nil] :date_happened (nil) Assign a timestamp to the event. Default is now when none
     # @option opts [String, nil] :hostname (nil) Assign a hostname to the event.
     # @option opts [String, nil] :aggregation_key (nil) Assign an aggregation key to the event, to group it with some others
     # @option opts [String, nil] :priority ('normal') Can be "normal" or "low"
@@ -460,7 +486,11 @@ module Datadog
           escaped_message = escape_service_check_message(message)
           sc_string << "|m:#{escaped_message}"
         else
-          value = remove_pipes(opts[key])
+          if key == :timestamp && opts[key].is_a?(Integer)
+            value = opts[key]
+          else
+            value = remove_pipes(opts[key])
+          end
           sc_string << "|#{shorthand_key}#{value}"
         end
       end
@@ -470,13 +500,20 @@ module Datadog
     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}".dup
+      event_string_data = "_e{#{escaped_title.bytesize},#{escaped_text.bytesize}}:#{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
       OPTS_KEYS.each do |key, shorthand_key|
         if key != :tags && opts[key]
-          value = remove_pipes(opts[key])
+          # :date_happened is the only key where the value is an Integer
+          # To not break backwards compatibility, we still accept a String
+          if key == :date_happened && opts[key].is_a?(Integer)
+              value = opts[key]
+          # All other keys only have String values
+          else
+              value = remove_pipes(opts[key])
+          end
           event_string_data << "|#{shorthand_key}:#{value}"
         end
       end
@@ -486,12 +523,13 @@ 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 > MAX_EVENT_SIZE
+      raise "Event #{title} payload is too big (more that 8KB), event discarded" if event_string_data.bytesize > MAX_EVENT_SIZE
       event_string_data
     end
 
     def tags_as_string(opts)
       if tag_arr = opts[:tags]
+        tag_arr = tag_hash_to_array(tag_arr) if tag_arr.is_a? Hash
         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
@@ -500,6 +538,10 @@ module Datadog
       tag_arr.join(COMMA) unless tag_arr.empty?
     end
 
+    def tag_hash_to_array(tag_hash)
+      tag_hash.to_a.map {|pair| pair.compact.join(":")}
+    end
+
     def escape_event_content(msg)
       msg.gsub NEW_LINE, ESC_NEW_LINE
     end
@@ -519,8 +561,8 @@ module Datadog
     end
 
     def send_stats(stat, delta, type, opts=EMPTY_OPTIONS)
-      sample_rate = opts[:sample_rate] || 1
-      if sample_rate == 1 or rand < sample_rate
+      sample_rate = opts[:sample_rate] || @sample_rate || 1
+      if sample_rate == 1 or rand <= sample_rate
         full_stat = ''.dup
         full_stat << @prefix if @prefix
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Rein Henrichs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-07-15 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby DogStastd client
 email: code@datadoghq.com
@@ -40,7 +40,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Ruby DogStatsd client