dogstatsd-ruby 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4665c5b55192d3bc2f1de27b2cc81df9748eeca
-  data.tar.gz: 351ec7404305f80ac0b9403b38a1f10a94193d10
+  metadata.gz: b0f070d540d99ad6add1d56aedfdf89c890daf09
+  data.tar.gz: 21e970d92ceed9401b6dc2ee7764b4c27ef048ee
 SHA512:
-  metadata.gz: 9c3bb2e7fac98f10750b09ed3ae280985e4583bdd5e5b98c3f2ca5d873954a77ff6935c952692c49da5a1a1b369c5f24502addec490b9f87c09f4270136e8819
-  data.tar.gz: 3e64ff5a075ad90b55b8c6361de840c7f99fc584a670fc68c019aa0d84663d47bc4937b1b86d6caeb5e3291803ed96bb09f3f1ed5c04abcc8df6ab22d5361f41
+  metadata.gz: c1bb32bc03a081aafd9b2ac73c9b945206939c929b77ae48b571d229e8483866c45454c876c727cbff34b4bc5380d84002439254e7a1b1753c1aa63a4af45a5b
+  data.tar.gz: 6382f5a8374da2c09b5b27eab65062b2ca68ea3322fa03377e7183c916a8afd4816ced7ce9a7d5f6743dd5234f2d23413eaf88b9bcbf3cb6724d2bbaf9ab4b53

data/README.md

@@ -75,22 +75,8 @@ To suggest a feature, report a bug, or general discussion, head over
 [here](http://github.com/DataDog/dogstatsd-ruby/issues/).
 
 
-Change Log
-----------
-
-- 1.4.1
-    - Fixed bug in message separator when batching metrics
-- 1.4.0
-    - Added support for metrics batching
-- 1.3.0
-    - Added support for submitting events.
-- 1.2.0
-    - Added global tags.
-    - Added ability to set `namespace` and `tags` from `Statsd#initialize`.
-- 1.1.0
-    - Added `sets` metrics.
-- 1.0.0
-    - Initial release.
+[Change Log](CHANGELOG.md)
+----------------------------
 
 
 Credits

data/lib/statsd.rb

@@ -32,6 +32,18 @@ class Statsd
         ['alert_type', 't']
   ]
 
+  # Service check options
+  SC_OPT_KEYS = [
+        ['timestamp', 'd:'],
+        ['hostname', 'h:'],
+        ['tags', '#'],
+        ['message', 'm:']
+  ]
+  OK        = 0
+  WARNING   = 1
+  CRITICAL  = 2
+  UNKNOWN   = 3
+
   # A namespace to prepend to all statsd calls. Defaults to no namespace.
   attr_reader :namespace
 
@@ -57,7 +69,7 @@ class Statsd
 
   # Return the current version of the library.
   def self.VERSION
-    "1.4.1"
+    "1.5.0"
   end
 
   # @param [String] host your statsd host
@@ -72,7 +84,7 @@ class Statsd
     self.tags = opts[:tags]
     @buffer = Array.new
     self.max_buffer_size = max_buffer_size
-    alias :send :send_to_socket
+    alias :send_stat :send_to_socket
   end
 
   def namespace=(namespace) #:nodoc:
@@ -171,6 +183,9 @@ class Statsd
 
   # Reports execution time of the provided block using {#timing}.
   #
+  # If the block fails, the stat is still reported, then the error
+  # is reraised
+  #
   # @param [String] stat stat name
   # @param [Hash] opts the options to create the metric with
   # @option opts [Numeric] :sample_rate sample rate, 1 for always
@@ -182,8 +197,11 @@ class Statsd
   def time(stat, opts={})
     start = Time.now
     result = yield
-    timing(stat, ((Time.now - start) * 1000).round, opts)
+    time_since(stat, start, opts)
     result
+  rescue
+    time_since(stat, start, opts)
+    raise
   end
   # Sends a value to be tracked as a set to the statsd server.
   #
@@ -198,6 +216,49 @@ class Statsd
     send_stats stat, value, :s, opts
   end
 
+
+  # This method allows you to send custom service check statuses.
+  #
+  # @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 [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
+  #   $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 |name_key|
+      if opts[name_key[0].to_sym]
+        if name_key[0] == 'tags'
+          tags = opts[:tags]
+          tags.each do |tag|
+            rm_pipes tag
+          end
+          tags = "#{tags.join(",")}" unless tags.empty?
+          sc_string << "|##{tags}"
+        elsif name_key[0] == 'message'
+          message = opts[:message]
+          rm_pipes message
+          escape_service_check_message message
+          sc_string << "|m:#{message}"
+        else
+          value = opts[name_key[0].to_sym]
+          rm_pipes value
+          sc_string << "|#{name_key[1]}#{value}"
+        end
+      end
+    end
+    return sc_string
+  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.
   #
   # Aggregation in the stream is made on hostname/event_type/source_type/aggregation_key.
@@ -207,13 +268,13 @@ class Statsd
   # @param [String] title Event title
   # @param [String] text Event text. Supports \n
   # @param [Hash] opts the additional data about the event
-  # @option opts [Time, nil] :date_happened (nil) Assign a timestamp to the event. Default is now when none
+  # @option opts [Integer, 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"
   # @option opts [String, nil] :source_type_name (nil) Assign a source type to the event
   # @option opts [String, nil] :alert_type ('info') Can be "error", "warning", "info" or "success".
-  # @option opts [Array<String>, nil] :source_type_name (nil) An array of tags
+  # @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={})
@@ -232,10 +293,10 @@ class Statsd
   #      s.increment('page.views')
   #    end
   def batch()
-    alias :send :send_to_buffer
+    alias :send_stat :send_to_buffer
     yield self
     flush_buffer
-    alias :send :send_to_socket
+    alias :send_stat :send_to_socket
   end
 
   def format_event(title, text, opts={})
@@ -244,7 +305,7 @@ class Statsd
     event_string_data = "_e{#{title.length},#{text.length}}:#{title}|#{text}"
 
     # We construct the string to be sent by adding '|key:value' parts to it when needed
-    # All pipes ('|') in the metada are removed. Title and Text can keep theirs
+    # All pipes ('|') in the metadata are removed. Title and Text can keep theirs
     OPTS_KEYS.each do |name_key|
       if name_key[0] != 'tags' && opts[name_key[0].to_sym]
         value = opts[name_key[0].to_sym]
@@ -252,25 +313,36 @@ class Statsd
         event_string_data << "|#{name_key[1]}:#{value}"
       end
     end
-    tags = opts[:tags] || nil
+    full_tags = tags + (opts[:tags] || [])
     # Tags are joined and added as last part to the string to be sent
-    if tags
-      tags.each do |tag|
+    unless full_tags.empty?
+      full_tags.each do |tag|
         rm_pipes tag
       end
-      tags = "#{tags.join(",")}" unless tags.empty?
-      event_string_data << "|##{tags}"
+      event_string_data << "|##{full_tags.join(',')}"
     end
 
     raise "Event #{title} payload is too big (more that 8KB), event discarded" if event_string_data.length > 8 * 1024
     return event_string_data
   end
+
   private
+
   def escape_event_content(msg)
-    msg = msg.sub! "\n", "\\n"
+    msg.gsub! "\n", "\\n"
   end
+
   def rm_pipes(msg)
-    msg = msg.sub! "|", ""
+    msg.gsub! "|", ""
+  end
+
+  def escape_service_check_message(msg)
+    msg.gsub! 'm:', 'm\:'
+    msg.gsub! "\n", "\\n"
+  end
+
+  def time_since(stat, start, opts)
+    timing(stat, ((Time.now - start) * 1000).round, opts)
   end
 
   def send_stats(stat, delta, type, opts={})
@@ -281,7 +353,7 @@ class Statsd
       rate = "|@#{sample_rate}" unless sample_rate == 1
       ts = (tags || []) + (opts[:tags] || [])
       tags = "|##{ts.join(",")}" unless ts.empty?
-      send "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
+      send_stat "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Rein Henrichs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -102,4 +102,3 @@ signing_key:
 specification_version: 4
 summary: A Ruby DogStatsd client
 test_files: []
-has_rdoc: