bind_log_analyzer 0.2.1 → 0.2.2

data/doc/BindLogAnalyzer/WebServer.html

@@ -118,7 +118,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:40:26 2012 by 
+  Generated on Tue Apr 10 16:12:42 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/BindLogAnalyzer.html

@@ -73,7 +73,7 @@
   
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/bind_log_analyzer.rb<span class="defines">,<br />
-  lib/bind_log_analyzer/base.rb,<br /> lib/bind_log_analyzer/version.rb,<br /> lib/bind_log_analyzer/connector.rb,<br /> lib/bind_log_analyzer/web_server.rb,<br /> lib/bind_log_analyzer/exceptions.rb</span>
+  lib/bind_log_analyzer/base.rb,<br /> lib/bind_log_analyzer/version.rb,<br /> lib/bind_log_analyzer/connector.rb,<br /> lib/bind_log_analyzer/log_utils.rb,<br /> lib/bind_log_analyzer/web_server.rb,<br /> lib/bind_log_analyzer/exceptions.rb</span>
 </dd>
   
 </dl>
@@ -96,7 +96,7 @@ supported by ActiveRecord.</p>
 <p class="children">
    
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="BindLogAnalyzer/Connector.html" title="BindLogAnalyzer::Connector (module)">Connector</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="BindLogAnalyzer/Connector.html" title="BindLogAnalyzer::Connector (module)">Connector</a></span>, <span class='object_link'><a href="BindLogAnalyzer/LogUtils.html" title="BindLogAnalyzer::LogUtils (module)">LogUtils</a></span>
     
    
     
@@ -141,7 +141,7 @@ supported by ActiveRecord.</p>
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.2</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -157,7 +157,7 @@ supported by ActiveRecord.</p>
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:40:26 2012 by 
+  Generated on Tue Apr 10 16:12:42 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/Log.html

@@ -259,7 +259,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:40:26 2012 by 
+  Generated on Tue Apr 10 16:12:42 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/_index.html

@@ -135,6 +135,13 @@
                 
               </li>
             
+              <li>
+                <span class='object_link'><a href="BindLogAnalyzer/LogUtils.html" title="BindLogAnalyzer::LogUtils (module)">LogUtils</a></span> 
+                
+                  <small>(BindLogAnalyzer)</small>
+                
+              </li>
+            
           </ul>
         </ul>
       
@@ -162,7 +169,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:40:26 2012 by 
+  Generated on Tue Apr 10 16:12:42 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/class_list.html

@@ -39,7 +39,7 @@
 
       <ul id="full_list" class="class">
         <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
-<li><a class='toggle'></a> <span class='object_link'><a href="BindLogAnalyzer.html" title="BindLogAnalyzer (module)">BindLogAnalyzer</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="BindLogAnalyzer/Base.html" title="BindLogAnalyzer::Base (class)">Base</a></span> &lt; Object<small class='search_info'>BindLogAnalyzer</small></li><li><span class='object_link'><a href="BindLogAnalyzer/Connector.html" title="BindLogAnalyzer::Connector (module)">Connector</a></span><small class='search_info'>BindLogAnalyzer</small></li><li><span class='object_link'><a href="BindLogAnalyzer/DatabaseConfsNotValid.html" title="BindLogAnalyzer::DatabaseConfsNotValid (class)">DatabaseConfsNotValid</a></span> &lt; Exception<small class='search_info'>BindLogAnalyzer</small></li><li><span class='object_link'><a href="BindLogAnalyzer/WebServer.html" title="BindLogAnalyzer::WebServer (class)">WebServer</a></span> &lt; Application<small class='search_info'>BindLogAnalyzer</small></li></ul><li><span class='object_link'><a href="Log.html" title="Log (class)">Log</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li>
+<li><a class='toggle'></a> <span class='object_link'><a href="BindLogAnalyzer.html" title="BindLogAnalyzer (module)">BindLogAnalyzer</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="BindLogAnalyzer/Base.html" title="BindLogAnalyzer::Base (class)">Base</a></span> &lt; Object<small class='search_info'>BindLogAnalyzer</small></li><li><span class='object_link'><a href="BindLogAnalyzer/Connector.html" title="BindLogAnalyzer::Connector (module)">Connector</a></span><small class='search_info'>BindLogAnalyzer</small></li><li><span class='object_link'><a href="BindLogAnalyzer/DatabaseConfsNotValid.html" title="BindLogAnalyzer::DatabaseConfsNotValid (class)">DatabaseConfsNotValid</a></span> &lt; Exception<small class='search_info'>BindLogAnalyzer</small></li><li><span class='object_link'><a href="BindLogAnalyzer/LogUtils.html" title="BindLogAnalyzer::LogUtils (module)">LogUtils</a></span><small class='search_info'>BindLogAnalyzer</small></li><li><span class='object_link'><a href="BindLogAnalyzer/WebServer.html" title="BindLogAnalyzer::WebServer (class)">WebServer</a></span> &lt; Application<small class='search_info'>BindLogAnalyzer</small></li></ul><li><span class='object_link'><a href="Log.html" title="Log (class)">Log</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -223,7 +223,7 @@ bind_log_analyzer -f query.log -c database.yml  322,44s user 22,90s system 76% c
 </div></div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:40:26 2012 by 
+  Generated on Tue Apr 10 16:12:42 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -223,7 +223,7 @@ bind_log_analyzer -f query.log -c database.yml  322,44s user 22,90s system 76% c
 </div></div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:40:26 2012 by 
+  Generated on Tue Apr 10 16:12:42 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/doc/method_list.html

@@ -129,9 +129,9 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="BindLogAnalyzer/Connector.html#set_log_level-class_method" title="BindLogAnalyzer::Connector.set_log_level (method)">set_log_level</a></span>
+    <span class='object_link'><a href="BindLogAnalyzer/LogUtils.html#set_log_level-class_method" title="BindLogAnalyzer::LogUtils.set_log_level (method)">set_log_level</a></span>
     
-      <small>BindLogAnalyzer::Connector</small>
+      <small>BindLogAnalyzer::LogUtils</small>
     
   </li>
   

data/doc/top-level-namespace.html

@@ -98,7 +98,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:40:26 2012 by 
+  Generated on Tue Apr 10 16:12:43 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

data/lib/bind_log_analyzer/base.rb

@@ -1,10 +1,12 @@
 require 'bind_log_analyzer/exceptions'
+require 'bind_log_analyzer/log_utils'
 require 'bind_log_analyzer/connector'
 require 'models/log'
 
 module BindLogAnalyzer
   # The main class of the BindLogAnalyzer module
   class Base
+    include BindLogAnalyzer::LogUtils
     include BindLogAnalyzer::Connector
 
     # @attribute [r]
@@ -16,16 +18,25 @@ module BindLogAnalyzer
     # @param [String] logfile The path to the file containing the Bind's logs to analyze
     # @param [true, false] setup_database A flag which indicates whether to launch the database migration
     # @param [Integer] log_level The level of the log requested by the user
-    def initialize(database_params = nil, logfile = nil, setup_database = false, log_level = 0)
+    # @param [true, false] check_uniq Checks if a record exists before creating it
+    def initialize(database_params = nil, logfile = nil, setup_database = false, log_level = 0, check_uniq = false)
       @stored_queries = 0
+      @check_uniq = check_uniq
+
+      @log = BindLogAnalyzer::LogUtils.set_log_level(log_level)
+
       self.logfile = logfile if logfile
-      setup_db(database_params, setup_database, log_level)
+      setup_db(database_params, setup_database)
     end
 
     # Sets the path to the log file checking if exists
     # @param [String] logfile The path to the file containing the Bind's logs to analyze
     def logfile=(logfile)
-      @log_filename = logfile if FileTest.exists?(logfile)
+      if FileTest.exists?(logfile)
+        @log_filename = logfile
+      else
+        @log.error = "The provided log file doesn't exist"
+      end
     end
 
     # Returns the path to the Bind's log file
@@ -55,15 +66,30 @@ module BindLogAnalyzer
 
         query
       else
+        @log.error "Can't parse the line: \"#{line}\""
         false
       end
     end
 
-    # Stores the parsed log line into the database. 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)
-      log = Log.new(query)
-      @stored_queries += 1 if log.save
+      if @check_uniq
+        unless Log.where(query)
+          log = Log.new(:date => query[:date])
+          @stored_queries += 1 if log.save
+        else
+          @log.warn "Skipping duplicate entry: #{query}"
+        end
+      else
+        log = Log.new(query)
+        if log.save
+          @stored_queries += 1
+        else
+          @log.error "Error saving the log #{query}"
+        end
+      end
     end
 
     # The main method used to manage the analysis operations.
@@ -74,8 +100,10 @@ module BindLogAnalyzer
       
       lines = 0
       File.new(@log_filename).each do |line|
+        @log.debug "Got line: \"#{line}\""
         query = self.parse_line(line)
         if query
+          @log.debug "Storing line: \"#{query}\""
           self.store_query(query)
           lines += 1
         end

data/lib/bind_log_analyzer/connector.rb

@@ -1,6 +1,5 @@
 require 'bind_log_analyzer/exceptions'
 require 'active_record'
-require 'logger'
 
 module BindLogAnalyzer
   # The module which provides connection facility
@@ -10,9 +9,8 @@ module BindLogAnalyzer
     # loads the Log ActiveRecord model and setups the logger.
     # @param [Hash] database_params The database params and credentials
     # @param [true, false] setup_database If true launches the migrations of the database
-    # @param [Integer] log_level The log level to setup the Logger
-    def setup_db(database_params, setup_database = false, log_level = 0)
-      BindLogAnalyzer::Connector.setup_db_confs(database_params)
+    def setup_db(database_params, setup_database = false)
+      BindLogAnalyzer::Connector.setup_db_confs(database_params, @log)
 
       BindLogAnalyzer::Connector.connect
 
@@ -20,7 +18,7 @@ module BindLogAnalyzer
 
       self.load_environment
 
-      BindLogAnalyzer::Connector.set_log_level(log_level)
+      ActiveRecord::Base.logger = @log
     end
 
     # Launches ActiveRecord migrations
@@ -43,30 +41,36 @@ module BindLogAnalyzer
 
     # Loads the ActiveRecord models
     def load_environment
-      Dir.glob('./lib/models/*').each { |r| require r }
+      Dir.glob('./lib/models/*').each do |r|
+        @log.debug "Requiring model #{r}"
+        require r
+      end
     end
 
     # Setups the database params calling #setup_db_confs and log level calling #set_log_level then connects to 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
-    def self.establish_connection(database_params, log_level)
-      BindLogAnalyzer::Connector.setup_db_confs(database_params)  
+    def self.establish_connection(database_params, logger)
+      BindLogAnalyzer::Connector.setup_db_confs(database_params, logger)  
       BindLogAnalyzer::Connector.connect
-      BindLogAnalyzer::Connector.set_log_level(log_level)
+      ActiveRecord::Base.logger = logger
     end
 
     # Analyzes the database_params param and extracts the database parameters. Raises BindLogAnalyzer::DatabaseConfsNotValid
     # if it can't find any useful information
     # @param [Hash, String] database_params The path to the database configurations file or a hash containing such informations
-    def self.setup_db_confs(database_params)
+    def self.setup_db_confs(database_params, logger)
       if database_params
         if database_params.instance_of?(Hash)
+          logger.debug "Setting up database with confs: #{database_params}"
           @database_params = database_params
         else
           # Load the yaml file
           if FileTest.exists?(database_params)
+            logger.debug "Setting up database using file #{database_params}"
             @database_params = YAML::load(File.open(database_params))['database']
           else
+            logger.fatal "The indicated YAML file doesn't exist or is invalid"
             raise BindLogAnalyzer::DatabaseConfsNotValid, "The indicated YAML file doesn't exist or is invalid"
           end
         end
@@ -74,28 +78,13 @@ module BindLogAnalyzer
         # Tries to find the yaml file or prints an error
         filename = './database.yml'
         if FileTest.exists?(filename)
+            logger.info "No database configurations provided, now trying using #{filename}..."
             @database_params = YAML::load(File.open(filename))['database']
         else
+          logger.fatal "Can't find valid database configurations"
           raise BindLogAnalyzer::DatabaseConfsNotValid, "Can't find valid database configurations"
         end
       end
     end
-
-    # Sets the log level
-    # @param [String] logfile The path to the file containing the Bind's logs to analyze
-    def self.set_log_level(log_level)
-      if log_level > 0
-        
-        log_level_class = {
-          1 => Logger::WARN,
-          2 => Logger::INFO,
-          3 => Logger::DEBUG
-        }
-
-        log = Logger.new STDOUT
-        log.level = log_level_class[log_level]
-        ActiveRecord::Base.logger = log
-      end
-    end
   end
 end

data/lib/bind_log_analyzer/log_utils.rb

@@ -0,0 +1,28 @@
+require 'bind_log_analyzer/exceptions'
+require 'logger'
+
+module BindLogAnalyzer
+  # Sets log level
+  module LogUtils
+    # Sets the log level
+    # @param [String] logfile The path to the file containing the Bind's logs to analyze
+    def self.set_log_level(log_level)
+      log = Logger.new STDOUT
+
+      if log_level > 0
+        
+        log_level_class = {
+          1 => Logger::ERROR,
+          2 => Logger::WARN,
+          3 => Logger::INFO,
+          4 => Logger::DEBUG
+        }
+
+        log.level = log_level_class[log_level]
+      else
+        log.level = Logger::FATAL
+      end
+      return log
+    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.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bind_log_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-05 00:00:00.000000000 Z
+date: 2012-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &20014180 !ruby/object:Gem::Requirement
+  requirement: &9503660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20014180
+  version_requirements: *9503660
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &20013680 !ruby/object:Gem::Requirement
+  requirement: &9503160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20013680
+  version_requirements: *9503160
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &20113540 !ruby/object:Gem::Requirement
+  requirement: &9603200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20113540
+  version_requirements: *9603200
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &20113000 !ruby/object:Gem::Requirement
+  requirement: &9602620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20113000
+  version_requirements: *9602620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20112500 !ruby/object:Gem::Requirement
+  requirement: &9602120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20112500
+  version_requirements: *9602120
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &20112000 !ruby/object:Gem::Requirement
+  requirement: &9601620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,9 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20112000
-description: BindLogAnalyzer analyzes a Bind query log file and stores it's data into
-  a SQL database (ActiveRecord is used for this feature)
+  version_requirements: *9601620
+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.
 email:
 - tommaso.visconti@gmail.com
 executables:
@@ -98,6 +99,7 @@ files:
 - doc/BindLogAnalyzer/Base.html
 - doc/BindLogAnalyzer/Connector.html
 - doc/BindLogAnalyzer/DatabaseConfsNotValid.html
+- doc/BindLogAnalyzer/LogUtils.html
 - doc/BindLogAnalyzer/WebServer.html
 - doc/Log.html
 - doc/_index.html
@@ -120,6 +122,7 @@ files:
 - lib/bind_log_analyzer/base.rb
 - lib/bind_log_analyzer/connector.rb
 - lib/bind_log_analyzer/exceptions.rb
+- lib/bind_log_analyzer/log_utils.rb
 - lib/bind_log_analyzer/version.rb
 - lib/bind_log_analyzer/web_server.rb
 - lib/models/log.rb