bind_log_analyzer 0.2.3 → 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73d6e2a5532462fc85106a803d3398cd85c038af
+  data.tar.gz: 93b13cf73e6491fbc2a836e5cd39f42a7e8d3b19
+SHA512:
+  metadata.gz: 2c948ff70f1a7f56c0000996a6ecff63525d8450c1e849b2f71303f7c41e55dd91c23021f994fb7397792eef0b595c130753542cfda2150b89495930dbc39fa1
+  data.tar.gz: c6488eadea3f12fc2afd3effd3b99ca6756ee67c737c2939cb5795cef2f811800583de2a7f2611908ab28c89cae1d9cdecc9e9453056c2d3379de9ce1abf3813

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -9,7 +9,7 @@ The gem includes a web interface to analyze the data collected from the analyzed
 
 This gem was tested with:
 
-- ruby-1.9.3-p125
+- ruby-2.1.x
 - rubygem (1.8.15)
 - bundler (1.0.21)
 - activerecord (3.2.2)
@@ -48,15 +48,17 @@ or the regexp will fail :(
 To store the logs you can use every database supported by ActiveRecord. Just create a database and a user with the right privileges. You can provide the -s flag to *BindLogAnalyzer* to make it create the table. Otherwise create it by yourself.
 This is the MySQL CREATE TABLE syntax:
 
-    CREATE TABLE `logs` (
-      `id` int(11) NOT NULL AUTO_INCREMENT,
-      `date` datetime NOT NULL,
-      `client` varchar(255) NOT NULL,
-      `query` varchar(255) NOT NULL,
-      `q_type` varchar(255) NOT NULL,
-      `server` varchar(255) NOT NULL,
-      PRIMARY KEY (`id`)
-    ) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=latin1;
+```
+CREATE TABLE `logs` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `date` datetime NOT NULL,
+  `client` varchar(255) NOT NULL,
+  `query` varchar(255) NOT NULL,
+  `q_type` varchar(255) NOT NULL,
+  `server` varchar(255) NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=latin1;
+```
 
 ## Usage
 
@@ -84,7 +86,7 @@ The database credentials can be provided using the needed flags or creating a YA
       host: localhost
       port: 3306
       username: root
-      password:  
+      password:
 
 There are two usage of the gem:
 
@@ -108,7 +110,7 @@ A good way to use this script is to let it be launched by **logrotate** so creat
                 exec su - YOUR_USER -c '/usr/local/bin/update_bind_log_analyzer.sh /var/log/named/query.log.1'
             fi
         endscript
-    } 
+    }
 
 The script **/usr/local/bin/update_bind_log_analyzer.sh** can be wherever you prefer. Its typical content if you use RVM and a dedicated gemset for *BindLogAnalyzer*, can be:
 
@@ -132,14 +134,45 @@ The script **/usr/local/bin/update_bind_log_analyzer.sh** can be wherever you pr
 
 On a 1.6 Ghz Intel Core i5 with SSD SATA2 disk, using Ruby-1.9.3-p125 and MySQL 5.5.15, this is the performance:
 
-    ~$ time bind_log_analyzer -f query.log -c database.yml   
+    ~$ time bind_log_analyzer -f query.log -c database.yml
     Analyzed 319758 lines and correctly stored 319758 logs
     bind_log_analyzer -f query.log -c database.yml  322,44s user 22,90s system 76% cpu 7:33,17 total
-    
+
 which is equivalent to ±706 query/sec.
 
+## Development
+
+First, create a database and add its credentials in the `database.yml` file.
+
+Then create the `logs` table with the following query:
+
+```
+CREATE TABLE `logs` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `date` datetime NOT NULL,
+  `client` varchar(255) NOT NULL,
+  `query` varchar(255) NOT NULL,
+  `q_type` varchar(255) NOT NULL,
+  `server` varchar(255) NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=latin1;
+```
+
+### Run tests
+
+```
+bundle exec rspec
+```
+
 ## Changelog
 
+###0.2.4
+
+Support both old and new Bind log versions
+Add `--bind` option to the cli to bind Sinatra on specified IP
+Reverse the order of the last queries in the GUI
+Fix tests
+
 ### 0.2.3
 
 Added the -u|--uniqueness flag to check if a record exists in the db before inserting a new one
@@ -158,4 +191,4 @@ First version including the web interface
 
 ### 0.1.0
 
-First stable version
+First stable version

data/Rakefile

@@ -30,7 +30,7 @@ end
 task :build do
   system "gem build bind_log_analyzer.gemspec"
 end
- 
+
 task :release => :build do
   system "gem push pkg/bind_log_analyzer-#{BindLogAnalyzer::VERSION}.gem"
 end
@@ -66,7 +66,7 @@ SQL
       end
     end
   end
- 
+
   task :environment do
     DATABASE_ENV = ENV['DATABASE_ENV'] || 'development'
     MIGRATIONS_DIR = ENV['MIGRATIONS_DIR'] || 'db/migrate'
@@ -107,4 +107,4 @@ SQL
   task :version => :configure_connection do
     puts "Current version: #{ActiveRecord::Migrator.current_version}"
   end
-end
+end

data/bin/bind_log_analyzer

@@ -8,6 +8,7 @@ require "optparse"
 @database_confs = nil
 @setup_database = false
 @webserver = false
+@webserver_ip = nil
 @webserver_port = nil
 @db_yaml = nil
 @db_adapter = 'mysql2'
@@ -47,6 +48,11 @@ optparse = OptionParser.new do |opts|
     @webserver_port = opt if opt != true
   end
 
+  opts.on( '-b', '--bind [IP_ADDRESS]', "Sinatra will listen on the specified IP (default: 127.0.0.1)" ) do |opt|
+    @webserver = true
+    @webserver_ip = opt if opt != true
+  end
+
   opts.on( '-s', '--setup', "Creates the needed tables in the database." ) do |opt|
     @setup_database = true
   end
@@ -116,15 +122,16 @@ EOF
   @log_level = 1 if @log_level == 0
   logger = BindLogAnalyzer::LogUtils.set_log_level(@log_level)
   BindLogAnalyzer::Connector.establish_connection(@database_confs, logger)
-  if @webserver_port
-    BindLogAnalyzer::WebServer.run!({ port: @webserver_port.to_i})
-  else
-    BindLogAnalyzer::WebServer.run!
-  end
+
+  @webserver_ip ||= '127.0.0.1'
+  @webserver_port ||= "4567"
+  puts @webserver_ip
+  BindLogAnalyzer::WebServer.run!({ bind: @webserver_ip, port: @webserver_port.to_i})
+
 elsif @filename
   base = BindLogAnalyzer::Base.new(@database_confs, @filename, @setup_database, @log_level, @check_uniq)
   base.analyze
 else
   puts optparse.banner
   exit -1
-end
+end

data/bind_log_analyzer.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
   s.add_dependency "json"
   s.add_dependency "sinatra"
   s.add_dependency "haml"
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "simplecov"
+  s.add_development_dependency "pry"
 end

data/lib/bind_log_analyzer/base.rb

@@ -12,7 +12,7 @@ module BindLogAnalyzer
     # @attribute [r]
     # @return [String] The file containing the logs to be analyzed
     attr_reader :log_filename
-    
+
     # The constructor of BindLogAnalyzer::Base sets some vars and manages the setup of the database
     # @param [Hash, String] database_params The path to the database configurations file or a hash containing such informations
     # @param [String] logfile The path to the file containing the Bind's logs to analyze
@@ -35,7 +35,7 @@ module BindLogAnalyzer
       if FileTest.exists?(logfile)
         @log_filename = logfile
       else
-        @log.error = "The provided log file doesn't exist"
+        @log.error("The provided log file doesn't exist")
       end
     end
 
@@ -50,14 +50,20 @@ module BindLogAnalyzer
     # @return [Hash, false] The hash containing the parsed line or false if the line couldn't be parsed
     def parse_line(line)
       query = {}
-      regexp = %r{^(\d{2}-\w{3}-\d{4}\s+\d{2}:\d{2}:\d{2}\.\d{3})\s+client\s+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})#\d+:\s+query:\s+(.*)\s+IN\s+(\w+)\s+\+\s+\((\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\)$}
-      
+      regexp =     /^(\d{2}-\w{3}-\d{4}\s+\d{2}:\d{2}:\d{2}\.\d{3})\s+client\s+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})#\d+\s+\(.+\):\s+query:\s+(.*)\s+IN\s+(\w+)\s+\+\s+\((\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\)$/
+      old_regexp = /^(\d{2}-\w{3}-\d{4}\s+\d{2}:\d{2}:\d{2}\.\d{3})\s+client\s+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})#\d+:\s+query:\s+(.*)\s+IN\s+(\w+)\s+\+\s+\((\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\)$/
+
       parsed_line = line.scan(regexp)
+      # Try the old version
+      if parsed_line.size == 0
+        parsed_line = line.scan(old_regexp)
+      end
+
       if parsed_line.size > 0
         # Parse timestamp
         parsed_timestamp = Date._strptime(parsed_line[0][0], "%d-%b-%Y %H:%M:%S.%L")
         query_time = Time.local(parsed_timestamp[:year], parsed_timestamp[:mon], parsed_timestamp[:mday], parsed_timestamp[:hour], parsed_timestamp[:min], parsed_timestamp[:sec], parsed_timestamp[:sec_fraction], parsed_timestamp[:zone])
-        
+
         query[:date]    = query_time
         query[:client]  = parsed_line[0][1]
         query[:query]   = parsed_line[0][2]
@@ -71,7 +77,7 @@ module BindLogAnalyzer
       end
     end
 
-    # Stores the parsed log line into the database and increments @stored_queries if successful. 
+    # Stores the parsed log line into the database and increments @stored_queries if successful.
     # It checks the uniqueness of a record if the @check_uniq flag is set
     # @param [Hash] query The log line parsed by #parse_line
     def store_query(query)
@@ -97,7 +103,7 @@ module BindLogAnalyzer
     # @return [true, false] False if there's a problem with the log file. True elsewhere.
     def analyze
       return false unless @log_filename
-      
+
       lines = 0
       File.new(@log_filename).each do |line|
         @log.debug "Got line: \"#{line}\""
@@ -112,4 +118,4 @@ module BindLogAnalyzer
       return true
     end
   end
-end
+end

data/lib/bind_log_analyzer/version.rb

@@ -1,4 +1,4 @@
 module BindLogAnalyzer
   # @return [String] The version of the gem
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/bind_log_analyzer/web_server.rb

@@ -9,19 +9,19 @@ module BindLogAnalyzer
 
     set :static, true
     set :public_folder, File.expand_path('../../../resources/assets/', __FILE__)
-  
+
     set :views,  File.expand_path('../../../resources/views/', __FILE__)
     set :haml, { :format => :html5 }
 
     # Root serving Backbone.js
     get '/' do
-      @logs = Log.limit(30)
+      @logs = Log.last_queries
       haml :index, :layout => :layout
     end
 
     # Last 30 queries
     get '/last_queries' do
-      @logs = Log.limit(30)
+      @logs = Log.last_queries
       haml :last_queries, :layout => :layout
     end
 
@@ -42,4 +42,4 @@ module BindLogAnalyzer
       { :key1 => 'value1', :key2 => 'value2' }.to_json
     end
   end
-end
+end

data/lib/models/log.rb

@@ -1,6 +1,10 @@
 # The Log object represents a log line of a Bind's query
 class Log < ActiveRecord::Base
-  
+  # Shows last 30 queries
+  def self.last_queries
+    self.order(date: :desc).limit(30)
+  end
+
   # Shows 50 top queries
   def self.top_queries
     self.select('query, count(*) as hits').group(:query).order('hits DESC').limit(50)
@@ -10,4 +14,4 @@ class Log < ActiveRecord::Base
   def self.top_clients
     self.select('client, count(*) as hits').group(:client).order('hits DESC').limit(50)
   end
-end
+end

data/spec/bind_log_analyzer_spec.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe BindLogAnalyzer do
   before :all do
-    @db_params = YAML::load(File.open(File.join(File.dirname(__FILE__), '..', 'config', 'databases.yml')))['database']
+    @db_params = YAML::load(File.open(File.join(File.dirname(__FILE__), '..', 'database.yml')))['database']
 
     # Create a test logfile
     @filename = 'test_file.log'
@@ -11,7 +11,7 @@ describe BindLogAnalyzer do
 28-Mar-2012 16:48:32.412 client 192.168.10.201#60303: query: google.com IN AAAA + (192.168.10.1)
 28-Mar-2012 16:48:32.898 client 192.168.10.114#53309: query: www.nasa.gov IN A + (192.168.10.1)
 EOF
-    
+
     File.open(@filename, 'w') { |f| f.write(@doc) } unless FileTest.exists?(@filename)
   end
 
@@ -20,22 +20,14 @@ EOF
     File.delete(@filename) if FileTest.exists?(@filename)
   end
 
-  before :each do
-  end
-
-  #it "can't be instantiated without database params" do
-  #  base = BindLogAnalyzer::Base.new
-  #  ??
-  #end
-
   it "can be instantiated without a logfile" do
     base = BindLogAnalyzer::Base.new(@db_params)
-    base.logfile.should == nil
+    expect(base.logfile).to be_nil
   end
 
   it "permit setting a logfile from initializer" do
     @base = BindLogAnalyzer::Base.new(@db_params, @filename)
-    @base.logfile.should == @filename
+    expect(@base.logfile).to eq(@filename)
   end
 
   it "should update the logfile name" do
@@ -47,7 +39,7 @@ EOF
     File.open(@new_filename, 'w') { |f| f.write(doc) } unless FileTest.exists?(@new_filename)
 
     @base.logfile = @new_filename
-    @base.logfile.should == @new_filename
+    expect(@base.logfile).to eq(@new_filename)
 
     # Delete the file
     File.delete(@new_filename)
@@ -56,31 +48,62 @@ EOF
   it "shouldn't update the logfile name if it doesn't exist" do
     @base = BindLogAnalyzer::Base.new(@db_params, @filename)
     @base.logfile = 'unexisting_test_file'
-    @base.logfile.should_not == 'unexisting_test_file'
+    expect(@base.logfile).not_to eq('unexisting_test_file')
+  end
+
+  it "should correctly parse a Bind log (>= 9.9.x)" do
+    @base = BindLogAnalyzer::Base.new(@db_params, @filename)
+    lines = [
+      {
+        line: "25-Nov-2015 10:29:53.073 client 192.168.16.7#60458 (host.example.com): query: host.example.com IN A + (192.168.16.1)",
+        test_line: {
+          date: Time.local('2015','Nov', 25, 10, 29, 53),
+          client: "192.168.16.7",
+          query: "host.example.com",
+          q_type: "A",
+          server: "192.168.16.1"
+        }
+      },
+      {
+        line: "03-Mar-2016 21:36:47.901 client 192.168.100.105#39709 (cm.g.doubleclick.net): query: cm.g.doubleclick.net IN A + (192.168.100.2)",
+        test_line: {
+          date: Time.local('2016','Mar', 3, 21, 36, 47),
+          client: "192.168.100.105",
+          query: "cm.g.doubleclick.net",
+          q_type: "A",
+          server: "192.168.100.2"
+        }
+      }
+    ]
+
+    lines.each do |obj|
+      parsed_line = @base.parse_line(obj[:line])
+      expect(parsed_line).to eq(obj[:test_line])
+    end
   end
 
-  it "should correctly parse a line" do
+  it "should correctly parse old Bind versions logs" do
     @base = BindLogAnalyzer::Base.new(@db_params, @filename)
     line = "28-Mar-2012 16:48:32.412 client 192.168.10.201#60303: query: google.com IN AAAA + (192.168.10.1)"
     test_line = {
-      date: Time.local('2012','mar',28, 16, 48, 31),
+      date: Time.local('2012','mar',28, 16, 48, 32),
       client: "192.168.10.201",
       query: "google.com",
-      type: "AAAA",
+      q_type: "AAAA",
       server: "192.168.10.1"
     }
     parsed_line = @base.parse_line(line)
-    parsed_line.should == test_line
+    expect(parsed_line).to eq(test_line)
   end
 
-  it "should be connected after setup_db is called" do
-    @base = BindLogAnalyzer::Base.new(@db_params, @filename)
-    @base.connected?.should == true
-  end
+  # it "should be connected after setup_db is called" do
+  #   @base = BindLogAnalyzer::Base.new(@db_params, @filename)
+  #   expect(@base.connected?).to be true
+  # end
 
   it "should be possible to instantiate a Log class after BindLogAnalyzer::Base initialization" do
     @base = BindLogAnalyzer::Base.new(@db_params, @filename)
     log = Log.new
-    log.class.should_not == NilClass
+    expect(log.class).not_to be_instance_of(NilClass)
   end
-end
+end

metadata

@@ -1,82 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: bind_log_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.2.4
 platform: ruby
 authors:
 - Tommaso Visconti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &11031580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11031580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &11031060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11031060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &11131100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11131100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &11130560 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11130560
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
-  requirement: &11130060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11130060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &11129560 !ruby/object:Gem::Requirement
-    none: false
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11129560
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: BindLogAnalyzer analyzes a Bind query log file and stores its data into
   a SQL database using ActiveRecord. It provides a fancy web interface to show some
   query stats and graphs.
@@ -87,7 +132,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - README.md
 - Rakefile
@@ -144,30 +190,28 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/tommyblue/Bind-Log-Analyzer
 licenses: []
+metadata: {}
 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: bind_log_analyzer
-rubygems_version: 1.8.15
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Log analysis and SQL storage for Bind DNS server
 test_files:
 - spec/bind_log_analyzer_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: