statsy 0.1.1

data/LICENSE

@@ -0,0 +1,22 @@
+ Copyright (c) 2011 Sean Treadway, SoundCloud Inc.
+
+ 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,53 @@
+# Statsy
+
+[Cal made simple stat aggregation][cal].  And it was good.
+
+[Etsy also made simple stat aggregation][etsy].  And it was also good.
+
+This is a simple client.  It does 2 things, increment and measure.  Oh 3 things if you count batching too.
+
+Usage: Default to UDP to a host in the current search domain called 'stats' on port 8125.
+
+    client = Statsy::Client.new
+
+Usage: Use a custom transport or change the host/port pair for UDP.
+
+    client = Statsy::Client.new(Statsy::Transport::UDP.new("graphite.acme.com", 8125))
+    client = Statsy::Client.new(Acme::Transport::Statsd) # <- you made that
+    client = Statsy::Client.new(Statsy::Transport::Queue.new) # <- if you want to test stuff
+
+Usage: Increment by 1, arbitrary integer, or arbitrary integer at a uniform random distribution
+
+    client.increment("coffee.single-espresso")
+    client.increment("coffee.single-espresso", 1)
+    client.increment("coffee.single-espresso", 1, 0.5) # 50% of the time
+
+Usage: Measure a timing stat that will calculate the mean, min, max, upper\_90 and count
+
+    client.measure("acme.backend-runtime", response.headers["X-Runtime"].to_i)
+
+Bonus points: Batch up many things into a fewer packets like in a shell script
+
+    loop do
+      batch_lines = 1000
+      client.batch do |batch|
+        $stdin.each do |log_line|
+          metric, timing = parse(log_line) # <- you made that
+          client.measure metric, timing
+          break if (batch_lines -= 1) <= 0
+        end
+      end
+    end
+
+These stats end up in your graphite interface under the top level keys. Look for them in this folders:
+
+    stats_counts
+    stats/timings
+    stats
+
+Fork it out of love.  Enjoy.
+
+[cal]:http://code.flickr.com/blog/2008/10/27/counting-timing/
+[etsy]:http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/
+
+

data/lib/statsy.rb

@@ -0,0 +1,113 @@
+# Client to access statsd service authored by etsy. Yay etsy!
+# https://github.com/etsy/statsd
+module Statsy
+  VERSION="0.1.1"
+
+  module Transport
+    require 'socket'
+
+    # Atomically send a Statsd encoded message to the service
+    # only call once per packet
+    module Interface
+      def write(stat); end
+    end
+
+    # UDP transport class that writes a stat per packet
+    # connects on construction, doesn't handle exceptions
+    class UDP < UDPSocket
+      include Interface
+
+      def initialize(host, port)
+        super()
+        connect(host, port)
+      end
+
+      def write(stat)
+        send(stat, 0)
+      end
+    end
+
+    # Queue transport writes for tests and batch operations
+    class Queue < Array
+      include Interface
+
+      def write(stat)
+        self.push(stat)
+      end
+    end
+  end
+
+  class Client
+    # Construct a client with a given transport that implements
+    # Transport::Interface
+    #
+    # Usage:
+    #   client = Statsy::Client.new
+    #   client = Statsy::Client.new(Statsy::Transport::UDP.new("custom", 8888))
+    #
+    def initialize(transport=Transport::UDP.new("stats", 8125))
+      @transport = transport
+    end
+
+    # Increment a count optionally at a random sample rate
+    #
+    # Usage:
+    #   client.increment("coffee.single-espresso")
+    #   client.increment("coffee.single-espresso", 1)
+    #   client.increment("coffee.single-espresso", 1, 0.5) # 50% of the time
+    #
+    def increment(stat, count=1, sampling=1)
+      if sampling < 1
+        if Kernel.rand < sampling
+          @transport.write("%s:%d|c@%f" % [ stat, count, sampling ])
+        end
+      else
+        @transport.write("%s:%d|c" % [ stat, count ])
+      end
+      self
+    end
+
+    # Sample a timing
+    #
+    # Usage:
+    #   client.measure("foo.backendtime", response.headers["X-Runtime"].to_i)
+    #
+    def measure(stat, time, sampling=1)
+      if sampling >= 1 || rand < sampling
+        @transport.write("%s:%d|ms" % [ stat, time ])
+      end
+      self
+    end
+
+    # Batch multiple transport operations, that will group any counts together
+    # and send the fewest number of packets with the counts/timers optimized at
+    # the end of the batch block.
+    #
+    # Note: this does not attempt to fit the packet size within the MTU.
+    #
+    # Usage:
+    #   client.batch do |batch|
+    #     batch.increment("foo.bar", 10)
+    #     batch.measure("bat.baz", 101)
+    #     batch.measure("foo.bar", 101)
+    #   end
+    #
+    #   => write "foo.bar:10|c:333|ms"
+    #   => write "bat.baz:101|ms"
+    #
+    def batch
+      yield self.class.new(batch = Transport::Queue.new)
+
+      batch.inject(Hash.new { |h,k| h[k]=[] }) do |stats, stat|
+        # [ "foo.bar:10|c", "foo.bar:101|ms" ]
+        key, value = stat.split(':', 2)
+        stats[key] << value
+        stats
+      end.sort.each do |pairs|
+        # [ "foo.bar", [ "10|c", "101|ms" ] ]
+        @transport.write(pairs.flatten.join(":"))
+      end
+      self
+    end
+  end
+end

data/test/statsy_test.rb

@@ -0,0 +1,124 @@
+require 'test/unit'
+require File.expand_path('../../lib/statsy', __FILE__)
+
+class Unit < Test::Unit::TestCase
+  def setup
+    @transport = Statsy::Transport::Queue.new
+    @client = Statsy::Client.new(@transport)
+  end
+
+  def test_increment_should_return_self
+    assert_equal @client, @client.increment("foo.stat")
+  end
+
+  def test_increment_should_form_single_count
+    @client.increment("foo.stat")
+    assert_equal "foo.stat:1|c", @transport.shift
+  end
+
+  def test_increment_should_count_by_more_than_one
+    @client.increment("foo.stat", 101)
+    assert_equal "foo.stat:101|c", @transport.shift
+  end
+
+  def test_increment_should_sample
+    @client.increment("foo.stat", 1, 0.999999)
+    assert_equal "foo.stat:1|c@0.999999", @transport.shift
+  end
+
+  def test_measure_should_return_self
+    assert_equal @client, @client.measure("foo.stat", 100)
+  end
+
+  def test_measure_should_form_ms_rate
+    @client.measure("foo.timing", 1000)
+    assert_equal "foo.timing:1000|ms", @transport.shift
+  end
+
+  def test_measure_should_sample
+    @client.measure("foo.sampled.timing", 100, 0.0000001)
+    assert_equal nil, @transport.shift
+  end
+
+  def test_increment_twice_should_write_twice
+    @client.increment("foo.inc", 1)
+    @client.increment("foo.inc", 2)
+    assert_equal 2, @transport.size
+    assert_equal "foo.inc:1|c", @transport.shift
+    assert_equal "foo.inc:2|c", @transport.shift
+  end
+
+  def test_batch_should_return_self
+    assert_equal @client, @client.batch { }
+  end
+
+  def test_batch_should_write_same_as_increment
+    @client.increment("foo.inc")
+
+    @client.batch do |c|
+      c.increment("foo.inc")
+    end
+
+    assert_equal 2, @transport.size
+    assert_equal "foo.inc:1|c", @transport.shift
+    assert_equal "foo.inc:1|c", @transport.shift
+  end
+
+  def test_batch_should_only_write_once_per_key
+    @client.batch do |c|
+      c.increment("foo.inc", 2)
+      c.increment("foo.inc", 5)
+    end
+
+    assert_equal 1, @transport.size
+    assert_equal "foo.inc:2|c:5|c", @transport.shift
+  end
+
+  def test_batch_should_group_per_key
+    @client.batch do |c|
+      c.increment("foo.inc", 2)
+      c.increment("bar.inc", 3)
+      c.increment("foo.inc", 5)
+      c.increment("bar.inc", 7)
+    end
+
+    assert_equal 2, @transport.size
+    assert_equal "bar.inc:3|c:7|c", @transport.shift
+    assert_equal "foo.inc:2|c:5|c", @transport.shift
+  end
+
+  def test_batch_should_mix_increment_with_measure_per_key_in_sorted_order
+    @client.batch do |c|
+      c.increment("foo.inc", 2)
+      c.increment("bar.inc", 3)
+      c.measure("foo.inc", 500)
+      c.measure("bar.inc", 700)
+    end
+
+    assert_equal 2, @transport.size
+    assert_equal "bar.inc:3|c:700|ms", @transport.shift
+    assert_equal "foo.inc:2|c:500|ms", @transport.shift
+  end
+
+  def test_sampling_should_not_send_when_not_sampled
+    @client.increment("foo.sampled", 1, 0.000001)
+    assert_equal 0, @transport.size
+  end
+
+  def test_batch_should_be_nestable
+    @client.batch do |c1|
+      c1.increment("foo.inc", 2)
+      c1.measure("bar.inc", 700)
+      c1.batch do |c2|
+        c2.increment("foo.inc", 9)
+        c2.measure("bar.inc", 900)
+      end
+      c1.measure("foo.inc", 500)
+      c1.increment("bar.inc", 3)
+    end
+
+    assert_equal 2, @transport.size
+    assert_equal "bar.inc:700|ms:900|ms:3|c", @transport.shift
+    assert_equal "foo.inc:2|c:9|c:500|ms", @transport.shift
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: statsy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Sean Treadway
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Simple way to increment counts and measure variance in timings of everything from requests per second to single espressos
+email: 
+- treadway@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/statsy.rb
+- LICENSE
+- README.md
+- test/statsy_test.rb
+has_rdoc: true
+homepage: http://github.com/streadway/statsy
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: statsy
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Client network library to Statsd
+test_files: 
+- test/statsy_test.rb