dogstatsd-ruby 0.4.0 → 1.1.0

data/README.md

@@ -0,0 +1,72 @@
+
+dogstatsd-ruby
+==============
+
+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)
+
+Quick Start Guide
+-----------------
+
+First install the library:
+
+    gem install dogstatsd-ruby
+
+Then start instrumenting your code:
+
+    # Load the dogstats module.
+    require 'statsd'
+
+    # Create a stats instance.
+    statsd = Statsd.new('localhost', 8125)
+
+    # Increment a counter.
+    statsd.increment('page.views')
+
+    # Record a gauge 50% of the time.
+    statsd.gauge('users.online', 123, :sample_rate=>0.5)
+
+    # Sample a histogram
+    statsd.histogram('file.upload.size', 1234)
+
+    # Time a block of code
+    statsd.time('page.render') do
+      render_page('home.html')
+    end
+
+    # Tag a metric.
+    statsd.histogram('query.time', 10, :tags => ["version:1"])
+
+Documentation
+-------------
+
+Full API documentation is available
+[here](http://www.rubydoc.info/github/DataDog/dogstatsd-ruby/master/frames).
+
+
+Feedback
+--------
+
+To suggest a feature, report a bug, or general discussion, head over
+[here](http://github.com/DataDog/dogstatsd-ruby/issues/).
+
+
+Change Log
+----------
+
+
+- 1.1.0
+    - Added `sets` metrics.
+- 1.0.0
+    - Initial release.
+
+
+Credits
+-------
+
+dogstatsd-ruby is forked from Rien Henrichs [original Statsd
+client](https://github.com/reinh/statsd).
+
+Copyright (c) 2011 Rein Henrichs. See LICENSE.txt for
+further details.

data/lib/statsd.rb

@@ -1,13 +1,14 @@
 require 'socket'
 
-# = Statsd: A Statsd client (https://github.com/etsy/statsd)
+# = Statsd: A DogStatsd client (https://www.datadoghq.com)
 #
-# @example Set up a global Statsd client for a server on localhost:9125
+# @example Set up a global Statsd client for a server on localhost:8125
+#   require 'statsd'
 #   $statsd = Statsd.new 'localhost', 8125
 # @example Send some stats
-#   $statsd.increment 'garets'
-#   $statsd.timing 'glork', 320
-#   $statsd.gauge 'bork', 100
+#   $statsd.increment 'page.views'
+#   $statsd.timing 'page.load', 320
+#   $statsd.gauge 'users.online', 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'
@@ -30,7 +31,7 @@ class Statsd
 
   # Return the current version of the library.
   def self.VERSION
-    "0.4.0"
+    "1.1.0"
   end
 
   # @param [String] host your statsd host
@@ -147,6 +148,18 @@ class Statsd
     timing(stat, ((Time.now - start) * 1000).round, opts)
     result
   end
+  # Sends a value to be tracked as a set to the statsd server.
+  #
+  # @param [String] stat stat name.
+  # @param [Numeric] set 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 Record a unique visitory by id:
+  #   $statsd.set('visitors.uniques', User.id)
+  def set(stat, value, opts={})
+    send_stats stat, value, :s, opts
+  end
 
   private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dogstatsd-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-14 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -81,10 +81,10 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 - lib/statsd.rb
 homepage: http://github.com/datadog/dogstatsd-ruby
 licenses:

data/README.rdoc

@@ -1,36 +0,0 @@
-= 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.