bind_log_analyzer 0.2.0 → 0.2.1

data/README.md

@@ -136,4 +136,18 @@ On a 1.6 Ghz Intel Core i5 with SSD SATA2 disk, using Ruby-1.9.3-p125 and MySQL
     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.
+which is equivalent to ±706 query/sec.
+
+## Changelog
+
+### 0.2.1
+
+If the **-c, --config CONFIG** parameter is not specified, it tries to use a *database.yml* file in the directory from where the gem was launched
+
+### 0.2.0
+
+First version including the web interface
+
+### 0.1.0
+
+First stable version

data/database.yml

@@ -0,0 +1,7 @@
+database:
+  adapter: mysql2
+  database: bindloganalyzer
+  host: localhost
+  port: 3306
+  username: root
+  password: 

data/doc/BindLogAnalyzer.html

@@ -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.0</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.1</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:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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/Base.html

@@ -879,7 +879,7 @@ successful</p>
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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/Connector.html

@@ -599,7 +599,7 @@ informations</p>
     <span class='kw'>end</span>
   <span class='kw'>else</span>
     <span class='comment'># Tries to find the yaml file or prints an error
-</span>    <span class='id identifier rubyid_filename'>filename</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>database.yml</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+</span>    <span class='id identifier rubyid_filename'>filename</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>./database.yml</span><span class='tstring_end'>'</span></span>
     <span class='kw'>if</span> <span class='const'>FileTest</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
         <span class='ivar'>@database_params</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='op'>::</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>database</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
     <span class='kw'>else</span>
@@ -874,7 +874,7 @@ if requested, loads the Log ActiveRecord model and setups the logger.</p>
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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/DatabaseConfsNotValid.html

@@ -118,7 +118,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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/WebServer.html

@@ -118,7 +118,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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

@@ -162,7 +162,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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/file.README.html

@@ -56,7 +56,10 @@
     
     <div id="content"><div id='filecontents'><h1>Bind Log Analyzer</h1>
 
-<p>Simple analysis and SQL storage for Bind DNS server&#39;s logs</p>
+<p>Simple analysis and SQL storage for Bind DNS server&#39;s logs.
+The gem includes a web interface to analyze the data collected from the analyzed logs.</p>
+
+<p><img src="http://f.cl.ly/items/0A1A173R3b012R1V2x2b/bind_log_analyzer_screenshot_1.jpg" alt="Bind Log Analyzer web interface"></p>
 
 <h2>Requirements</h2>
 
@@ -123,8 +126,9 @@ This is the MySQL CREATE TABLE syntax:</p>
 
 <pre class="code ruby"><code>-h, --help                       Display this screen
 -v, --verbose LEVEL              Enables verbose output. Use level 1 for WARN, 2 for INFO and 3 for DEBUG
+-w, --webserver [HTTP_PORT]      Launches the Sinatra web server on specified port, or 4567 if omitted
 -s, --setup                      Creates the needed tables in the database.
--f, --file FILE                  Indicates the log file to parse. It's mandatory.
+-f, --file FILE                  Indicates the log file to parse. It's mandatory if you don't specify the --webserver option.
 -c, --config CONFIG              A yaml file containing the database configurations under the &quot;database&quot; entry
 -a, --adapter ADAPTER            The database name to save the logs
 -d, --database DATABASE          The database name to save the logs
@@ -134,8 +138,6 @@ This is the MySQL CREATE TABLE syntax:</p>
 -p, --password PASSWORD          The password of the user
 </code></pre>
 
-<p>There&#39;s only one mandatory argument which is <strong>--file FILE</strong>. With this flag you pass the Bind log file to analyze to <em>BindLogAnalyzer</em>.</p>
-
 <p>The first time you launch <em>BindLogAnalyzer</em> you can use the <strong>-s|--setup</strong> flag to make it create the table (using ActiveRecord::Migration).
 The database credentials can be provided using the needed flags or creating a YAML file containing all the informations under the <strong>database</strong> key. This is an example:</p>
 
@@ -148,6 +150,13 @@ The database credentials can be provided using the needed flags or creating a YA
   password:  
 </code></pre>
 
+<p>There are two usage of the gem:</p>
+
+<ul>
+<li>Use <strong>--file FILE</strong> flag to pass to <em>BindLogAnalyzer</em> the file to analyze.</li>
+<li>Use <strong>-w, --webserver [HTTP_PORT]</strong> to start the Sinatra webserver and watch the stats on the collected data.</li>
+</ul>
+
 <h2>Automatization</h2>
 
 <p>A good way to use this script is to let it be launched by <strong>logrotate</strong> so create the <em>/etc/logrotate.d/bind</em> file with this content:</p>
@@ -198,15 +207,23 @@ bind_log_analyzer -f query.log -c database.yml  322,44s user 22,90s system 76% c
 
 <p>which is equivalent to ±706 query/sec.</p>
 
-<h2>To do</h2>
+<h2>Changelog</h2>
 
-<ul>
-<li>Add a web interface to show the queries (with awesome graphs, obviously :)</li>
-</ul>
+<h3>0.2.1</h3>
+
+<p>If the <strong>-c, --config CONFIG</strong> parameter is not specified, it tries to use a <em>database.yml</em> file in the directory from where the gem was launched</p>
+
+<h3>0.2.0</h3>
+
+<p>First version including the web interface</p>
+
+<h3>0.1.0</h3>
+
+<p>First stable version</p>
 </div></div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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

@@ -56,7 +56,10 @@
     
     <div id="content"><div id='filecontents'><h1>Bind Log Analyzer</h1>
 
-<p>Simple analysis and SQL storage for Bind DNS server&#39;s logs</p>
+<p>Simple analysis and SQL storage for Bind DNS server&#39;s logs.
+The gem includes a web interface to analyze the data collected from the analyzed logs.</p>
+
+<p><img src="http://f.cl.ly/items/0A1A173R3b012R1V2x2b/bind_log_analyzer_screenshot_1.jpg" alt="Bind Log Analyzer web interface"></p>
 
 <h2>Requirements</h2>
 
@@ -123,8 +126,9 @@ This is the MySQL CREATE TABLE syntax:</p>
 
 <pre class="code ruby"><code>-h, --help                       Display this screen
 -v, --verbose LEVEL              Enables verbose output. Use level 1 for WARN, 2 for INFO and 3 for DEBUG
+-w, --webserver [HTTP_PORT]      Launches the Sinatra web server on specified port, or 4567 if omitted
 -s, --setup                      Creates the needed tables in the database.
--f, --file FILE                  Indicates the log file to parse. It's mandatory.
+-f, --file FILE                  Indicates the log file to parse. It's mandatory if you don't specify the --webserver option.
 -c, --config CONFIG              A yaml file containing the database configurations under the &quot;database&quot; entry
 -a, --adapter ADAPTER            The database name to save the logs
 -d, --database DATABASE          The database name to save the logs
@@ -134,8 +138,6 @@ This is the MySQL CREATE TABLE syntax:</p>
 -p, --password PASSWORD          The password of the user
 </code></pre>
 
-<p>There&#39;s only one mandatory argument which is <strong>--file FILE</strong>. With this flag you pass the Bind log file to analyze to <em>BindLogAnalyzer</em>.</p>
-
 <p>The first time you launch <em>BindLogAnalyzer</em> you can use the <strong>-s|--setup</strong> flag to make it create the table (using ActiveRecord::Migration).
 The database credentials can be provided using the needed flags or creating a YAML file containing all the informations under the <strong>database</strong> key. This is an example:</p>
 
@@ -148,6 +150,13 @@ The database credentials can be provided using the needed flags or creating a YA
   password:  
 </code></pre>
 
+<p>There are two usage of the gem:</p>
+
+<ul>
+<li>Use <strong>--file FILE</strong> flag to pass to <em>BindLogAnalyzer</em> the file to analyze.</li>
+<li>Use <strong>-w, --webserver [HTTP_PORT]</strong> to start the Sinatra webserver and watch the stats on the collected data.</li>
+</ul>
+
 <h2>Automatization</h2>
 
 <p>A good way to use this script is to let it be launched by <strong>logrotate</strong> so create the <em>/etc/logrotate.d/bind</em> file with this content:</p>
@@ -198,15 +207,23 @@ bind_log_analyzer -f query.log -c database.yml  322,44s user 22,90s system 76% c
 
 <p>which is equivalent to ±706 query/sec.</p>
 
-<h2>To do</h2>
+<h2>Changelog</h2>
 
-<ul>
-<li>Add a web interface to show the queries (with awesome graphs, obviously :)</li>
-</ul>
+<h3>0.2.1</h3>
+
+<p>If the <strong>-c, --config CONFIG</strong> parameter is not specified, it tries to use a <em>database.yml</em> file in the directory from where the gem was launched</p>
+
+<h3>0.2.0</h3>
+
+<p>First version including the web interface</p>
+
+<h3>0.1.0</h3>
+
+<p>First stable version</p>
 </div></div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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/top-level-namespace.html

@@ -98,7 +98,7 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Apr  5 16:11:31 2012 by 
+  Generated on Thu Apr  5 16:40:26 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/connector.rb

@@ -72,7 +72,7 @@ module BindLogAnalyzer
         end
       else
         # Tries to find the yaml file or prints an error
-        filename = File.join(File.dirname(__FILE__), 'database.yml')
+        filename = './database.yml'
         if FileTest.exists?(filename)
             @database_params = YAML::load(File.open(filename))['database']
         else

data/lib/bind_log_analyzer/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bind_log_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &13957920 !ruby/object:Gem::Requirement
+  requirement: &20014180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13957920
+  version_requirements: *20014180
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &13957420 !ruby/object:Gem::Requirement
+  requirement: &20013680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13957420
+  version_requirements: *20013680
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &14057240 !ruby/object:Gem::Requirement
+  requirement: &20113540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14057240
+  version_requirements: *20113540
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &14056740 !ruby/object:Gem::Requirement
+  requirement: &20113000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14056740
+  version_requirements: *20113000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14056200 !ruby/object:Gem::Requirement
+  requirement: &20112500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14056200
+  version_requirements: *20112500
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &14055700 !ruby/object:Gem::Requirement
+  requirement: &20112000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14055700
+  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)
 email:
@@ -92,6 +92,7 @@ files:
 - Rakefile
 - bin/bind_log_analyzer
 - bind_log_analyzer.gemspec
+- database.yml
 - db/migrate/20120329151738_create_logs.rb
 - doc/BindLogAnalyzer.html
 - doc/BindLogAnalyzer/Base.html