simple-graphite 1.1.1 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd5755e6f33393cf4462556dae8ec9f73eddac24
+  data.tar.gz: 6a1c7f28c36e69386d19bfdd877259bc6067e2e4
+SHA512:
+  metadata.gz: 6771d947538cd1f4fe0a933dee1e9ceae3c0fbfcb3a4a9b0cc0938f0883606199e2c2b118282113042696564705489b140d1b345295414be816bfa6c5c653254
+  data.tar.gz: 4371d070f53c70e13267ead0f77c14584cee8bef111ee71720d1d0bbf64382e693612bfda1775d616545f92aa26953d2d8cc29030558563d9222343b24a4dda3

data/README.rdoc

@@ -1,6 +1,6 @@
 = simple-graphite
 
-A simple interface into [Graphite](http://graphite.wikidot.com).
+A simple interface to {Graphite}[http://graphite.wikidot.com].
 
 = How-to
 
@@ -12,10 +12,16 @@ or
     g.port = 2003
 
 To push data to Graphite:
-    g.push_to_graphite do |socket|
-      socket.puts "your.metric.name 3.1415926 #{g.time_now}"
+    g.push_to_graphite do |graphite|
+      graphite.puts "your.metric.name 3.1415926 #{g.time_now}"
     end
 
+Or:
+    g.send_metrics({
+      'foo.bar1' => 250,
+      'foo.bar2' => 114
+    })
+
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -24,7 +30,7 @@ To push data to Graphite:
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
+  bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright

data/lib/graphite/socket.rb

@@ -0,0 +1,44 @@
+require 'socket'
+
+class Graphite
+  class Socket
+    attr_accessor :host, :port, :type, :socket
+
+    def initialize(host, port, socket_type)
+      @host = host
+      @port = port
+      @type = socket_type
+      @socket = nil
+    end
+
+    def puts(event)
+      socket.write(terminated_event(event.to_s))
+      close if @type == :udp
+    end
+
+    def close
+      @socket.close if @socket and !@socket.closed?
+    rescue => e
+      warn "#{self.class} - #{e.class} - #{e.message}"
+    end
+
+    def socket
+      return @socket if @socket && !@socket.closed?
+      @socket = case @type
+        when :udp then UDPSocket.new.tap {|s| s.connect(@host, @port)}
+        when :tcp then TCPSocket.new(@host, @port)
+        else
+          raise NameError, "#{@type} is invalid; must be udp or tcp"
+        end
+    end
+
+    def terminated_event(event)
+      event =~ /\n$/ ? event : event + "\n"
+    end
+
+    # Retained for compatibility
+    def connect
+      socket
+    end
+  end
+end

data/lib/simple-graphite.rb

@@ -1,21 +1,37 @@
 require 'socket'
+require 'graphite/socket'
 
 class Graphite
-  attr_accessor :host, :port, :time
+
+  attr_accessor :host, :type, :port, :time
+
   def initialize(options = {})
     @host = options[:host]
-    @port = options[:port]
+    @type = options[:type] ||= :tcp
+    @port = options[:port] ||= @type.eql?(:tcp) ? 2003 : 8125
     @time = Time.now.to_i
   end
 
   def push_to_graphite
-    socket = TCPSocket.new(@host, @port)
-    yield socket
-    socket.close
+    raise "You need to provide a hostname" if @host.nil?
+    begin
+      socket = Graphite::Socket.new @host, @port, @type
+      yield socket
+    ensure
+      socket.close
+    end
+  end
+
+  def send_metrics(metrics_hash)
+    current_time = time_now
+    push_to_graphite do |graphite|
+      graphite.puts((metrics_hash.map { |k,v| [k, v, current_time].join(' ') + "\n" }).join(''))
+    end
+    current_time
   end
 
   def hostname
-    Socket.gethostname
+    ::Socket.gethostname
   end
 
   def self.time_now

data/spec/simple-graphite_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+require 'socket'
+require 'simple-graphite'
+
+describe Graphite do
+
+  it "uses TCP by default" do
+    a = Graphite.new
+    a.port.should == 2003 && a.type.should == :tcp
+  end
+
+  it "has a default TCP port" do
+    a = Graphite.new
+    a.port.should == 2003
+  end
+
+  it "has a default UDP port" do
+    a = Graphite.new :type => :udp
+    a.port.should == 8125
+  end
+
+  it "only accepts UDP or TCP as protocols" do
+    a = Graphite.new :host => 'localhost', :type => :fake
+    expect {a.push_to_graphite{|g| g.puts "hello world"}}.to raise_error(NameError, "fake is invalid; must be udp or tcp")
+  end
+
+  it "requires a hostname" do
+    a = Graphite.new
+    expect {a.push_to_graphite}.to raise_error(RuntimeError, "You need to provide a hostname")
+  end
+
+  it "returns time accurately" do
+    a = Graphite.new
+    a.time_now.should == Time.now.to_i
+  end
+
+  describe "over TCP" do
+    before do
+      @ftcp = FakeTCPSocket.new
+    end
+
+    after do
+      @ftcp.close
+    end
+
+    it "sends individual metrics to graphite" do
+      a = Graphite.new(:host => 'localhost', :type => :tcp, :port => 12003)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello world\n"
+      end
+
+      @ftcp.buffer.should == "hello world\n"
+    end
+
+    it "terminates individual metrics with newlines" do
+      a = Graphite.new(:host => 'localhost', :type => :tcp, :port => 12003)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello world"
+      end
+
+      @ftcp.buffer.should == "hello world\n"
+    end
+
+    it "sends multiple metrics to graphite" do
+      a = Graphite.new(:host => 'localhost', :type => :tcp, :port => 12003)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello\n"
+        graphite.puts "world\n"
+      end
+
+      @ftcp.buffer.should == "hello\nworld\n"
+    end
+
+    it "terminates multiple metrics with newlines" do
+      a = Graphite.new(:host => 'localhost', :type => :tcp, :port => 12003)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello"
+        graphite.puts "world"
+      end
+
+      @ftcp.buffer.should == "hello\nworld\n"
+    end
+
+    it "sends a hash of metrics to graphite" do
+      a = Graphite.new(:host => 'localhost', :type => :tcp, :port => 12003)
+
+      time = a.send_metrics({
+        'foo.bar' => 200,
+        'foo.test' => 10.2
+      })
+
+      @ftcp.buffer.should == "foo.bar 200 #{time}\nfoo.test 10.2 #{time}\n"
+    end
+  end
+
+  describe "over UDP" do
+    before do
+      @fudp = FakeUDPSocket.new
+    end
+
+    after do
+      @fudp.close
+    end
+
+    it "sends individual metrics to graphite" do
+      a = Graphite.new(:host => 'localhost', :type => :udp, :port => 18125)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello world\n"
+      end
+
+      @fudp.buffer.should == "hello world\n"
+    end
+
+    it "terminates individual metrics with newlines" do
+      a = Graphite.new(:host => 'localhost', :type => :udp, :port => 18125)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello world"
+      end
+
+      @fudp.buffer.should == "hello world\n"
+    end
+
+    it "sends multiple metrics to graphite" do
+      a = Graphite.new(:host => 'localhost', :type => :udp, :port => 18125)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello\n"
+        graphite.puts "world\n"
+      end
+
+      @fudp.buffer.should == "hello\nworld\n"
+    end
+
+    it "terminates multiple metrics with newlines" do
+      a = Graphite.new(:host => 'localhost', :type => :udp, :port => 18125)
+      a.push_to_graphite do |graphite|
+        graphite.puts "hello"
+        graphite.puts "world"
+      end
+
+      @fudp.buffer.should == "hello\nworld\n"
+    end
+
+    it "sends a hash of metrics to graphite" do
+      a = Graphite.new(:host => 'localhost', :type => :udp, :port => 18125)
+
+      time = a.send_metrics({
+        'foo.bar' => 200,
+        'foo.test' => 10.2
+      })
+
+      @fudp.buffer.should == "foo.bar 200 #{time}\nfoo.test 10.2 #{time}\n"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'socket'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.color_enabled = true
+  config.tty = true
+  config.formatter = :documentation # :progress, :html, :textmate
+end
+
+class FakeTCPSocket
+  def initialize
+    @sock = TCPServer.new(12003)
+  end
+
+  def buffer
+    buf = @sock.accept
+    buf.read_nonblock(65535)
+  end
+
+  def close
+    @sock.close
+  end
+end
+
+class FakeUDPSocket
+  def initialize
+    @sock = UDPSocket.new
+    @sock.bind(nil, 18125)
+  end
+
+  def buffer
+    buf = Array.new
+    begin
+      while pkt = @sock.recvfrom_nonblock(65535)
+        buf << pkt
+      end
+    rescue IO::WaitReadable
+    end
+    buf.map{|p| p.first}.join()
+  end
+
+  def close
+    @sock.close
+  end
+end

metadata

@@ -1,73 +1,82 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: simple-graphite
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 1
-  version: 1.1.1
+version: !ruby/object:Gem::Version
+  version: 2.1.0
 platform: ruby
-authors: 
+authors:
 - Ian Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-21 00:00:00 +00:00
-default_executable: 
-dependencies: []
-
-description: Exposes methods to send data to graphite
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple methods for sending data to graphite over TCP or UDP
 email: ianmmeyer@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
+- lib/graphite/socket.rb
 - lib/simple-graphite.rb
-- test/simple-graphite_test.rb
-- test/test_helper.rb
+- spec/simple-graphite_spec.rb
+- spec/spec_helper.rb
 - LICENSE
 - README.rdoc
-has_rdoc: true
 homepage: http://github.com/imeyer/simple-graphite
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple hook into graphite
-test_files: 
-- test/test_helper.rb
-- test/simple-graphite_test.rb
+test_files:
+- spec/simple-graphite_spec.rb
+- spec/spec_helper.rb

data/test/simple-graphite_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class EtsyGraphiteTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end

data/test/test_helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'simple-graphite'
-
-class Test::Unit::TestCase
-end