dawanda-statsd-client 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tom Taylor
+
+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,24 @@
+statsd-client
+=============
+
+A Ruby client for [StatsD](https://github.com/etsy/statsd), Etsy's daemon for easy stats aggregation.
+
+Usage
+-----
+
+    client = Statsd::Client.new(host, port)
+    client.timing('example.stat.1', 350)
+    client.increment('example.stat.2')
+    client.decrement('example.stat.2')
+
+Documentation
+-------------
+
+[On rdoc.info](http://rdoc.info/github/tomtaylor/statsd-client/master/frames)
+
+Copyright
+---------
+
+Copyright (c) 2011 Tom Taylor. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "dawanda-statsd-client"
+  gem.homepage = "http://github.com/dawanda/statsd-client"
+  gem.license = "MIT"
+  gem.summary = "Client for statds"
+  gem.description = %Q{A Ruby client for statsd}
+  gem.email = "tom@tomtaylor.co.uk"
+  gem.authors = ["Tom Taylor"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "statsd-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/statsd-send

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'statsd-client'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Report to statsd (https://github.com/etsy/statsd) from console
+Needs statsd-client.yml in /etc or ~/, see statsd-client.example.yml for example
+
+Usage:
+  statsd-send inc users.login --by=5 
+  statsd-send dec users.login --by=5 
+  statsd-send time pages.homepage 333
+
+Options:
+BANNER
+
+  opts.on("-h", "--help","Show this.") { puts opts; exit }
+  opts.on('-v', '--version','Show Version'){ puts Statsd::Client::VERSION; exit}
+  opts.on('--by x','Value for inc/dec') do |value|
+    options[:by] = value.to_i
+  end
+  opts.on('--host x', 'Use this host, when reporting') do |host|
+    options[:host] = host
+  end
+end.parse!
+  
+command, metric, value = ARGV[0..2]
+if metric.to_s.empty?
+  puts "Usage instructions: statsd-send --help"
+  exit
+end
+
+if command == 'time'
+  Statsd.time(metric, value)
+else
+  Statsd.send(command, metric, options)
+end
+

data/lib/statsd-client.rb

@@ -0,0 +1,154 @@
+# @author Tom Taylor
+require 'socket'
+require 'yaml'
+
+class Statsd
+  class << self 
+    def increment(metric, options={})
+      value = options.is_a?(Fixnum) ? options : (options[:by] || 1)
+      client.update_stats(metric, value*factor, (options[:sample_rate] || 1))
+    end
+    alias_method :inc, :increment
+  
+    def decrement(metric, options={})
+      value = options.is_a?(Fixnum) ? options : (options[:by] || 1)
+      client.update_stats(metric, value*factor*(-1), (options[:sample_rate] || 1))
+    end
+    alias_method :dec, :decrement
+
+    def timing(metric, value)
+      client.timing(metric, value)
+    end
+    alias_method :time, :timing
+    
+    def client
+      return Statsd::DummyClient if deactivated?
+      @client ||= Statsd::Client.new(host, port)
+    end
+  
+    def config
+      home = File.expand_path('~')
+      files = ["#{home}/.statsd-client.yml", '/etc/statsd-client.yml']
+      files.each do |file|
+        return YAML.load(File.read(file)) if File.exist?(file)
+      end
+      raise "No config found: #{files.join(' or ')}"
+    end
+  
+    def host
+      config['host'] || 'localhost'
+    end
+  
+    def port
+      config['port'] || 8125
+    end
+  
+    # statds reports with default configs 1/10 of actual value
+    def factor
+      config['factor'] || 10
+    end
+  
+    def deactivated?
+      config['deactivated'] || false
+    end
+  end
+  
+  class DummyClient
+    def self.timing(*args)
+    end
+    
+    def self.update_stats(*args)
+    end
+  end
+  
+  
+  class Client
+    VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+    attr_reader :host, :port
+
+    # Initializes a Statsd client.
+    #
+    # @param [String] host
+    # @param [Integer] port
+    def initialize(host = 'localhost', port = 8125)
+      @host, @port = host, port
+    end
+
+    # Sends timing statistics.
+    #
+    # @param [Array, String] stats name of statistic(s) being updated
+    # @param [Integer] time in miliseconds
+    # @param [Integer, Float] sample_rate
+    def timing(stats, time, sample_rate = 1)
+      data = "#{time}|ms"
+      update_stats(stats, data, sample_rate)
+    end
+
+    # Increments a counter
+    #
+    # @param [Array, String] stats name of statistic(s) being updated
+    # @param [Integer, Float] sample_rate
+    def increment(stats, sample_rate = 1)
+      update_stats(stats, 1, sample_rate)
+    end
+
+    # Decrements a counter
+    #
+    # @param [Array, String] stats name of statistic(s) being updated
+    # @param [Integer, Float] sample_rate
+    def decrement(stats, sample_rate = 1)
+      update_stats(stats, -1, sample_rate)
+    end
+
+    # Updates one or more counters by an arbitrary amount
+    #
+    # @param [Array, String] stats name of statistic(s) being updated
+    # @param [Integer, Float] delta
+    # @param [Integer, Float] sample_rate
+    def update_stats(stats, delta = 1, sample_rate = 1)
+      stats = [stats] unless stats.kind_of?(Array)
+
+      data = {}
+
+      delta = delta.to_s
+      stats.each do |stat|
+        # if it's got a |ms in it, we know it's a timing stat, so don't append
+        # the |c.
+        data[stat] = delta.include?('|ms') ? delta : "#{delta}|c"
+      end
+
+      send(data, sample_rate)
+    end
+
+    private
+
+    def send(data, sample_rate = 1)
+      puts "sending #{data}"
+      sampled_data = {}
+      
+      if sample_rate < 1
+        if Kernel.rand <= sample_rate
+          data.each do |k,v|
+            sampled_data[k] = "#{v}|@#{sample_rate}"
+          end
+        end
+      else
+        sampled_data = data
+      end
+
+      socket = UDPSocket.new
+
+      begin
+        sampled_data.each do |k,v|
+          message = [k,v].join(':')
+          socket.send(message, 0, self.host, self.port)
+        end
+      rescue Exception => e
+        puts "Unexpected error: #{e}"
+      ensure
+        socket.close
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'statsd-client'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/statsd-client_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Statsd::Client do
+
+  describe "being initialized" do
+
+    describe "without any parameters" do
+      subject { Statsd::Client.new }
+      it { subject.host.should == 'localhost' }
+      it { subject.port.should == 8125 }
+    end
+
+    describe "with a host and port parameter" do
+      subject { Statsd::Client.new('example.com', 5555) }
+      it { subject.host.should == 'example.com' }
+      it { subject.port.should == 5555 }
+    end
+
+  end
+
+  describe "sending a timing statistic" do
+
+    subject { Statsd::Client.new }
+    before(:each) do
+      @udp_socket = mock(UDPSocket, :close => true)
+      UDPSocket.should_receive(:new).and_return(@udp_socket)
+    end
+
+    describe "without a sample rate" do
+
+      after(:each) { subject.timing('test', 350) }
+
+      it "should send a packet with the message 'test:350|ms'" do
+        @udp_socket.should_receive(:send).with("test:350|ms", 0, subject.host, subject.port)
+      end
+
+    end
+
+    describe "with sample rate of 0.5 (where it has been sampled for sending)" do
+
+      before(:each) { Kernel.should_receive(:rand).and_return(0.1) }
+      after(:each) { subject.timing('test', 350, 0.5) }
+
+      it "should send a packet with the message 'test:350|ms|@0.5" do
+        @udp_socket.should_receive(:send).with("test:350|ms|@0.5", 0, subject.host, subject.port)
+      end
+
+    end
+
+  end
+
+  describe "incrementing a statistic" do
+
+    subject { Statsd::Client.new }
+    before(:each) do
+      @udp_socket = mock(UDPSocket, :close => true)
+      UDPSocket.should_receive(:new).and_return(@udp_socket)
+    end
+
+    describe "without a sample rate" do
+
+      after(:each) { subject.increment('test') }
+
+      it "should send a packet with the message 'test:1|c'" do
+        @udp_socket.should_receive(:send).with("test:1|c", 0, subject.host, subject.port)
+      end
+
+    end
+
+    describe "with sample rate of 0.5 (where it has been sampled for sending)" do
+
+      before(:each) { Kernel.should_receive(:rand).and_return(0.1) }
+      after(:each) { subject.increment('test', 0.5) }
+
+      it "should send a packet with the message 'test:1|c|@0.5" do
+        @udp_socket.should_receive(:send).with("test:1|c|@0.5", 0, subject.host, subject.port)
+      end
+
+    end
+
+  end
+
+  describe "decrementing a statistic" do
+
+    subject { Statsd::Client.new }
+    before(:each) do
+      @udp_socket = mock(UDPSocket, :close => true)
+      UDPSocket.should_receive(:new).and_return(@udp_socket)
+    end
+
+    describe "without a sample rate" do
+
+      after(:each) { subject.decrement('test') }
+
+      it "should send a packet with the message 'test:-1|c'" do
+        @udp_socket.should_receive(:send).with("test:-1|c", 0, subject.host, subject.port)
+      end
+
+    end
+
+    describe "with sample rate of 0.5 (where it has been sampled for sending)" do
+
+      before(:each) { Kernel.should_receive(:rand).and_return(0.1) }
+      after(:each) { subject.decrement('test', 0.5) }
+
+      it "should send a packet with the message 'test:-1|c|@0.5" do
+        @udp_socket.should_receive(:send).with("test:-1|c|@0.5", 0, subject.host, subject.port)
+      end
+
+    end
+
+  end
+
+  describe "updating many statistics" do
+
+    subject { Statsd::Client.new }
+    before(:each) do
+      @udp_socket = mock(UDPSocket, :close => true)
+      UDPSocket.should_receive(:new).and_return(@udp_socket)
+    end
+
+    describe "without a sample rate" do
+
+      after(:each) { subject.update_stats(['test.1', 'test.2'], 1) }
+
+      it "should send two packets'" do
+        @udp_socket.should_receive(:send).with("test.1:1|c", 0, subject.host, subject.port).once
+        @udp_socket.should_receive(:send).with("test.2:1|c", 0, subject.host, subject.port).once
+      end
+
+    end
+
+    describe "with sample rate of 0.5 (where it has been sampled for sending)" do
+
+      before(:each) { Kernel.should_receive(:rand).and_return(0.1) }
+      after(:each) { subject.update_stats(['test.1', 'test.2'], 1, 0.5) }
+
+      it "should send a two packets" do
+        @udp_socket.should_receive(:send).with("test.1:1|c|@0.5", 0, subject.host, subject.port).once
+        @udp_socket.should_receive(:send).with("test.2:1|c|@0.5", 0, subject.host, subject.port).once
+      end
+
+    end
+
+  end
+
+end
+

data/statsd-client.example.yml

@@ -0,0 +1,5 @@
+---
+host: localhost
+factor: 10
+port: 8125
+deactivated: false

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: dawanda-statsd-client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 +01:00
+default_executable: statsd-send
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id004
+description: A Ruby client for statsd
+email: tom@tomtaylor.co.uk
+executables: 
+- statsd-send
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/statsd-send
+- lib/statsd-client.rb
+- spec/spec_helper.rb
+- spec/statsd-client_spec.rb
+- statsd-client.example.yml
+has_rdoc: true
+homepage: http://github.com/dawanda/statsd-client
+licenses: 
+- MIT
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Client for statds
+test_files: 
+- spec/spec_helper.rb
+- spec/statsd-client_spec.rb