logtool 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+rlog
+====
+
+LogTool parsing utility for Rails logs

data/Rakefile

@@ -0,0 +1 @@
+require 'rake/testtask'

data/bin/logtool

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'logtool'
+LogTool::execute
+

data/lib/logtool.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(File.expand_path(__FILE__)), "logtool", "block.rb")
+require File.join(File.dirname(File.expand_path(__FILE__)), "logtool", "parser.rb")
+require File.join(File.dirname(File.expand_path(__FILE__)), "logtool", "query.rb")
+
+module LogTool
+  def self.usage
+<<USAGE
+	Usage: logtool file mode mode_options
+
+	File is the rails log file that should be parsed. Mode can be either gtk or query. For gtk, a window will open and let you explore the log file. For query, you can write a query that will be executed on the log entries.
+
+	== Query mode ==
+	  When using the query mode, mode_options should be in the following format: filter information [options]. The first parameter filters the log entries, the second one is the information you want to retrieve. The last one is the only optional one, where you can specify further options.
+	  ==filter==
+	  Boolean Operators: and, or, not
+	  Value Operators ==, <=, >=, <, >
+	  Values: ip, method, response, asset
+
+	  ==information to retrieve==
+	  ip, head, tail, method, time
+
+	  ==options==
+	  -l num: shows only the last num entries.
+
+	  Examples:
+	  logtool log/production.log query "ip == 127.0.0.1" head
+	  logtool log/production.log query "(ip == 127.0.0.1) and not asset" head
+	  logtool log/production.log query "(ip == 127.0.0.1) or (ip == 0.0.0.0) and not asset" head
+	  logtool log/production.log query "response > 200" ip
+USAGE
+  end
+
+  def self.fatal_error(err_msg=nil)
+    puts err_msg if err_msg
+    puts usage
+    exit 1
+  end
+
+  def self.supported_modes
+    %W(query)
+  end
+
+  def self.parse_args
+    fatal_error if ARGV.size < 2
+
+    options = {}
+    options[:input_file] = ARGV[0]
+    options[:mode] = ARGV[1]
+    options[:mode_args] = ARGV[2..-1]
+
+    fatal_error("Invalid mode") unless self.supported_modes.include?(options[:mode])
+
+    return options
+  end
+
+  public
+  def self.execute
+    options = parse_args
+    blocks = Parser.parse_blocks(options[:input_file])
+
+    case options[:mode]
+    when 'query' then
+      query = Query.new(blocks, options)
+      query.run
+    else puts "Mode not implemented"; exit 1
+    end
+  end
+end

data/lib/logtool/block.rb

@@ -0,0 +1,44 @@
+module LogTool
+  class Block
+    attr_accessor :text, :ip, :method, :response, :asset, :time
+
+    def to_s
+      @text
+    end
+
+    def is_asset?
+      @asset
+    end
+
+    def head
+      @text.split("\n").first
+    end
+
+    def tail
+      @text.split("\n").last
+    end
+
+    def self.head
+      #$1 = method, $2 = IP
+      /^Started (GET|POST|PUT|DELETE) ".+?" for (\d\d?\d?.\d\d?\d?.\d\d?\d?.\d\d?\d?) at .*$/
+    end
+
+    def self.tail
+      # $1 = response
+      time = /\d+(ms|s)/
+        /^Completed (\d\d\d) .+? in (\d+ms)$/
+    end
+
+    def self.asset_tail
+      # $1 = response, $2 = time
+      time = /\d+(ms|s)/
+        /^Served asset [0-9a-zA-Z\/._]+ - (\d\d\d) .*? \((\d+ms)\)$/
+    end
+
+    def test_for(query)
+      eval query
+    rescue => e
+      LogTool::fatal_error("Bad filter. #{e.message}")
+    end
+  end
+end

data/lib/logtool/parser.rb

@@ -0,0 +1,45 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "block.rb")
+
+module LogTool
+  class Parser
+
+    def self.open_log(file_path)
+      yield File.open(file_path)
+    rescue Errno::ENOENT
+      puts "#{file_path}: No such file or directory"
+      exit 1
+    rescue Errno::EACCES
+      puts "#{file_path}: Permission denied"
+      exit 2
+    end
+
+    def self.parse_blocks(file_path)
+      blocks = []
+      block = nil
+      open_log(file_path) do |fh|
+        fh.read.split("\n").each do |line|
+          if line =~ Block.head
+            blocks << block if block
+            block = Block.new
+            block.method = $1
+            block.ip = $2
+            block.text = line + "\n"
+          elsif block and line =~ Block.tail
+            block.response = $1
+            block.time = $2
+            block.text += line + "\n"
+            block.freeze
+          elsif block and line =~ Block.asset_tail
+            block.response = $1
+            block.time = $2
+            block.text += line + "\n"
+            block.freeze
+          else
+            block.text += line + "\n" if block and !block.frozen?
+          end
+        end
+      end
+      return blocks
+    end
+  end
+end

data/lib/logtool/query.rb

@@ -0,0 +1,50 @@
+module LogTool
+  class Query
+    def initialize(blocks, options)
+      @blocks = blocks
+      @filter = parse_filter(options[:mode_args])
+      @target_data = parse_target_data(options[:mode_args])
+    end
+
+    def target_data_type
+      %W(ip head tail method time)
+    end
+
+    def parse_target_data(args)
+      if target_data_type.include?(args[1])
+        args[1]
+      else
+        LogTool::fatal_error("Undefined target data type: #{args[1]}")
+      end
+    end
+
+    def keywords
+      target_data_type + %W(ip and or not < > <= >= == != asset)
+    end
+
+    def ip_regexp
+      /\d\d?\d?\.\d\d?\d?\.\d\d?\d?\.\d\d?\d?/
+    end
+
+    def parse_filter(options)
+      filter = []
+      options.first.split.each do |word|
+        if keywords.include?(word) 
+          filter << word
+        elsif word =~ ip_regexp 
+          filter << "\"#{word}\""
+        elsif word =~ /\d+/ 
+          filter << word
+        else
+          LogTool::fatal_error("Invalid filter keyword: #{word}")
+        end
+      end
+      filter.join(' ')
+    end
+
+    def run
+      @blocks.find_all{|b| b.test_for(@filter)}.each{|b| puts b.send(@target_data)}
+    end
+
+  end
+end

data/logtool.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+	s.name = "logtool"
+	s.version = "0.0.1"
+	s.platform = Gem::Platform::RUBY
+	s.authors = ["Felipe Tanus"]
+	s.email = ["fotanus@jgmail.com"]
+	s.homepage = "https://github.com/fotanus/logtool"
+	s.summary = %q{logtool is a Rails log parser}
+	s.description = %q{logtool is a Rails log parser that can accepts complex queries}
+	s.files = `git ls-files`.split("\n")
+	s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+	s.require_paths = ["lib"]
+	s.extra_rdoc_files = [
+		"README.md"
+	]
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: logtool
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Felipe Tanus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-17 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: logtool is a Rails log parser that can accepts complex queries
+email: 
+- fotanus@jgmail.com
+executables: 
+- logtool
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/logtool
+- lib/logtool.rb
+- lib/logtool/block.rb
+- lib/logtool/parser.rb
+- lib/logtool/query.rb
+- logtool.gemspec
+has_rdoc: true
+homepage: https://github.com/fotanus/logtool
+licenses: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: logtool is a Rails log parser
+test_files: []
+