apache_log_report 0.9.2 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a554ad8352b97f32dd81c004d6b78f1e7d8e2ea284bb7dc7ef18eb3fee7687a
-  data.tar.gz: 0d6e6243eabf89425e174a7ce76948cfd9517fbf3c226a2e77bb746bb43e8223
+  metadata.gz: d6585f8ec0330f9f396aff91cd5f45400e70afd77ab3aee3b780b940bf1fdfb2
+  data.tar.gz: 3c54f1128fb5a407ecd19e12252038ecdc4003fe0dc5ad309eb42e1d4a00126a
 SHA512:
-  metadata.gz: 75a8de1b3375eec45a4ffb41cfa37d834c89ec07e92155d31b2e872e5040fb22709f759bd5aa6bbfc5ed5c84852a9b26c6f603019cb2fb43d21a56a0d33f8eaf
-  data.tar.gz: baa9f268e1e7dcdb72463bf4b4aac1d585524b3ba7db2da1408259f8d54f59424003094372b491791b2788f9f7b3de68a8d1cec8919cd1991ccb5c856677b94c
+  metadata.gz: bf3705b84a912e7a0d6b8b13a26ae12be6da8cba2effbfa136f899e78c9727295035348eaf2d689ff5772de4b03e26790dc8cb2e7b2c84b2043e2f05028c74f4
+  data.tar.gz: fc87021cff6a8a97666d42477dbbc5236199c9c76b25be31cdf0b378ccdb91e853cbfca2faf7cc2c381ff23e440cb434c48e343a714ae7ead965e93633d7f639

data/README.org

@@ -12,6 +12,13 @@
 
 See the [[file:CHANGELOG.org][CHANGELOG]] file.
 
+* Todo
+
+** TODO Version information from command line and in reports
+** TODO Refactor code from one giant class to more manageable chunkes
+** TODO Move performance stats var to class (to isolate vars)
+** TODO Check total number of days (which is not working, now)
+
 * Compatibility
 
 

data/exe/apache_log_report

@@ -16,13 +16,12 @@ if @log_file and not File.exist? @log_file
 end
 
 #
-# Parse Log
+# Parse Log and Track Statistics
 #
 
 @started_at = Time.now
 @db = ApacheLogReport.parse @log_file
 ApacheLogReport.analyze_data @db, @options
-
 @ended_at = Time.now
 @duration = @ended_at - @started_at
 

data/lib/apache_log_report.rb

@@ -5,13 +5,14 @@ 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
@@ -25,28 +26,42 @@ module ApacheLogReport
         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("-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
@@ -58,7 +73,8 @@ module ApacheLogReport
     args[:no_selfpoll] ||= false
     args[:only_crawlers] ||= false
     args[:prefix] ||= ""
-    args[:suffic] ||= ""
+    args[:suffix] ||= ""
+    args[:code_export] ||= "both"
 
     return args
   end
@@ -125,7 +141,7 @@ module ApacheLogReport
           hash[:datetime].iso8601,
           hash[:remote_host],
           hash[:user],
-          hash[:remote_host] + hash[:user_agent],
+          hash[:datetime].iso8601 + " " + hash[:remote_host] + " " + hash[:user_agent],
           hash[:request][:method],
           hash[:request][:path],
           (hash[:request][:path] ? File.extname(hash[:request][:path]) : ""),
@@ -188,8 +204,8 @@ module ApacheLogReport
     @missed_resources = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
 
     @reasonable_requests_exts = [ ".html", ".css", ".js", ".jpg", ".svg", ".png", ".woff", ".xml", ".ttf", ".ico", ".pdf", ".htm", ".txt", ".org" ].map {  |x|
-      "extension == '#{x}'"
-    }.join " or "
+      "extension != '#{x}'"
+    }.join " and "
 
     @attacks = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and #{@filter} and (#{@reasonable_requests_exts}) group by path order by count(path) desc  limit #{options[:limit]}"
 
@@ -231,8 +247,9 @@ 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]
     
 <<EOS
 #+TITLE: Apache Log Analysis: #{log_file}
@@ -253,7 +270,7 @@ module ApacheLogReport
 
 #{ output_table "daily_distribution", ["Day", "Hits", "Visits", "Size"], @daily_distribution }
 
-#+BEGIN_SRC gnuplot :var data = daily_distribution :results output :exports both :file #{@prefix}daily#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = daily_distribution :results output :exports #{@export} :file #{@prefix}daily#{@suffix}.svg
 reset 
 set grid ytics linestyle 0
 set grid xtics linestyle 0
@@ -267,7 +284,8 @@ set xtics rotate by 60 right
 set title "Hits and Visitors"
 set xlabel "Date"
 set ylabel "Hits"
-set ylabel2 "Visits"
+set y2label "Visits"
+set y2tics
 
 set style fill transparent solid 0.2 noborder
 
@@ -285,7 +303,7 @@ data using 1:($2+100):2 with labels notitle textcolor rgb "#0000AA" axes x1y2
 #{ output_table "time_distribution", ["Hour", "Hits", "Visits", "Size"], @time_distribution }
 
 
-#+BEGIN_SRC gnuplot :var data = time_distribution :results output :exports both :file #{@prefix}time#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = time_distribution :results output :exports #{@export} :file #{@prefix}time#{@suffix}.svg
 reset 
 set terminal svg size 1200,800 fname 'Arial' fsize 10
 
@@ -293,7 +311,9 @@ set grid ytics linestyle 0
 
 set title "Hits and Visitors"
 set xlabel "Date"
-set ylabel "Hits and Visits"
+set ylabel "Hits"
+set y2label "Visitors"
+set y2tics
 
 set style fill solid 0.25
 set boxwidth 0.6
@@ -307,7 +327,7 @@ 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
 #+END_SRC
 
-#+BEGIN_SRC gnuplot :var data = time_distribution :results output :exports both :file #{@prefix}time-traffic#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = time_distribution :results output :exports #{@export} :file #{@prefix}time-traffic#{@suffix}.svg
 reset 
 set terminal svg size 1200,800 fname 'Arial' fsize 10
 
@@ -345,13 +365,13 @@ data using ($0):($2 + 10):2 with labels title "" textcolor rgb("#00AA00")
 
 * Possible Attacks
 
-#{ output_table "Attacks", ["Path", "Hits", "Visitors"], @attacks }
+#{ output_table "attacks", ["Path", "Hits", "Visitors"], @attacks }
 
 * Statuses
 
 #{ output_table "statuses", ["Status", "Count"], @statuses }
 
-#+BEGIN_SRC gnuplot :var data = statuses :results output :exports both :file #{@prefix}statuses#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = statuses :results output :exports #{@export} :file #{@prefix}statuses#{@suffix}.svg
 reset 
 set grid ytics linestyle 0
 set terminal svg size 1200,800 fname 'Arial' fsize 10
@@ -367,7 +387,7 @@ data using ($0):($2+100):2 with labels textcolor rgb "#0000AA"
 
 #{ output_table "daily_statuses", ["Status", "2xx", "3xx", "4xx"], @statuses_by_day }
 
-#+BEGIN_SRC gnuplot :var data = daily_statuses :results output :exports both :file #{@prefix}daily-statuses#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = daily_statuses :results output :exports #{@export} :file #{@prefix}daily-statuses#{@suffix}.svg
 reset 
 set terminal svg size 1200,800 fname 'Arial' fsize 10
 
@@ -384,19 +404,19 @@ set boxwidth 0.6
 set style data histograms
 set style histogram clustered gap 1
 
-plot data using 2:xtic(1) lc rgb "#CC0000" title "4xx",     \\
+plot data using 2:xtic(1) lc rgb "#00AA00" title "2xx",     \\
 data using 3 lc rgb "#0000CC" title "3xx", \\
-data using 4 lc rgb "#00AA00" title "2xx", \\
-data using ($0 - 1. / 4):($2 + 0.5):2 with labels title "" textcolor rgb("#CC0000"), \\
+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("#00AA00")
+data using ($0 + 1. / 4):($4 + 0.5):4 with labels title "" textcolor rgb("#AA0000")
 #+END_SRC
 
 * Browsers
 
 #{ output_table "browsers", ["Browser", "Hits", "Visitors", "Size"], @browsers }
 
-#+BEGIN_SRC gnuplot :var data = browsers :results output :exports both :file #{@prefix}browser#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = browsers :results output :exports #{@export} :file #{@prefix}browser#{@suffix}.svg
 reset 
 set grid ytics linestyle 0
 set terminal svg size 1200,800 fname 'Arial' fsize 10
@@ -412,7 +432,7 @@ data using ($0):($2+100):2 with labels textcolor rgb "#0000AA"
 
 #{ output_table "platforms", ["Platform", "Hits", "Visitors", "Size"], @platforms }
 
-#+BEGIN_SRC gnuplot :var data = platforms :results output :exports both :file #{@prefix}platforms#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = platforms :results output :exports #{@export} :file #{@prefix}platforms#{@suffix}.svg
 reset 
 set grid ytics linestyle 0
 set terminal svg size 1200,800 fname 'Arial' fsize 10
@@ -433,7 +453,7 @@ data using ($0):($2+100):2 with labels textcolor rgb "#0000AA"
 
 #{ output_table "referers", ["Referers", "Hits", "Visitors", "Size"], @referers }
 
-#+BEGIN_SRC gnuplot :var data = referers :results output :exports both :file #{@prefix}referers#{@suffix}.svg
+#+BEGIN_SRC gnuplot :var data = referers :results output :exports #{@export} :file #{@prefix}referers#{@suffix}.svg
 reset 
 set terminal svg size 1200,800 fname 'Arial' fsize 10
 

data/lib/apache_log_report/version.rb

@@ -1,3 +1,3 @@
 module ApacheLogReport
-  VERSION = "0.9.2"
+  VERSION = "0.9.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apache_log_report
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.7
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apache_log-parser
@@ -109,7 +109,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.