apache_log_report 0.9.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d75b1094318f7610f0ef9f0cd34ef7fe5d2ba38effb65514d1ca2dddb90962c
-  data.tar.gz: c0c16a44463d9a808dd6919aaf8aa1c1dfbf16bd589bdef1c8ab6e839dba8c05
+  metadata.gz: be24b7fd62ff47195fe5e19cd2717252a37a687a8d92745add21acc952fc50a3
+  data.tar.gz: 3f5daff6a7447b6acca3a7ef456b148c3de49ff2dee87b75d419763dc2bbe2c4
 SHA512:
-  metadata.gz: af73bf2dd1eec2b9985cc0fa0cf72c7ae1ca0afa91e14eb11e5b6e187d52a81880fe4b3051eba23ad3d5b207d977e0a9132e0644ae51853b8e6d76ff41b7ee1d
-  data.tar.gz: c968b4971563a5164e790392a34d7cda4787a21385f283d6f39c27ae14a4b10bb99c735d7084f562af169337f77e17e22b4a78d7e9cd9d84eca411be0d59b491
+  metadata.gz: d5271fd26059e942a730c649cd6ea00c35b459c3f5b130bd2d0ae707717b3554c90b7adff8364f384e56b5e8782ca147b1fd40f957290aed4a7bc443eb38387c
+  data.tar.gz: 475dfe3e49e76434c620bb75558bc2b5e40c6441fe455fca58d9b70b366a549f76a9d1bbbf9aae4bf5c9e0daa013770cefa9047fa11b8206f7eff4425be54b50

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    apache_log_report (0.9.7)
+      apache_log-parser
+      browser
+      sqlite3
+      terminal-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    apache_log-parser (3.1.2)
+    browser (5.0.0)
+    rake (12.3.3)
+    sqlite3 (1.4.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apache_log_report!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/lib/apache_log_report.rb

@@ -5,52 +5,63 @@ module ApacheLogReport
   #
   require 'optparse'
   require 'optparse/date'
+  require 'apache_log_report/version'
 
   def self.options_parse options
     limit = 30
     args = {} 
 
     opt_parser = OptionParser.new do |opts|
-      opts.banner = "Usage: log-analyzer.rb [options] logfile"
+      opts.banner = "Usage: apache_log_report [options] [logfile]"
 
       opts.on("-lN", "--limit=N", Integer, "Number of entries to show (defaults to #{limit})") do |n|
         args[:limit] = n
       end
 
-      opts.on("-bDATE", "--from-date=DATE", DateTime, "Consider entries after or on DATE") do |n|
+      opts.on("-bDATE", "--begin=DATE", DateTime, "Consider entries after or on DATE") do |n|
         args[:from_date] = n
       end
 
-      opts.on("-eDATE", "--to-date=DATE", DateTime, "Consider entries before or on DATE") do |n|
+      opts.on("-eDATE", "--end=DATE", DateTime, "Consider entries before or on DATE") do |n|
         args[:to_date] = n
       end
 
-      opts.on("-i", "--ignore-crawlers", "Ignore crawlers") do |n|
+      opts.on("-i", "--ignore-crawlers", "Ignore crawlers") do
         args[:ignore_crawlers] = true
       end
 
-      opts.on("-p", "--ignore-selfpoll", "Ignore apaches self poll entries (from ::1)") do |n|
+      opts.on("-p", "--ignore-selfpoll", "Ignore apaches self poll entries (from ::1)") do
         args[:no_selfpoll] = true
       end
 
-      opts.on("-c", "--only-crawlers", "Perform analysis on crawlers only") do |n|
+      opts.on("-c", "--only-crawlers", "Perform analysis on crawlers only") do
         args[:only_crawlers] = true
       end
 
-      opts.on("-u", "--prefix=PREFIX", String, "Prefix to add to all plots (used to run multiple analyses in the same dir)") do |n|
+      opts.on("-uPREFIX", "--prefix=PREFIX", String, "Prefix to add to all plots (used to run multiple analyses in the same dir)") do |n|
         args[:prefix] = n
       end
 
-      opts.on("-w", "--suffix=SUFFIX", String, "Suffix to add to all plots (used to run multiple analyses in the same dir)") do |n|
+      opts.on("-wSUFFIX", "--suffix=SUFFIX", String, "Suffix to add to all plots (used to run multiple analyses in the same dir)") do |n|
         args[:suffix] = n
       end
 
-      opts.on("-c", "--code-export=WHAT", String, "Control :export directive in code blocks (code, results, *both*, none)") do |n|
+      opts.on("-cWHAT", "--code-export=WHAT", String, "Control :export directive in code blocks (code, results, *both*, none)") do |n|
         args[:code_export] = n
       end
       
+      opts.on("-v", "--version", "Prints version information") do
+        puts "apache_log_report version #{ApacheLogReport::VERSION}"
+        puts "Copyright (C) 2020 Adolfo Villafiorita"
+        puts "Distributed under the terms of the MIT license"
+        puts ""
+        puts "Written by Adolfo Villafiorita"
+        exit
+      end
+
       opts.on("-h", "--help", "Prints this help") do
         puts opts
+        puts "This is version #{ApacheLogReport::VERSION}"
         exit
       end
     end
@@ -130,7 +141,7 @@ module ApacheLogReport
           hash[:datetime].iso8601,
           hash[:remote_host],
           hash[:user],
-          hash[:datetime].iso8601 + " " + hash[:remote_host] + " " + hash[:user_agent],
+          hash[:datetime].strftime("%Y-%m-%d") + " " + hash[:remote_host] + " " + hash[:user_agent],
           hash[:request][:method],
           hash[:request][:path],
           (hash[:request][:path] ? File.extname(hash[:request][:path]) : ""),
@@ -175,18 +186,29 @@ module ApacheLogReport
       "true"
     ].compact.join " and "
 
+    # in alternative to sum(size)
+    human_readable_size = <<-EOS
+    CASE 
+    WHEN sum(size) < 1024 THEN sum(size) || ' B' 
+    WHEN sum(size) >=  1024 AND sum(size) < (1024 * 1024) THEN ROUND((CAST(sum(size) AS REAL) / 1024),2) || ' KB' 
+    WHEN sum(size) >= (1024 * 1024)  AND sum(size) < (1024 * 1024 * 1024) THEN ROUND((CAST(sum(size) AS REAL) / (1024 * 1024)),2) || ' MB' 
+    WHEN sum(size) >= (1024 * 1024 * 1024) AND sum(size) < (1024 * 1024 * 1024 *1024) THEN ROUND((CAST(sum(size) AS REAL) / (1024 * 1024 * 1024)),2) || ' GB' 
+    WHEN sum(size) >= (1024 * 1024 * 1024 * 1024) THEN ROUND((CAST(sum(size) AS REAL) / (1024 * 1024 * 1024 * 1024)),2) || ' TB' 
+END AS size
+    EOS
+
     @total_hits = db.execute "SELECT count(datetime) from LogLine where #{@filter}"
     @total_unique_visitors = db.execute "SELECT count(distinct(unique_visitor)) from LogLine where #{@filter}"
-    @total_size = db.execute "SELECT sum(size) from LogLine where #{@filter}"
+    @total_size = db.execute "SELECT #{human_readable_size} from LogLine where #{@filter}"
     @total_days = (Date.parse(@last_day[0][0]) - Date.parse(@first_day[0][0])).to_i
 
-    @daily_distribution = db.execute "SELECT date(datetime), count(datetime), count(distinct(unique_visitor)), sum(size) from LogLine  where #{@filter} group by date(datetime)"
+    @daily_distribution = db.execute "SELECT date(datetime), count(datetime), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{@filter} group by date(datetime)"
 
-    @time_distribution = db.execute "SELECT strftime('%H', datetime), count(datetime), count(distinct(unique_visitor)), sum(size) from LogLine  where #{@filter} group by strftime('%H', datetime)"
+    @time_distribution = db.execute "SELECT strftime('%H', datetime), count(datetime), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{@filter} group by strftime('%H', datetime)"
 
-    @most_requested_pages = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), sum(size) from LogLine where extension == '.html' and #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
+    @most_requested_pages = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where extension == '.html' and #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
 
-    @most_requested_resources = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), sum(size) from LogLine  where #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
+    @most_requested_resources = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
 
     @missed_pages = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and extension == '.html' and #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
 
@@ -208,13 +230,13 @@ module ApacheLogReport
       [x[0], x[1].map { |y| y[1] }].flatten
     }
 
-    @browsers = db.execute "SELECT browser, count(browser), count(distinct(unique_visitor)), sum(size) from LogLine where #{@filter} group by browser order by count(browser) desc"
+    @browsers = db.execute "SELECT browser, count(browser), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by browser order by count(browser) desc"
 
-    @platforms = db.execute "SELECT platform, count(platform), count(distinct(unique_visitor)), sum(size) from LogLine where #{@filter} group by platform order by count(platform) desc"
+    @platforms = db.execute "SELECT platform, count(platform), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by platform order by count(platform) desc"
 
-    @ips =  db.execute "SELECT ip, count(ip), count(distinct(unique_visitor)), sum(size) from LogLine where #{@filter} group by ip order by count(ip) desc limit #{options[:limit]}"
+    @ips =  db.execute "SELECT ip, count(ip), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by ip order by count(ip) desc limit #{options[:limit]}"
 
-    @referers =  db.execute "SELECT referer, count(referer), count(distinct(unique_visitor)), sum(size) from LogLine where #{@filter} group by referer order by count(referer) desc limit #{options[:limit]}"
+    @referers =  db.execute "SELECT referer, count(referer), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by referer order by count(referer) desc limit #{options[:limit]}"
   end
 
 
@@ -236,7 +258,7 @@ module ApacheLogReport
   end
   
   def self.emit options = {}, command, log_file, started_at, ended_at, duration
-    @prefx = options[:prefix]
+    @prefix = options[:prefix]
     @suffix = options[:suffix]
     @export = options[:code_export]
     
@@ -252,7 +274,7 @@ module ApacheLogReport
 
 | Hits                | #{"%10d" % @total_hits[0][0]} |
 | Unique Visitors     | #{"%10d" % @total_unique_visitors[0][0] } |
-| Tx                  | #{"%10d" % @total_size[0][0] } |
+| Tx                  | #{"%10s" % @total_size[0][0]} |
 | Days                | #{"%10d" % @total_days[0][0] } |
 
 * Daily Distribution
@@ -282,8 +304,8 @@ plot data using 1:2 with linespoints lw 3 lc rgb "#0000AA" pointtype 5 title "Hi
 data using 1:2 with filledcurves below x1 linecolor rgb "#0000AA" notitle axes x1y2, \\
 data using 1:3 with linespoints lw 3 lc rgb "#AA0000" pointtype 7 title "Visitors", \\
 data using 1:3 with filledcurves below x1 notitle linecolor rgb "#AA0000", \\
-data using 1:($3+10):3 with labels notitle textcolor rgb "#AA0000", \\
-data using 1:($2+100):2 with labels notitle textcolor rgb "#0000AA" axes x1y2
+data using 1:($3+0.1*$3):3 with labels notitle textcolor rgb "#AA0000", \\
+data using 1:($2+0.1*$2):2 with labels notitle textcolor rgb "#0000AA" axes x1y2
 #+END_SRC
 
 
@@ -312,8 +334,8 @@ set style histogram clustered gap 1
 
 plot data using 2:xtic(1) lc rgb "#0000AA" title "Hits",     \\
 data using 3 lc rgb "#AA0000" title "Visitors" axes x1y2, \\
-data using ($0 - 0.2):($2 + 10):2 with labels title "" textcolor rgb("#0000AA"), \\
-data using ($0 + 0.2):($3 + 10):3 with labels title "" textcolor rgb("#AA0000") axes x1y2
+data using ($0 - 0.2):($2 + 0.1*$2):2 with labels title "" textcolor rgb("#0000AA"), \\
+data using ($0 + 0.2):($3 + 0.1*$3):3 with labels title "" textcolor rgb("#AA0000") axes x1y2
 #+END_SRC
 
 #+BEGIN_SRC gnuplot :var data = time_distribution :results output :exports #{@export} :file #{@prefix}time-traffic#{@suffix}.svg
@@ -333,7 +355,7 @@ set style data histograms
 set style histogram clustered gap 1
 
 plot data using 2:xtic(1) lc rgb "#00AA00" title "Traffic", \\
-data using ($0):($2 + 10):2 with labels title "" textcolor rgb("#00AA00")
+data using ($0):($2 + 0.1*$2):2 with labels title "" textcolor rgb("#00AA00")
 #+END_SRC
 
 * Most Requested Pages
@@ -369,7 +391,7 @@ set style fill solid 0.25
 set boxwidth 0.6
 
 plot data using 2:xtic(1) with boxes lc rgb "#0000AA" title "Hits", \\
-data using ($0):($2+100):2 with labels textcolor rgb "#0000AA"
+data using ($0):($2+0.1*$2):2 with labels textcolor rgb "#0000AA"
 #+END_SRC
 
 * Daily Statuses
@@ -396,9 +418,9 @@ set style histogram clustered gap 1
 plot data using 2:xtic(1) lc rgb "#00AA00" title "2xx",     \\
 data using 3 lc rgb "#0000CC" title "3xx", \\
 data using 4 lc rgb "#AA0000" title "4xx", \\
-data using ($0 - 1. / 4):($2 + 0.5):2 with labels title "" textcolor rgb("#00AA00"), \\
-data using ($0):($3 + 0.5):3 with labels title "" textcolor rgb("#0000CC"), \\
-data using ($0 + 1. / 4):($4 + 0.5):4 with labels title "" textcolor rgb("#AA0000")
+data using ($0 - 1. / 4):($2 + 0.1*$2):2 with labels title "" textcolor rgb("#00AA00"), \\
+data using ($0):($3 + 0.1*$3):3 with labels title "" textcolor rgb("#0000CC"), \\
+data using ($0 + 1. / 4):($4 + 0.1*$4):4 with labels title "" textcolor rgb("#AA0000")
 #+END_SRC
 
 * Browsers
@@ -414,7 +436,7 @@ set style fill solid 0.25
 set boxwidth 0.6
 
 plot data using 2:xtic(1) with boxes lc rgb "#0000AA" title "Hits", \\
-data using ($0):($2+100):2 with labels textcolor rgb "#0000AA"
+data using ($0):($2+0.1*$2):2 with labels textcolor rgb "#0000AA"
 #+END_SRC
 
 * Platforms
@@ -430,7 +452,7 @@ set style fill solid 0.25
 set boxwidth 0.6
 
 plot data using 2:xtic(1) with boxes lc rgb "#0000AA" title "Hits", \\
-data using ($0):($2+100):2 with labels textcolor rgb "#0000AA"
+data using ($0):($2+0.1*$2):2 with labels textcolor rgb "#0000AA"
 #+END_SRC
 
 * IPs
@@ -462,8 +484,8 @@ set style histogram clustered gap 1
 
 plot data using 2:xtic(1) lc rgb "#AA00AA" title "Hits",     \\
 data using 3 lc rgb "#0AAAA0" title "Visits", \\
-data using ($0 - 1. / 3):($2 + 50):2 with labels title "" textcolor rgb("#AA00AA"), \\
-data using ($0 + 1. / 3):($3 + 50):3 with labels title "" textcolor rgb("#0AAAA0")
+data using ($0 - 1. / 3):($2 + 0.1*$2):2 with labels title "" textcolor rgb("#AA00AA"), \\
+data using ($0 + 1. / 3):($3 + 0.1*$3):3 with labels title "" textcolor rgb("#0AAAA0")
 #+END_SRC
 
 * Command Invocation and Performance

data/lib/apache_log_report/version.rb

@@ -1,3 +1,3 @@
 module ApacheLogReport
-  VERSION = "0.9.5"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apache_log_report
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apache_log-parser
@@ -77,6 +77,7 @@ files:
 - ".gitignore"
 - CHANGELOG.org
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.org
 - Rakefile
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Generate a request report in OrgMode format from an Apache log file.