dogstatsd-ruby 0.4.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rein Henrichs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,36 @@
+= dogstatsd-ruby {<img src="https://secure.travis-ci.org/DataDog/dogstatsd-ruby.png"/>}[http://travis-ci.org/DataDog/dogstatsd-ruby]
+
+A Ruby client for DogStatsd, a fork of {Statsd}[https://github.com/etsy/statsd]
+for Datadog. It will work fine for Statsd, but the extra Datadog features will
+not work.
+
+= Installing
+
+Bundler:
+  gem 'dogstatsd-ruby', '~> 0.4.0', github: 'datadog/dogstatsd-ruby', require: 'statsd'
+
+= Testing
+
+Run the specs with <tt>rake spec</tt>
+
+Run the specs and include live integration specs with <tt>LIVE=true rake spec</tt>. Note: This will test over a real UDP socket.
+
+== Contributing to statsd
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Contributors
+
+* Rein Henrichs
+* Ray Krueger
+
+== Copyright
+
+Copyright (c) 2011 Rein Henrichs. See LICENSE.txt for
+further details.

data/lib/statsd.rb

@@ -0,0 +1,171 @@
+require 'socket'
+
+# = Statsd: A Statsd client (https://github.com/etsy/statsd)
+#
+# @example Set up a global Statsd client for a server on localhost:9125
+#   $statsd = Statsd.new 'localhost', 8125
+# @example Send some stats
+#   $statsd.increment 'garets'
+#   $statsd.timing 'glork', 320
+#   $statsd.gauge 'bork', 100
+# @example Use {#time} to time the execution of a block
+#   $statsd.time('account.activate') { @account.activate! }
+# @example Create a namespaced statsd client and increment 'account.activate'
+#   statsd = Statsd.new('localhost').tap{|sd| sd.namespace = 'account'}
+#   statsd.increment 'activate'
+class Statsd
+  # A namespace to prepend to all statsd calls.
+  attr_reader :namespace
+
+  # StatsD host. Defaults to 127.0.0.1.
+  attr_accessor :host
+
+  # StatsD port. Defaults to 8125.
+  attr_accessor :port
+
+  class << self
+    # Set to a standard logger instance to enable debug logging.
+    attr_accessor :logger
+  end
+
+  # Return the current version of the library.
+  def self.VERSION
+    "0.4.0"
+  end
+
+  # @param [String] host your statsd host
+  # @param [Integer] port your statsd port
+  def initialize(host = '127.0.0.1', port = 8125)
+    self.host, self.port = host, port
+    @prefix = nil
+    @socket = UDPSocket.new
+  end
+
+  def namespace=(namespace) #:nodoc:
+    @namespace = namespace
+    @prefix = "#{namespace}."
+  end
+
+  def host=(host) #:nodoc:
+    @host = host || '127.0.0.1'
+  end
+
+  def port=(port) #:nodoc:
+    @port = port || 8125
+  end
+
+  # Sends an increment (count = 1) for the given stat to the statsd server.
+  #
+  # @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
+  # @option opts [Array<String>] :tags An array of tags
+  # @see #count
+  def increment(stat, opts={})
+    count stat, 1, opts
+  end
+
+  # Sends a decrement (count = -1) for the given stat to the statsd server.
+  #
+  # @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
+  # @option opts [Array<String>] :tags An array of tags
+  # @see #count
+  def decrement(stat, opts={})
+    count stat, -1, opts
+  end
+
+  # Sends an arbitrary count for the given stat to the statsd server.
+  #
+  # @param [String] stat stat name
+  # @param [Integer] count count
+  # @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={})
+    send_stats stat, count, :c, opts
+  end
+
+  # Sends an arbitary gauge value for the given stat to the statsd server.
+  #
+  # This is useful for recording things like available disk space,
+  # memory usage, and the like, which have different semantics than
+  # counters.
+  #
+  # @param [String] stat stat name.
+  # @param [Numeric] gauge 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.gauge('user.count', User.count)
+  def gauge(stat, value, opts={})
+    send_stats stat, value, :g, opts
+  end
+
+  # Sends a value to be tracked as a histogram to the statsd server.
+  #
+  # @param [String] stat stat name.
+  # @param [Numeric] histogram 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.histogram('user.count', User.count)
+  def histogram(stat, value, opts={})
+    send_stats stat, value, :h, 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
+  # timing for the stat.
+  #
+  # @param [String] stat stat name
+  # @param [Integer] ms timing in milliseconds
+  # @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={})
+    send_stats stat, ms, :ms, opts
+  end
+
+  # Reports execution time of the provided block using {#timing}.
+  #
+  # @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
+  # @option opts [Array<String>] :tags An array of tags
+  # @yield The operation to be timed
+  # @see #timing
+  # @example Report the time (in ms) taken to activate an account
+  #   $statsd.time('account.activate') { @account.activate! }
+  def time(stat, opts={})
+    start = Time.now
+    result = yield
+    timing(stat, ((Time.now - start) * 1000).round, opts)
+    result
+  end
+
+  private
+
+  def send_stats(stat, delta, type, opts={})
+    sample_rate = opts[:sample_rate] || 1
+    if sample_rate == 1 or rand < sample_rate
+      # Replace Ruby module scoping with '.' and reserved chars (: | @) with underscores.
+      stat = stat.to_s.gsub('::', '.').tr(':|@', '_')
+      rate = "|@#{sample_rate}" unless sample_rate == 1
+      tags = "|##{opts[:tags].join(",")}" if opts[:tags]
+      send_to_socket "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
+    end
+  end
+
+  def send_to_socket(message)
+    self.class.logger.debug { "Statsd: #{message}" } if self.class.logger
+    @socket.send(message, 0, @host, @port)
+  rescue => boom
+    self.class.logger.error { "Statsd: #{boom.class} #{boom}" } if self.class.logger
+    nil
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: dogstatsd-ruby
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Rein Henrichs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby DogStastd client
+email: code@datadoghq.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- LICENSE.txt
+- README.rdoc
+- lib/statsd.rb
+homepage: http://github.com/datadog/dogstatsd-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby DogStatsd client
+test_files: []