haproxy_log_parser 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f019630e3a37d631615874f51d00936ade7a58a2
-  data.tar.gz: c95c16a28cfc263e3b5f5b3310836b4afbf30094
+  metadata.gz: bdee7790396094ba841e7a79fda38388fddd31a6
+  data.tar.gz: 77f1cfd3fbe289140fe605dc8092ac38def83fb0
 SHA512:
-  metadata.gz: 1d9567c587f66a274e8fa1d829e59c42cb07969094061c0fe5cde805ca322114880c71d62ff18a88f9494f779fc04d4f132105d425d5c22aff3de6e8b95bfef8
-  data.tar.gz: 5d1d021bef436b3651e362a89ca555c1b3a8e3912bec57030a1bd3c76ad54d93f5fd5560df38460f9181bd36d232084e9020d28e254e0b319436735605d7d98b
+  metadata.gz: 92830fae50828e5422a120884f24c7ce5c64c2e8904fd3c6f3846e1e3d5224e028b89243abffe28913ed78773a70cbd4c68816efdbac8b794078ea408ffa50a1
+  data.tar.gz: 64254fac5285600842b6dd81b480f3ad5e8428558e7d92ef231b2b5ef4c0ad9e41e91c9b67196b65980242b880235e7dbb4fb4fbfe730257fc8056000f48b1c1

data/.gitignore

@@ -0,0 +1,3 @@
+haproxy_log_parser-*.gem
+/.bundle
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,6 +1,9 @@
 # haproxy\_log\_parser
 
 haproxy\_log\_parser is a gem that parses logs in HAProxy's HTTP log format.
+Use `HAProxyLogParser.parse` to parse a line; this will return an
+`HAProxyLogParser::Entry` for normal lines and `HAProxyLogParser::ErrorEntry`
+for connection error lines.
 
 Example:
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+2.0.0

data/haproxy_log_parser.gemspec

@@ -11,11 +11,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec', '~> 3.5.0'
 
-  s.files = Dir.glob('lib/**/*') + [
-    'LICENSE',
-    'README.md',
-    'VERSION',
-    'haproxy_log_parser.gemspec'
-  ]
-  s.test_files = Dir.glob('spec/**/*')
+  s.files = `git ls-files`.split($/)
+  s.test_files = s.files.grep(%r{\Aspec/})
 end

data/lib/haproxy_log_parser/error_entry.rb

@@ -0,0 +1,24 @@
+module HAProxyLogParser
+  # An instance of this class represents a connection error line of an HAProxy
+  # log. See the "Logging > Log formats > Error log format" section in
+  # HAProxy's configuration.txt for documentation of fields.
+  class ErrorEntry
+    # @return [String]
+    attr_accessor :client_ip
+
+    # @return [Integer]
+    attr_accessor :client_port
+
+    # @return [Time]
+    attr_accessor :accept_date
+
+    # @return [String]
+    attr_accessor :frontend_name
+
+    # @return [String]
+    attr_accessor :bind_name
+
+    # @return [String]
+    attr_accessor :message
+  end
+end

data/lib/haproxy_log_parser/line.treetop

@@ -4,6 +4,11 @@ module HAProxyLogParser
       syslog_portion:([^\[]+ '[' integer ']: ')
       client_ip:ip4_address ':' client_port:integer ' '
       '[' accept_date '] '
+      suffix:(normal_suffix / error_suffix)
+      "\n"?
+    end
+
+    rule normal_suffix
       frontend_name:proxy_name transport_mode:'~'? ' '
       backend_name:proxy_name '/' server_name ' '
       tq:integer '/' tw:integer '/' tc:integer '/' tr:integer '/' tt:integer ' '
@@ -18,7 +23,11 @@ module HAProxyLogParser
       captured_request_headers:('{' headers:captured_headers '} ')?
       captured_response_headers:('{' headers:captured_headers '} ')?
       '"' http_request:[^"]+ '"'
-      "\n"?
+    end
+
+    rule error_suffix
+      frontend_name:proxy_name '/' bind_name ': '
+      message:[^\n]+
     end
 
     rule integer
@@ -52,5 +61,9 @@ module HAProxyLogParser
     rule captured_headers
       [^}]*
     end
+
+    rule bind_name
+      [-_A-Za-z0-9.]+
+    end
   end
 end

data/lib/haproxy_log_parser.rb

@@ -1,6 +1,7 @@
 require 'treetop'
 
 require 'haproxy_log_parser/entry'
+require 'haproxy_log_parser/error_entry'
 require 'haproxy_log_parser/line'
 
 module HAProxyLogParser
@@ -10,11 +11,11 @@ module HAProxyLogParser
   class ParseError < ::StandardError; end
 
   class << self
-    # Returns an Entry object resulting from the given HAProxy HTTP-format log
-    # +line+.
+    # Returns an Entry or ErrorEntry object resulting from the given HAProxy
+    # HTTP-format log +line+.
     #
     # @param line [String] a line from an HAProxy log
-    # @return [Entry]
+    # @return [Entry, ErrorEntry]
     # @raise [ParseError] if the line was not parsed successfully
     def parse(line)
       parser = LineParser.new
@@ -24,39 +25,15 @@ module HAProxyLogParser
         raise ParseError, parser.failure_reason
       end
 
-      entry = Entry.new
-      [
-        :client_ip, :frontend_name, :transport_mode,
-        :backend_name, :server_name, :termination_state
-      ].each do |field|
-        entry.send("#{field}=", result.send(field).text_value)
-      end
-      [
-        :client_port, :tq, :tw, :tc, :tr, :tt, :status_code, :bytes_read,
-        :actconn, :feconn, :beconn, :srv_conn, :retries, :srv_queue,
-        :backend_queue
-      ].each do |field|
-        entry.send("#{field}=", result.send(field).text_value.to_i)
-      end
-
-      entry.accept_date = parse_accept_date(result.accept_date.text_value)
-      [:captured_request_cookie, :captured_response_cookie].each do |field|
-        cookie = decode_captured_cookie(result.send(field).text_value)
-        entry.send("#{field}=", cookie)
-      end
-
-      [:captured_request_headers, :captured_response_headers].each do |field|
-        if result.send(field).respond_to?(:headers)
-          headers = decode_captured_headers(
-            result.send(field).headers.text_value
-          )
+      entry =
+        if result.suffix.respond_to?(:http_request)
+          create_normal_entry(result.suffix)
         else
-          headers = []
+          create_error_entry(result.suffix)
         end
-        entry.send("#{field}=", headers)
-      end
-
-      entry.http_request = unescape(result.http_request.text_value)
+      entry.client_ip = result.client_ip.text_value
+      entry.client_port = result.client_port.text_value.to_i
+      entry.accept_date = parse_accept_date(result.accept_date.text_value)
 
       entry
     end
@@ -103,5 +80,58 @@ module HAProxyLogParser
     def decode_captured_headers(string)
       string.split('|', -1).map! { |header| unescape(header) }
     end
+
+    private
+
+    # @param result [Treetop::Runtime::SyntaxNode]
+    # @return [Entry]
+    def create_normal_entry(result)
+      entry = Entry.new
+
+      %i(
+        frontend_name transport_mode
+        backend_name server_name termination_state
+      ).each do |field|
+        entry.send("#{field}=", result.send(field).text_value)
+      end
+
+      %i(
+        tq tw tc tr tt status_code bytes_read
+        actconn feconn beconn srv_conn retries srv_queue backend_queue
+      ).each do |field|
+        entry.send("#{field}=", result.send(field).text_value.to_i)
+      end
+
+      %i(captured_request_cookie captured_response_cookie).each do |field|
+        cookie = decode_captured_cookie(result.send(field).text_value)
+        entry.send("#{field}=", cookie)
+      end
+
+      %i(captured_request_headers captured_response_headers).each do |field|
+        if result.send(field).respond_to?(:headers)
+          headers = decode_captured_headers(
+            result.send(field).headers.text_value
+          )
+        else
+          headers = []
+        end
+        entry.send("#{field}=", headers)
+      end
+
+      entry.http_request = unescape(result.http_request.text_value)
+      entry
+    end
+
+    # @param result [Treetop::Runtime::SyntaxNode]
+    # @return [ErrorEntry]
+    def create_error_entry(result)
+      entry = ErrorEntry.new
+
+      %i(frontend_name bind_name message).each do |field|
+        entry.send("#{field}=", result.send(field).text_value)
+      end
+
+      entry
+    end
   end
 end

data/spec/haproxy_log_parser_spec.rb

@@ -1,12 +1,14 @@
 require 'haproxy_log_parser'
 
 RSpec.describe HAProxyLogParser do
-  # TODO Use something better instead of LINES[0], LINES[1], ...
-  LINES = IO.readlines(File.join(File.dirname(__FILE__), 'sample.log'))
+  LINES = Hash[
+    IO.readlines(File.join(File.dirname(__FILE__), 'sample.log')).
+      map { |line| line.split(',', 2) }
+  ]
 
   describe '.parse' do
-    it 'parses LINE[0] correctly' do
-      entry = HAProxyLogParser.parse(LINES[0])
+    it 'parses the good1 case correctly' do
+      entry = HAProxyLogParser.parse(LINES['good1'])
       expect(entry.client_ip).to eq('10.0.8.2')
       expect(entry.client_port).to eq(34028)
       expect(entry.accept_date).to eq(Time.local(2011, 8, 9, 20, 30, 46, 429))
@@ -36,8 +38,8 @@ RSpec.describe HAProxyLogParser do
       expect(entry.http_request).to eq('GET / HTTP/1.1')
     end
 
-    it 'parses LINES[1] correctly' do
-      entry = HAProxyLogParser.parse(LINES[1])
+    it 'parses the good2 case correctly' do
+      entry = HAProxyLogParser.parse(LINES['good2'])
       expect(entry.client_ip).to eq('192.168.1.215')
       expect(entry.client_port).to eq(50679)
       expect(entry.accept_date).to eq(Time.local(2012, 5, 21, 1, 35, 46, 146))
@@ -67,6 +69,16 @@ RSpec.describe HAProxyLogParser do
       expect(entry.http_request).to eq('GET /images/image.gif HTTP/1.1')
     end
 
+    it 'parses connection error lines correctly' do
+      entry = HAProxyLogParser.parse(LINES['error1'])
+      expect(entry.client_ip).to eq('127.0.0.1')
+      expect(entry.client_port).to eq(56059)
+      expect(entry.accept_date).to eq(Time.local(2012, 12, 3, 17, 35, 10, 380))
+      expect(entry.frontend_name).to eq('frt')
+      expect(entry.bind_name).to eq('f1')
+      expect(entry.message).to eq('Connection error during SSL handshake')
+    end
+
     it 'raises ParseError if the line is invalid' do
       line = 'Aug  9 20:30:46 localhost haproxy[2022]: '
       expect { HAProxyLogParser.parse(line) }.

data/spec/sample.log

@@ -1,2 +1,3 @@
-Aug  9 20:30:46 localhost haproxy[2022]: 10.0.8.2:34028 [09/Aug/2011:20:30:46.429] proxy-out~ proxy-out/cache1 1/0/2/126/+128 301 +223 - - LR-- 617/523/336/168/0 0/0 {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} {Apache|230|||http://www.sytadin.} "GET / HTTP/1.1"
-May 21 01:35:46 10.18.237.5 haproxy[26747]: 192.168.1.215:50679 [21/May/2012:01:35:46.146] webapp webapp_backend/web09 27/0/1/0/217 200 1367 session=abc session=xyz ---- 600/529/336/158/0 0/0 {#7C#7C #7B5F41#7D|http://google.com/|} "GET /images/image.gif HTTP/1.1"
+good1,Aug  9 20:30:46 localhost haproxy[2022]: 10.0.8.2:34028 [09/Aug/2011:20:30:46.429] proxy-out~ proxy-out/cache1 1/0/2/126/+128 301 +223 - - LR-- 617/523/336/168/0 0/0 {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} {Apache|230|||http://www.sytadin.} "GET / HTTP/1.1"
+good2,May 21 01:35:46 10.18.237.5 haproxy[26747]: 192.168.1.215:50679 [21/May/2012:01:35:46.146] webapp webapp_backend/web09 27/0/1/0/217 200 1367 session=abc session=xyz ---- 600/529/336/158/0 0/0 {#7C#7C #7B5F41#7D|http://google.com/|} "GET /images/image.gif HTTP/1.1"
+error1,Dec  3 18:27:14 localhost haproxy[6103]: 127.0.0.1:56059 [03/Dec/2012:17:35:10.380] frt/f1: Connection error during SSL handshake

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haproxy_log_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Toby Hsieh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -44,12 +44,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
 - LICENSE
 - README.md
 - VERSION
 - haproxy_log_parser.gemspec
 - lib/haproxy_log_parser.rb
 - lib/haproxy_log_parser/entry.rb
+- lib/haproxy_log_parser/error_entry.rb
 - lib/haproxy_log_parser/line.treetop
 - spec/haproxy_log_parser_spec.rb
 - spec/sample.log
@@ -73,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Parser for HAProxy logs in the HTTP log format