statsd-rb 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Matt Duncan
+
+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.md

@@ -0,0 +1,52 @@
+statsd-rb
+=========
+A ruby client for [StatsD](https://github.com/etsy/statsd).
+
+Usage
+-----
+Connecting to a StatsD instance:
+
+    require "statsd"
+    client = StatsD::Client.new
+
+By default, clients will connect to `localhost:8125`.  If you need to
+connect to a remote server or a different port, use the `:hostname` and
+`:port` options.
+
+    client = StatsD::Client.new(:hostname => "statsd", :port => 5000)
+
+### Commands
+Once you have a client, sending statistics is easy.
+
+Increment the downloads count:
+
+    client.incr :downloads
+
+Increment the downloads count, telling StatsD that the counter is being
+sampled every 10th time.  All commands take an optional last argument
+`sample_rate`.
+
+    client.incr :downloads, 0.1
+
+Decrement the invites count by two:
+
+    client.decrby :invites, 2
+
+Time the archive job:
+
+    client.time :archive do
+      # something
+    end
+
+Send an already calculated timing:
+
+    client.timing :archive, 300  # milliseconds
+
+TODO
+----
+
+- Bulk updating
+
+Author
+------
+Matt Duncan | [mattduncan.org](http://mattduncan.org) | [matt@mattduncan.org](mailto:matt@mattduncan.org)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end

data/lib/statsd.rb

@@ -0,0 +1 @@
+require 'statsd/client'

data/lib/statsd/client.rb

@@ -0,0 +1,48 @@
+require 'benchmark'
+require 'socket'
+
+module StatsD
+  class Client
+    attr_reader :hostname, :port
+
+    def initialize(options = {})
+      @hostname = options[:hostname] || "localhost"
+      @port = (options[:port] || 8125).to_i
+    end
+
+    def time(key, sample_rate = 1, &block)
+      seconds = Benchmark.realtime { block.call }
+      timing(key, (seconds * 1000).round, sample_rate)
+    end
+
+    def timing(key, ms, sample_rate = 1)
+      send_data({ key => "#{ms}|ms" }, sample_rate)
+    end
+
+    def incr(key, sample_rate = 1)
+      incrby(key, 1, sample_rate)
+    end
+
+    def incrby(key, increment, sample_rate = 1)
+      send_data({ key => "#{increment}|c" }, sample_rate)
+    end
+
+    def decr(key, sample_rate = 1)
+      decrby(key, 1, sample_rate)
+    end
+
+    def decrby(key, decrement, sample_rate = 1)
+      incrby(key, -decrement, sample_rate)
+    end
+
+    def send_data(data, sample_rate = 1)
+      socket = UDPSocket.new
+      socket.bind("127.0.0.1", 0)
+      socket.connect(@hostname, @port)
+      data.each do |key, val|
+        val += "|@#{sample_rate}" if sample_rate != 1
+        socket.send "#{key}:#{val}", 0
+      end
+    end
+  end
+end

data/lib/statsd/version.rb

@@ -0,0 +1,3 @@
+module StatsD
+  Version = VERSION = '0.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'statsd'

data/spec/statsd/client_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+describe StatsD::Client do
+  describe "initialize" do
+    it "defaults to localhost:8125" do
+      client = described_class.new
+      client.hostname.should == "localhost"
+      client.port.should == 8125
+    end
+
+    it "initializes hostname and port" do
+      client = described_class.new(:hostname => "statsd.local", :port => 6000)
+      client.hostname.should == "statsd.local"
+      client.port.should == 6000
+    end
+
+    it "allows port to be specified as a string" do
+      client = described_class.new(:port => "6000")
+      client.port.should == 6000
+    end
+  end
+
+  describe "send_data" do
+    describe "sending over socket" do
+      RSpec::Matchers.define :send_data do |expected|
+        match do |actual|
+          socket = UDPSocket.new
+          socket.bind("127.0.0.1", 9730)
+          actual.call
+          IO.select([socket])
+          req = socket.recvfrom_nonblock(100)
+          socket.close
+          req[0] == expected
+        end
+      end
+
+      it "sends single key and value" do
+        client = described_class.new(:port => 9730)
+        expect { client.send_data :hits => "1|c" }.to send_data "hits:1|c"
+      end
+    end
+
+    describe "socket connection" do
+      before :each do
+        @socket = double('socket')
+        [:bind, :connect].each { |m| @socket.stub m }
+        UDPSocket.stub(:new) { @socket }
+        @client = described_class.new(
+          :hostname => "statsd.local",
+          :port => 6000
+        )
+      end
+
+      it "binds to 127.0.0.1" do
+        @socket.should_receive(:bind).with("127.0.0.1", 0)
+        @client.send_data({})
+      end
+
+      it "connects to the client hostname and port" do
+        @socket.should_receive(:connect).with(
+          @client.hostname,
+          @client.port
+        )
+        @client.send_data({})
+      end
+
+      it "sends a single key and value" do
+        @socket.should_receive(:send).with("hits:1|c", 0)
+        @client.send_data :hits => "1|c"
+      end
+
+      it "sends multiple keys and values" do
+        @socket.should_receive(:send).with("hits:1|c", 0)
+        @socket.should_receive(:send).with("downloads:1|c", 0)
+        @client.send_data :hits => "1|c", :downloads => "1|c"
+      end
+    end
+  end
+
+  describe "commands" do
+    before :each do
+      @client = described_class.new
+    end
+
+    describe "incr" do
+      it "sends the increment" do
+        @client.should_receive(:send_data).with({ :hits => "1|c" }, 1)
+        @client.incr :hits
+      end
+    end
+
+    describe "incrby" do
+      it "sends the specified increment value" do
+        @client.should_receive(:send_data).with({ :hits => "3|c" }, 1)
+        @client.incrby :hits, 3
+      end
+    end
+
+    describe "decr" do
+      it "sends the decrement" do
+        @client.should_receive(:send_data).with({ :invites => "-1|c" }, 1)
+        @client.decr :invites
+      end
+    end
+
+    describe "decrby" do
+      it "sends the specified decrement value" do
+        @client.should_receive(:send_data).with({ :tickets => "-4|c" }, 1)
+        @client.decrby :tickets, 4
+      end
+    end
+
+    describe "timing" do
+      it "sends the timing" do
+        @client.should_receive(:send_data).with({ :archive => "230|ms" }, 1)
+        @client.timing :archive, 230
+      end
+    end
+
+    describe "time" do
+      it "sends the time" do
+        @client.should_receive(:send_data).with({ :archive => "10|ms" }, 1)
+        @client.time(:archive) { sleep 0.01 }
+      end
+    end
+  end
+
+  describe "sampling" do
+    before :each do
+      @client = described_class.new
+    end
+
+    describe "incr" do
+      it "sends the sampleed increment" do
+        @client.should_receive(:send_data).with({ :hits => "1|c" }, 0.2)
+        @client.incr :hits, 0.2
+      end
+    end
+
+    describe "incrby" do
+      it "sends the sampled increment" do
+        @client.should_receive(:send_data).with({ :hits => "3|c" }, 0.2)
+        @client.incrby :hits, 3, 0.2
+      end
+    end
+
+    describe "decr" do
+      it "sends the sampled decrement" do
+        @client.should_receive(:send_data).with({ :invites => "-1|c" }, 0.5)
+        @client.decr :invites, 0.5
+      end
+    end
+
+    describe "decrby" do
+      it "sends the sampled decrement" do
+        @client.should_receive(:send_data).with({ :tickets => "-4|c" }, 0.5)
+        @client.decrby :tickets, 4, 0.5
+      end
+    end
+
+    describe "timing" do
+      it "sends the sampled timing" do
+        @client.should_receive(:send_data).with({ :archive => "230|ms" }, 0.1)
+        @client.timing :archive, 230, 0.1
+      end
+    end
+
+    describe "time" do
+      it "sends the sampled time" do
+        @client.should_receive(:send_data).with({ :archive => "10|ms" }, 0.1)
+        @client.time(:archive, 0.1) { sleep 0.01 }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: statsd-rb
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt Duncan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-21 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: "    A ruby client for Etsy's StatsD statistics aggregator.\n"
+email: matt@mattduncan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/statsd/client.rb
+- lib/statsd/version.rb
+- lib/statsd.rb
+- spec/spec_helper.rb
+- spec/statsd/client_spec.rb
+has_rdoc: true
+homepage: http://github.com/mrduncan/statsd
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A ruby client for StatsD.
+test_files: []
+