apache_log_report 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 742584032338664834cd5c1b669289980e083e68d172827f6517ce040543aa4d
-  data.tar.gz: 1bf08e255feb434ded62589d5c70ea5a6eb83dc1f6a69e60a31cb520eea6b48f
+  metadata.gz: 3ad003b9ae4768923ebb253dc937277372ff9adee264d77eb3db103153d8bcb5
+  data.tar.gz: f843e794726853611240ca3267cfed35666e3a04c030a78426bb524a8e40c632
 SHA512:
-  metadata.gz: 955dbe90321c68f5694aaa892cae97926172ca47b684a0eee1b9f7644dc26a13f853b3b3d20e35cf06872b29db0c06bc16c4c86e69c740ea86fe8768ae92b2a1
-  data.tar.gz: e6d9ebc88435442bfb77faa3cb2eccb94a355e9ca7af44548a7b443531c9fae923e41f5d97201044f71414f2d9894162b593cd15170e255030ab49bd9992e3f0
+  metadata.gz: 9a609336d73e83d15dd97939c1e1282ebe73b82d1b8e6d2cf07d2af769d4ad1e93803e825a38549c198d64f5f7e32637dcb6d3dea39eee14711e23b8adde35a0
+  data.tar.gz: 7fecc82af8cbb5debc54542f271855607479d1f142d1a725175afa51acbcc921f8955f4ba444594abc4e2cda4a6baf30421822c5d01e7d07bffcaf68eadbfe1e

data/README.org

@@ -4,12 +4,80 @@
 
 * Introduction
 
-ApacheLogReport is an Apache log analyzer.
+ApacheLogReport generates reports and statistics from Apache web logs
+in the =combined= format.  Written in Ruby, it runs from the command
+line, it is fast, and it can be installed on any system which supports
+Ruby.
+
+ApacheLogReport moves along the lines of tools such as [[https://goaccess.io/][GoAccess]]
+and [[https://umami.is/][Umami]], focusing on privacy and data-ownership: the data
+generated by ApacheLogReport is stored on your computer and owned by
+you (like it should be).
+
+ApacheLogReport is also inspired by static websites generators:
+statistics are generated from the command line and accessed as static
+HTML files.  By generating static resources, ApacheLogReport
+significantly reduces the attack surface of your webserver and
+installation headaches.
+
+We have, for instance, a cron job running on our servers, generating
+statistics at night.  The generated files are then made available on a
+private area on the web.
+
+Statistics are generated from Apache log formats in the =combined=
+format.  Reports are tailored, but not limited, to web servers serving
+static websites.  No need to install Java Script code on your
+websites, no cookies installed, no user tracking.
+
+ApacheLogReport reports the following data:
+
+- Visitors, hits, unique visitors, bandwidth used
+- Most accessed HTML pages
+- Most accessed resources  
+- Response statuses
+- referers
+- OS, browsers, and devices
+- Streaks: resources accessed by a given IP over time
+- Potential attacks: access to resources which are not meant to be
+  served by a web server serving static websites
+ 
+Filters from the command line allow to analyze specific periods and
+distinguish traffic generated by self polls and crawlers.
+
+ApacheLogReport generates HTML and SQLite outputs.  Moreover, it can
+also generate reports in Org Mode format, which can be then processed
+to various formats (including LaTeX and HTML).
 
 * Installation
 
+  #+begin_src bash
+  gem install apache_log_report
+  #+end_src
+
 * Usage
 
+  #+begin_src bash :results raw output :wrap example
+  apache_log_report --help
+  #+end_src
+
+  #+RESULTS:
+  #+begin_example
+  Usage: apache_log_report [options] [logfile]
+      -l, --limit=N                    Number of entries to show (defaults to 30)
+      -b, --begin=DATE                 Consider entries after or on DATE
+      -e, --end=DATE                   Consider entries before or on DATE
+      -i, --ignore-crawlers            Ignore crawlers
+      -p, --ignore-selfpoll            Ignore apaches self poll entries (from ::1)
+          --only-crawlers              Perform analysis on crawlers only
+      -u, --prefix=PREFIX              Prefix to add to all plots (used to run multiple analyses in the same dir)
+      -w, --suffix=SUFFIX              Suffix to add to all plots (used to run multiple analyses in the same dir)
+      -c, --code-export=WHAT           Control :export directive in Org Mode code blocks (code, results, *both*, none)
+      -f, --format=FORMAT              Output format: html, org, sqlite. Defaults to org mode
+      -v, --version                    Prints version information
+      -h, --help                       Prints this help
+  This is version 1.1.6
+  #+end_example
+
 * Change Log
 
 See the [[file:CHANGELOG.org][CHANGELOG]] file.
@@ -18,13 +86,20 @@ See the [[file:CHANGELOG.org][CHANGELOG]] file.
 
 ** TODO Referers should only include the hostname?
 ** TODO Graphs in HTML output
-** TODO Countries
+** TODO Countries/IP Lookup
 ** TODO Light and Dark Theme
 ** TODO Embed CSS
 ** TODO Declare datatypes in table outputs, so that we can format data
 
 * Compatibility
 
+ApacheLogReport should run on any system on which Ruby runs.
+
+Concerning the outputs:
+
+- The HTML report uses [[https://picturepan2.github.io/spectre/][Spectre.css]] and (will use) [[https://vega.github.io/vega-lite/][Vega Light]], which
+  are downloaded from a CDN
+- Org Mode plots data using [[http://gnuplot.info/][Gnuplot]]
 
 * Author and Contributors
 

data/lib/apache_log_report/version.rb

@@ -1,3 +1,3 @@
 module ApacheLogReport
-  VERSION = "1.1.6"
+  VERSION = "1.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apache_log_report
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors:
 - Adolfo Villafiorita
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Generate analytics from an Apache log file.