dogstatsd-ruby 1.1.0 → 1.2.0

data/README.md

@@ -2,7 +2,7 @@
 dogstatsd-ruby
 ==============
 
-A client for DogStatsd, an extension of the Statsd metric server for Datadog.
+A client for DogStatsD, an extension of the StatsD metric server for Datadog.
 
 [![Build Status](https://secure.travis-ci.org/DataDog/dogstatsd-ruby.png)](http://travis-ci.org/DataDog/dogstatsd-ruby)
 
@@ -56,6 +56,9 @@ Change Log
 ----------
 
 
+- 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

data/lib/statsd.rb

@@ -12,17 +12,26 @@ require 'socket'
 # @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 = Statsd.new 'localhost', 8125, :namespace => 'account'
 #   statsd.increment 'activate'
+# @example Create a statsd client with global tags
+#   statsd = Statsd.new 'localhost', 8125, :tags => 'tag1:true'
 class Statsd
-  # A namespace to prepend to all statsd calls.
+
+  DEFAULT_HOST = '127.0.0.1'
+  DEFAULT_PORT = 8125
+
+  # A namespace to prepend to all statsd calls. Defaults to no namespace.
   attr_reader :namespace
 
   # StatsD host. Defaults to 127.0.0.1.
-  attr_accessor :host
+  attr_reader :host
 
   # StatsD port. Defaults to 8125.
-  attr_accessor :port
+  attr_reader :port
+
+  # Global tags to be added to every statsd call. Defaults to no tags.
+  attr_reader :tags
 
   class << self
     # Set to a standard logger instance to enable debug logging.
@@ -31,20 +40,24 @@ class Statsd
 
   # Return the current version of the library.
   def self.VERSION
-    "1.1.0"
+    "1.2.0"
   end
 
   # @param [String] host your statsd host
   # @param [Integer] port your statsd port
-  def initialize(host = '127.0.0.1', port = 8125)
+  # @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 = {})
     self.host, self.port = host, port
     @prefix = nil
     @socket = UDPSocket.new
+    self.namespace = opts[:namespace]
+    self.tags = opts[:tags]
   end
 
   def namespace=(namespace) #:nodoc:
     @namespace = namespace
-    @prefix = "#{namespace}."
+    @prefix = namespace.nil? ? nil : "#{namespace}."
   end
 
   def host=(host) #:nodoc:
@@ -55,6 +68,10 @@ class Statsd
     @port = port || 8125
   end
 
+  def tags=(tags) #:nodoc:
+    @tags = tags || []
+  end
+
   # Sends an increment (count = 1) for the given stat to the statsd server.
   #
   # @param [String] stat stat name
@@ -169,7 +186,8 @@ class Statsd
       # 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]
+      ts = (tags || []) + (opts[:tags] || [])
+      tags = "|##{ts.join(",")}" unless ts.empty?
       send_to_socket "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2013-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby DogStatsd client