haproxy-decklin 0.0.3

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in haproxy.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,133 @@
+# HAProxy RubyGem
+
+This gem aims to provide an interface to query HAProxy for statistics,
+and eventually management through the sockets API.
+
+## What's HAProxy?
+
+[HAProxy](http://haproxy.1wt.eu/) is the _Reliable, High Performance
+TCP/HTTP Load Balancer_.
+
+## Why this gem?
+
+* I use HAProxy at my work.
+* I wanted to know how to create gems.
+* I wanted to contribute with OSS.
+* Why not?
+* All of the above.
+
+## Example of use
+
+    #! /usr/bin/env ruby
+    require 'haproxy'
+    require 'pp'
+
+    haproxy = HAProxy.read_stats '/path/to/haproxy.stats.socket'
+
+    pp haproxy.info
+
+    # {:name=>"HAProxy",
+    #  :version=>"1.3.22",
+    #  :release_date=>"2009/10/14",
+    #  :nbproc=>"1",
+    #  :process_num=>"1",
+    #  :pid=>"10222",
+    #  :uptime=>"0d 0h33m12s",
+    #  :uptime_sec=>"1992",
+    #  :memmax_mb=>"0",
+    #  :ulimit_n=>"4013",
+    #  :maxsock=>"4013",
+    #  :maxconn=>"2000",
+    #  :maxpipes=>"0",
+    #  :currconns=>"1",
+    #  :pipesused=>"0",
+    #  :pipesfree=>"0",
+    #  :tasks=>"1",
+    #  :run_queue=>"1",
+    #  :node=>"roke",
+    #  :"description:"=>nil}
+
+    pp haproxy.stats
+
+    # [{:pxname=>"app1",
+    #   :svname=>"thin1",
+    #   :qcur=>"0",
+    #   :qmax=>"0",
+    #   :scur=>"0",
+    #   :smax=>"0",
+    #   :slim=>"",
+    #   :stot=>"0",
+    #   :bin=>"0",
+    #   :bout=>"0",
+    #   :dreq=>"",
+    #   :dresp=>"0",
+    #   :ereq=>"",
+    #   :econ=>"0",
+    #   :eresp=>"0",
+    #   :wretr=>"0",
+    #   :wredis=>"0",
+    #   :status=>"no check",
+    #   :weight=>"1",
+    #   :act=>"1",
+    #   :bck=>"0",
+    #   :chkfail=>"",
+    #   :chkdown=>"",
+    #   :lastchg=>"",
+    #   :downtime=>"",
+    #   :qlimit=>"",
+    #   :pid=>"1",
+    #   :iid=>"1",
+    #   :sid=>"1",
+    #   :throttle=>"",
+    #   :lbtot=>"0",
+    #   :tracked=>"",
+    #   :type=>"2",
+    #   :rate=>"0",
+    #   :rate_lim=>"",
+    #   :rate_max=>"0"},...]
+
+#### HAProxy sample configuration
+
+    global
+    	stats socket haproxy
+
+    defaults
+    	mode	http
+    	option httplog
+      option httpclose
+    	retries	3
+    	option redispatch
+    	maxconn	2000
+    	contimeout	5000
+    	clitimeout	50000
+    	srvtimeout	50000
+      stats uri /haproxy
+
+    listen app1 0.0.0.0:10000
+    	balance	roundrobin
+
+      server thin1 127.0.0.1:10001
+      server thin1 127.0.0.1:10002
+      server thin1 127.0.0.1:10003
+      server thin1 127.0.0.1:10004
+      server thin1 127.0.0.1:10005
+
+    frontend app2
+      bind 0.0.0.0:10011
+      default_backend app2
+
+    backend app2
+      balance roundrobin
+      server thin1 127.0.0.1:10006
+      server thin1 127.0.0.1:10007
+      server thin1 127.0.0.1:10008
+      server thin1 127.0.0.1:10009
+      server thin1 127.0.0.1:10010
+
+## Roadmap
+
+* Improve documentation
+* Improve CSV parsing
+* Add tests
+* Add examples
+* Read stats from HTTP and CSV files

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/haproxy.gemspec

@@ -0,0 +1,21 @@
+# -*- mode: ruby; encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "haproxy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "haproxy-decklin"
+  s.version     = HAProxy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Leandro López (inkel)"]
+  s.email       = ["inkel.ar@gmail.com"]
+  s.homepage    = "https://github.com/inkel/haproxy-ruby"
+  s.summary     = 'HAProxy interface for reading statistics or managing servers (requires HAProxy 1.4+)'
+  s.description = 'This gem is intended for use as a HAProxy interface when you need to read statistics or if you like to manage proxies thru Ruby'
+
+  s.rubyforge_project = "haproxy"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/haproxy.rb

@@ -0,0 +1,21 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'uri'
+Dir["#{libdir}/haproxy/*.rb"].each do |file|
+  require file
+end
+
+module HAProxy
+
+  def self.read_stats(from)
+    uri = URI.parse(from)
+
+    if uri.is_a?(URI::Generic) and File.socket?(uri.path)
+      HAProxy::SocketReader.new(uri.path)
+    else
+      raise NotImplementedError, "Currently only sockets are implemented"
+    end
+  end
+
+end

data/lib/haproxy/csv_parser.rb

@@ -0,0 +1,32 @@
+module HAProxy
+  class CSVParser
+
+    # Uses CSV header from HAProxy 1.5, which is backwards compatible
+    COLUMNS = "pxname,svname,qcur,qmax,scur,smax,slim,stot,bin,bout,dreq,dresp,ereq,econ,eresp,wretr,wredis,status,weight,act,bck,chkfail,chkdown,lastchg,downtime,qlimit,pid,iid,sid,throttle,lbtot,tracked,type,rate,rate_lim,rate_max,check_status,check_code,check_duration,hrsp_1xx,hrsp_2xx,hrsp_3xx,hrsp_4xx,hrsp_5xx,hrsp_other,hanafail,req_rate,req_rate_max,req_tot,cli_abrt,srv_abrt".split(",").map(&:to_sym)
+    LIMIT = COLUMNS.length
+
+    def self.parse(line)
+      line.strip!
+      unless line.start_with? "#"
+        data = line.split(',')
+        pxname = data.shift
+
+        stats = { :pxname => pxname }
+
+        data.each_with_index do |value, i|
+          if i < LIMIT
+            stats[COLUMNS[i + 1]] = value
+          else
+            stats[:extra] = Array.new if stats[:extra].nil?
+            stats[:extra] << value
+          end
+        end
+
+        stats
+      else
+        raise ArgumentError, "Line is a comment"
+      end
+    end
+  end
+
+end

data/lib/haproxy/socket_reader.rb

@@ -0,0 +1,94 @@
+require 'socket'
+require 'haproxy/stats_reader'
+require 'haproxy/csv_parser'
+
+module HAProxy
+  class SocketReader < HAProxy::StatsReader
+
+    def initialize(path)
+      raise ArgumentError, "Socket #{path} doesn't exists or is not a UNIX socket" unless File.exists?(path) and File.socket?(path)
+      @path = path
+    end
+
+    def info
+      returning({}) do |info|
+        send_cmd "show info" do |line|
+          key, value = line.split(': ')
+          info[key.downcase.gsub('-', '_').to_sym] = value
+        end
+      end
+    end
+
+    def errors
+      returning("") do |errors|
+        send_cmd "show errors" do |line|
+          errors << line
+        end
+      end
+    end
+
+    def sessions
+      returning([]) do |sess|
+        send_cmd "show sess" do |line|
+          sess << line
+        end
+      end
+    end
+
+    TYPES = {
+      :frontend => 1,
+      :backend => 2,
+      :server => 4
+    }
+
+    def stats(types=[:all], options={})
+      params = {
+        :proxy => :all,
+        :server => :all
+      }.merge(options)
+
+      params[:proxy] = "-1" if params[:proxy].eql?(:all)
+      params[:server] = "-1" if params[:server].eql?(:all)
+
+      types = [types] unless types.is_a?(Array)
+
+      params[:type] = case
+                      when types.eql?([:all])
+                        "-1"
+                      else
+                        types.map{ |type| TYPES[type] }.inject(:+)
+                      end
+
+      cmd = "show stat #{params[:proxy]} #{params[:type]} #{params[:server]}"
+
+      returning([]) do |stats|
+        send_cmd(cmd) do |line|
+          stats << CSVParser.parse(line) unless line.start_with?('#')
+        end
+      end
+    end
+
+    def frontends
+      stats :frontend, :proxy => :all, :server => :all
+    end
+
+    def backends
+      stats :frontend, :proxy => :all, :server => :all
+    end
+
+    def servers
+      stats :server, :proxy => :all, :server => :all
+    end
+
+    protected
+
+    def send_cmd(cmd, &block)
+      socket = UNIXSocket.new(@path)
+      socket.write(cmd + ';')
+      socket.each do |line|
+        yield(line.strip)
+      end
+    end
+
+  end
+end

data/lib/haproxy/stats_reader.rb

@@ -0,0 +1,51 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+module HAProxy
+
+  class StatsReader
+
+    def info
+      raise NotImplementedError
+    end
+
+    def errors
+      raise NotImplementedError
+    end
+
+    def sessions
+      raise NotImplementedError
+    end
+
+    def stats
+      raise NotImplementedError
+    end
+
+    def frontends
+      raise NotImplementedError
+    end
+
+    def backends
+      raise NotImplementedError
+    end
+
+    def servers
+      raise NotImplementedError
+    end
+
+    protected
+
+    # Borrowed from Rails 3
+    def returning(value)
+      yield(value)
+      value
+    end
+
+    private
+
+    def initialize
+    end
+
+  end
+
+end

data/lib/haproxy/version.rb

@@ -0,0 +1,3 @@
+module HAProxy
+  VERSION = "0.0.3"
+end

data/spec/haproxy_spec.rb

@@ -0,0 +1,6 @@
+#require File.expand_path('../spec_helper.rb', __FILE__)
+require File.expand_path('../../lib/haproxy', __FILE__)
+
+describe HAProxy do
+
+end

data/spec/socket_reader_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../spec_helper.rb', __FILE__)
+require File.expand_path('../../lib/haproxy', __FILE__)
+
+describe HAProxy::SocketReader do
+
+  it "should accept an existing socket file" do
+    HAProxy::Test.with_socket do |path|
+      HAProxy::SocketReader.new(path).should_not be_nil
+    end
+  end
+
+  it "should fail without an existing socket file" do
+    Tempfile.new('invalid-file') do |file|
+      file.path.should_not be_socket
+      HAProxy::SocketReader.new(file.path).should_raise ArgumentError
+    end.close!
+  end
+
+  it "should return a Hash with proxy information" do
+    HAProxy::Test.with_socket(:info) do |path|
+      reader = HAProxy::SocketReader.new(path)
+      reader.info.class.should == Hash
+    end
+  end
+
+  it "should return a String when asking for errors" do
+    HAProxy::Test.with_socket(:without_errors) do |path|
+      reader = HAProxy::SocketReader.new(path)
+      reader.errors.class.should == String
+    end
+
+    HAProxy::Test.with_socket(:with_errors) do |path|
+      reader = HAProxy::SocketReader.new(path)
+      reader.errors.class.should == String
+    end
+  end
+
+  it "should return a String when asking for sessions" do
+    HAProxy::Test.with_socket(:without_sessions) do |path|
+      reader = HAProxy::SocketReader.new(path)
+      reader.sessions.class.should == Array
+    end
+
+    HAProxy::Test.with_socket(:with_sessions) do |path|
+      reader = HAProxy::SocketReader.new(path)
+      reader.sessions.class.should == Array
+    end
+  end
+
+  [ :frontends, :backends, :servers ].each do |type|
+    it "should return an Array with #{type} information" do
+      HAProxy::Test.with_socket do |path|
+        reader = HAProxy::SocketReader.new(path)
+        reader.send(type).class.should == Array
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,114 @@
+require 'tempfile'
+
+module HAProxy
+
+  module Test
+
+    class << self
+      def temp_file_path
+        tmp = Tempfile.new('haproxy-ruby-mocksock')
+        path = tmp.path
+        tmp.close!
+        path
+      end
+
+      def with_socket action = nil, &block
+        path = self.temp_file_path
+
+        UNIXServer.open(path) do |socket|
+          pid = Process.fork do
+            client = socket.accept
+            cmd, data = client.recvfrom(1024)
+            cmd.chomp!
+            client.send self.send(action || :unknown), 0
+            client.close
+            exit
+          end
+
+          block.call(path)
+
+          Process.kill "TERM", pid rescue nil
+        end
+      end
+
+      def unknown
+        "Unknown command"
+      end
+
+      def info
+        """Name: HAProxy
+Version: 1.3.25
+Release_date: 2010/06/16
+Nbproc: 1
+Process_num: 1
+Pid: 20518
+Uptime: 6d 7h07m46s
+Uptime_sec: 544066
+Memmax_MB: 0
+Ulimit-n: 80110
+Maxsock: 80110
+Maxconn: 40000
+Maxpipes: 0
+CurrConns: 28
+PipesUsed: 0
+PipesFree: 0
+Tasks: 125
+Run_queue: 1
+node: A1441
+description
+"""
+      end
+
+      def with_errors
+        '''
+[09/Mar/2011:16:05:48.038] frontend http-in (#1): invalid request
+  src 10.0.111.185, session #25765333, backend <NONE> (#-1), server <NONE> (#-1)
+  request length 352 bytes, error at position 23:
+
+  00000  POS LWqEQR/710 HTTP/1.1\x00\x00Content-Type: application/x-fcs\x00\x00
+  00058+ User- HTTP/1.1\r\n
+  00074  kwave Flash\r\n
+  00087  Host: 10.0.49.24\x00\x00Content-Length: 1\x00\x00P\r\n
+  00128  xy-Connection: Keep\r\n
+  00149  live\x00\x00Pragm\r\n
+  00162   no-cache\x00\x00X-NovINet: v1.2\x00\x00\x00\n
+  00192  \r\n
+  00194  \n
+  00195  k\xC3\xD9\xFB\x02\x9F\x02\r\x08\xBC\xDB\x1E\xD3Z[\xD4]\xDD%O\x0FX\x01
+  00218+ \xDD\x02\xB4\x98\xB4r\x87\xDB\x88\xD4\xBD\xA6\xBD\x80@\x15\x9D\x1A\xA7
+  00237+ \xE8,\x8B\x01\x1Ft\x97\x80\xDB\xBF\x87\xAD\x15\r\xDE\x9E\x0CL\x13 FB
+  00259+ \x822\xAA\xE0G\x10\t\xC3\xBC\e\xD0!\xC2dYh/\x01\x8A~\x85]z1\xC00\xBF
+  00286+ \xC5\x14\xFA\x7F\x03\xF2\xC1\x06\x10\r\n
+  00297  X\xA4Cqj0\xFC\x81\x14\xF2U\n
+  00309  (0\xBF\xC12<\xA0:\xB2\x84\xC5\xA1\xFAa01\xD0-\xF2\x85\xC8\xB0\r\n
+  00333  \x96$\x16\xB6\xB2\r,\x1D\x8B\x93\xAED\xBA\x9BE\r\n
+  00350  \r\n
+'''
+      end
+
+      def without_errors
+        ""
+      end
+
+      def with_sessions
+        '''0xa14a288: proto=tcpv4 src=10.0.16.1:56772 fe=http-in be=gelderlander_textlink srv=mongrel-10306 as=0 ts=08 age=49s calls=5 rq[f=00f0a0h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=4s,wx=,ax=] s0=[7,0h,fd=13,ex=] s1=[7,0h,fd=16,ex=] exp=4s
+0x9745898: proto=tcpv4 src=10.0.73.31:2778 fe=http-in be=gelderlander_textlink srv=mongrel-10315 as=0 ts=08 age=42s calls=4 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=8s,wx=,ax=] s0=[7,0h,fd=19,ex=] s1=[7,8h,fd=20,ex=] exp=8s
+0xa26cff0: proto=tcpv4 src=10.0.221.60:19546 fe=http-in be=limburger_textlink srv=mongrel-10708 as=0 ts=08 age=40s calls=4 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=10s,wx=,ax=] s0=[7,0h,fd=25,ex=] s1=[7,8h,fd=26,ex=] exp=10s
+0x9f2dff0: proto=tcpv4 src=10.0.45.76:59090 fe=http-in be=tctubantia_textlink srv=mongrel-10507 as=0 ts=08 age=38s calls=5 rq[f=00f0a0h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=11s,wx=,ax=] s0=[7,0h,fd=23,ex=] s1=[7,0h,fd=24,ex=] exp=11s
+0xa2cb998: proto=tcpv4 src=10.0.108.32:1734 fe=http-in be=tctubantia_textlink srv=mongrel-10505 as=0 ts=08 age=37s calls=3 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=12s,wx=,ax=] s0=[7,0h,fd=28,ex=] s1=[7,8h,fd=29,ex=] exp=12s
+0xa04b7e8: proto=tcpv4 src=10.0.148.59:1158 fe=http-in be=destentor_textlink srv=mongrel-10403 as=0 ts=08 age=34s calls=4 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=16s,wx=,ax=] s0=[7,0h,fd=32,ex=] s1=[7,8h,fd=33,ex=] exp=16s
+0x97d0b90: proto=tcpv4 src=10.0.133.111:50836 fe=http-in be=tctubantia_textlink srv=mongrel-10510 as=0 ts=08 age=21s calls=4 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=29s,wx=,ax=] s0=[7,0h,fd=1,ex=] s1=[7,8h,fd=8,ex=] exp=29s
+0x96b1220: proto=tcpv4 src=10.0.217.27:14445 fe=http-in be=gelderlander_textlink srv=mongrel-10310 as=0 ts=08 age=19s calls=4 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=30s,wx=,ax=] s0=[7,0h,fd=21,ex=] s1=[7,8h,fd=22,ex=] exp=30s
+0xa12e7a8: proto=tcpv4 src=10.0.34.84:49421 fe=http-in be=gelderlander_textlink srv=mongrel-10303 as=0 ts=08 age=16s calls=4 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=33s,wx=,ax=] s0=[7,0h,fd=15,ex=] s1=[7,8h,fd=17,ex=] exp=33s
+0x9b5f570: proto=tcpv4 src=10.0.242.177:50124 fe=http-in be=limburger_textlink srv=mongrel-10701 as=0 ts=08 age=14s calls=4 rq[f=009080h,l=0,an=00h,rx=,wx=,ax=] rp[f=001000h,l=0,an=10h,rx=35s,wx=,ax=] s0=[7,0h,fd=38,ex=] s1=[7,8h,fd=40,ex=] exp=35s
+0x9fda668: proto=unix_stream as=2 ts=09 age=0s calls=2 rq[f=00e042h,l=10,an=20h,rx=10s,wx=,ax=] rp[f=048060h,l=2499,an=00h,rx=,wx=10s,ax=] s0=[7,0h,fd=2,ex=] s1=[0,0h,fd=-1,ex=] exp=10s
+'''
+      end
+
+      def without_sessions
+        ""
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: haproxy-decklin
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Leandro López (inkel)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-07 00:00:00.000000000 Z
+dependencies: []
+description: This gem is intended for use as a HAProxy interface when you need to
+  read statistics or if you like to manage proxies thru Ruby
+email:
+- inkel.ar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- haproxy.gemspec
+- lib/haproxy.rb
+- lib/haproxy/csv_parser.rb
+- lib/haproxy/socket_reader.rb
+- lib/haproxy/stats_reader.rb
+- lib/haproxy/version.rb
+- spec/haproxy_spec.rb
+- spec/socket_reader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/inkel/haproxy-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: haproxy
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: HAProxy interface for reading statistics or managing servers (requires HAProxy
+  1.4+)
+test_files:
+- spec/haproxy_spec.rb
+- spec/socket_reader_spec.rb
+- spec/spec_helper.rb