dogstatsd-ruby 1.3.0 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93021b35d28b353f50ffd4e6c27b5dfe3881f6a1
+  data.tar.gz: 15f63c6b4b48b5947029863633a0f3859ec932df
+SHA512:
+  metadata.gz: 8a5110a43772bd0c4d02d04a9b501c01da66c10f0c17ed3afd3e8bea0585418fce5ecc8f5026f115fc4d6a53e46e488d4e9d286a491fbbf90fe8206e80063516
+  data.tar.gz: db4ded7c2533b144275edb923abccc69456ed07984bda0dc7f480b40af0c6aa27acc19925255ef40ab92fa5e5f9261947fae865bd56102b6f1a5c2c74bc9b32f

data/README.md

@@ -36,10 +36,31 @@ statsd.time('page.render') do
   render_page('home.html')
 end
 
+# Send several metrics at the same time
+# All metrics will be buffered and sent in one packet when the block completes
+statsd.batch do |s|
+  s.increment('page.views')
+  s.gauge('users.online', 123)
+end
+
 # Tag a metric.
 statsd.histogram('query.time', 10, :tags => ["version:1"])
 ```
 
+You can also post events to your 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.
+
+``` ruby
+# Post a simple message
+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"])
+```
+
+
+
 Documentation
 -------------
 
@@ -57,6 +78,8 @@ To suggest a feature, report a bug, or general discussion, head over
 Change Log
 ----------
 
+- 1.4.0
+    - Added support for metrics batching
 - 1.3.0
     - Added support for submitting events.
 - 1.2.0

data/lib/statsd.rb

@@ -44,6 +44,12 @@ class Statsd
   # 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
+
   class << self
     # Set to a standard logger instance to enable debug logging.
     attr_accessor :logger
@@ -51,19 +57,22 @@ class Statsd
 
   # Return the current version of the library.
   def self.VERSION
-    "1.3.0"
+    "1.4.0"
   end
 
   # @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 = {})
+  def initialize(host = DEFAULT_HOST, port = DEFAULT_PORT, opts = {}, max_buffer_size=50)
     self.host, self.port = host, port
     @prefix = nil
     @socket = UDPSocket.new
     self.namespace = opts[:namespace]
     self.tags = opts[:tags]
+    @buffer = Array.new
+    self.max_buffer_size = max_buffer_size
+    alias :send :send_to_socket
   end
 
   def namespace=(namespace) #:nodoc:
@@ -205,7 +214,7 @@ class Statsd
   # @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
-  # @example Report an aweful event:
+  # @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)
@@ -213,6 +222,22 @@ class Statsd
 
     send_to_socket event_string
   end
+
+  # Send several metrics in the same UDP Packet
+  # They will be buffered and flushed when the block finishes
+  #
+  # @example Send several metrics in one packet:
+  #   $statsd.batch do |s|
+  #      s.gauge('users.online',156)
+  #      s.increment('page.views')
+  #    end
+  def batch()
+    alias :send :send_to_buffer
+    yield self
+    flush_buffer
+    alias :send :send_to_socket
+  end
+
   def format_event(title, text, opts={})
     escape_event_content title
     escape_event_content text
@@ -256,10 +281,22 @@ class Statsd
       rate = "|@#{sample_rate}" unless sample_rate == 1
       ts = (tags || []) + (opts[:tags] || [])
       tags = "|##{ts.join(",")}" unless ts.empty?
-      send_to_socket "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
+      send "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
     end
   end
 
+  def send_to_buffer(message)
+    @buffer << message
+    if @buffer.length >= @max_buffer_size
+      flush_buffer
+    end
+  end
+
+  def flush_buffer()
+    send_to_socket(@buffer.join('\n'))
+    @buffer = Array.new
+  end
+
   def send_to_socket(message)
     self.class.logger.debug { "Statsd: #{message}" } if self.class.logger
     @socket.send(message, 0, @host, @port)

metadata

@@ -1,126 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 1
-  - 3
-  - 0
-  version: 1.3.0
+version: !ruby/object:Gem::Version
+  version: 1.4.0
 platform: ruby
-authors: 
+authors:
 - Rein Henrichs
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-03-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 6
-        - 0
+  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
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 8
-        version: "1.8"
+  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
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  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 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby DogStastd client
 email: code@datadoghq.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
+files:
 - LICENSE.txt
 - README.md
 - lib/statsd.rb
 homepage: http://github.com/datadog/dogstatsd-ruby
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby DogStatsd client
 test_files: []
-
+has_rdoc: