log_sense 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 126257c949e11f090cc1928a1458572529f71c44a5c20baae35861241dfa7b7b
-  data.tar.gz: 33a1ee650598a90ca9adb6a6c2795746dfe8a7735414b22b930d3806b205b318
+  metadata.gz: 40a7ce48ddf73fc434bd0df0265e5d16d39e5034b62714f0324ea2a8b56950ca
+  data.tar.gz: c6e4ce814d0276f3a2c2aeaa20051772695c8bf8c8f53cbe10440415bb301dec
 SHA512:
-  metadata.gz: f135c70480994434dea0b5ff11bac5b1239d071ae38afeda7dd3672a43e127bba06136d550f29844c60dd2d2640a87c57f7fda683240512d1fe37794d124a433
-  data.tar.gz: 65abbe86864aba7d9e6499e6f3ec4a0ef2facf00505ea8611eec3b44279772641bf3a4374045acac0892c8bde19ce37c74a88501fa7905342b1e30032f2b50b4
+  metadata.gz: 3b31c02a784d0e3059500f774b090fd40e099d1facd2382195096194ccdecebb5ce601b26b6c04874cc7446e6e625e91be15966d425fc050f3b0be50c67a6985
+  data.tar.gz: 9b79e356ebcaa21b207c24c9ba4c78e39c6865deb4925413aca51b0ce1b705918ca30b61aa205be447547ac428e038239807f82046a9842f7a9d7753037c5fa5

data/CHANGELOG.org

@@ -2,6 +2,11 @@
 #+AUTHOR: Adolfo Villafiorita
 #+STARTUP: showall
 
+* 1.8.0
+
+- Various improvements to the Rails reports
+- Support for BrowserInfo data
+
 * 1.7.0
 
 - [User] Fixes a bug with the geolocator

data/README.org

@@ -1,11 +1,15 @@
-#+TITLE: README
+#+TITLE: LogSense Readme - Monitor your Rails app easy and fast
 #+AUTHOR: Adolfo Villafiorita
 #+STARTUP: showall
 
 * Introduction
 
-LogSense generates reports and statistics from Apache and Ruby on
-Rails logs.  Written in Ruby, it runs from the command line, it is
+LogSense generates reports and statistics from Apache and Ruby on Rails log
+files.  All the statistics you need to monitor your application, its
+performances, and how users access your app.  Since it collects data from logs,
+there is no need for cookies or other tracking technologies.
+
+LogSense is Written in Ruby, it runs from the command line, it is
 fast, and it can be installed on any system with a relatively recent
 version of Ruby.  We tested on Ruby 2.6.9, Ruby 3.0.x and later.
 
@@ -22,6 +26,11 @@ When generating reports, LogSense reports the following data:
 - IP Country location, thanks to the DP-IP lite country DB
 - Streaks: resources accessed by a given IP over time
 - Performance of Rails requests
+- Rails Fatal Errors (with reference to the logs)
+
+LogSense parses also the data generated by BrowserInfo, providing additional
+information for Rails apps, including devices and platforms and number of
+accesses to methods by device type.
 
 A special output format =ufw= generates rules for the [[https://launchpad.net/ufw][Uncomplicated
 Firewall]] to blacklist IPs requesting URLs matching a specific pattern.
@@ -31,16 +40,16 @@ distinguish traffic generated by self polls and crawlers.
 
 LogSense generates HTML, txt, ufw, and SQLite outputs.
 
-** Apache Report Structure
+** Rails Report Structure
 
 #+ATTR_HTML: :width 80%
-[[file:./screenshots/apache-screenshot.png]]
+[[file:./screenshots/rails-screenshot.png]]
 
 
-** Rails Report Structure
+** Apache Report Structure
 
 #+ATTR_HTML: :width 80%
-[[file:./screenshots/rails-screenshot.png]]
+[[file:./screenshots/apache-screenshot.png]]
 
 
 ** UFW Report
@@ -78,19 +87,16 @@ opened or code executed.
 
 * Motivation
 
-LogSense moves along the lines of tools such as [[https://goaccess.io/][GoAccess]] (which
-strongly inspired the development of Log Sense) and [[https://umami.is/][Umami]], both
-focusing on *privacy* and *data-ownership*: the data generated by
-LogSense is stored on your computer and owned by you (like it should
-be)[fn:1].
-
-LogSense is also inspired by *static websites generators*: statistics
-are generated from the command line and accessed as static HTML files.
-LogSense thus significantly reduces the attack surface of your
-web server 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.
+LogSense moves along the lines of tools such as [[https://goaccess.io/][GoAccess]] and [[https://umami.is/][Umami]], focusing on
+*privacy*, *data-ownership*, and *simplicity*: no need to install JavaScript
+snippets, no tracking cookies, just plain and simple log analysis.
 
+LogSense is also inspired by *static websites generators*: statistics are
+generated from the command line and accessed as static HTML files.  This
+significantly reduces the attack surface of your web server 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.
 
 * Installation
 
@@ -98,7 +104,6 @@ generated files are then made available on a private area on the web.
   gem install log_sense
   #+end_src
 
-
 * Usage
 
   #+begin_src bash :results raw output :wrap example
@@ -108,25 +113,25 @@ generated files are then made available on a private area on the web.
   #+RESULTS:
   #+begin_example
   Usage: log_sense [options] [logfile ...]
-        --title=TITLE                Title to use in the report
-    -f, --input-format=FORMAT        Input format (either rails or apache)
-    -i, --input-files=file,file,     Input files (can also be passed directly)
-    -t, --output-format=FORMAT       Output format: html, org, txt, sqlite.
-    -o, --output-file=OUTPUT_FILE    Output file
-    -b, --begin=DATE                 Consider entries after or on DATE
-    -e, --end=DATE                   Consider entries before or on DATE
-    -l, --limit=N                    Limit to the N most requested resources (defaults to 100)
-    -w, --width=WIDTH                Maximum width of long columns in textual reports
-    -r, --rows=ROWS                  Maximum number of rows for columns with multiple entries in textual reports
-    -p, --pattern=PATTERN            Pattern to use with ufw report to decide IP to blacklist
-    -c, --crawlers=POLICY            Decide what to do with crawlers (applies to Apache Logs)
-        --no-selfpolls               Ignore self poll entries (requests from ::1; applies to Apache Logs)
-    -n, --no-geog                    Do not geolocate entries
-        --verbose                    Inform about progress (output to STDERR)
-    -v, --version                    Prints version information
-    -h, --help                       Prints this help
-
-  This is version 1.6.0
+          --title=TITLE                Title to use in the report
+      -f, --input-format=FORMAT        Log format (stored in log or sqlite3): rails or apache (DEFAULT: apache)
+      -i, --input-files=file,file,     Input file(s), log file or sqlite3 (can also be passed as arguments)
+      -t, --output-format=FORMAT       Output format: html, txt, sqlite, ufw (DEFAULT: html)
+      -o, --output-file=OUTPUT_FILE    Output file. (DEFAULT: STDOUT)
+      -b, --begin=DATE                 Consider only entries after or on DATE
+      -e, --end=DATE                   Consider only entries before or on DATE
+      -l, --limit=N                    Limit to the N most requested resources (DEFAULT: 100)
+      -w, --width=WIDTH                Maximum width of long columns in textual reports
+      -r, --rows=ROWS                  Maximum number of rows for columns with multiple entries in textual reports
+      -p, --pattern=PATTERN            Pattern to use with ufw report to select IP to blacklist (DEFAULT: php)
+      -c, --crawlers=POLICY            Decide what to do with crawlers (applies to Apache Logs)
+          --no-selfpoll                Ignore self poll entries (requests from ::1; applies to Apache Logs) (DEFAULT: false)
+          --no-geo                     Do not geolocate entries (DEFAULT: true)
+          --verbose                    Inform about progress (output to STDERR) (DEFAULT: false)
+      -v, --version                    Prints version information
+      -h, --help                       Prints this help
+
+  This is version 1.8.0
 
   Output formats:
 
@@ -210,8 +215,8 @@ Concerning the outputs:
 
 * Known Bugs
 
-No known bugs; an unknown number of unknown bugs.  (See the open issues for
-the known bugs.)
+We have been running LogSense for quite a few years with no particular issues.
+There are no known bugs; there is an unknown number of unknown bugs.
 
 * License
 
@@ -220,8 +225,3 @@ Source code distributed under the terms of the [[http://opensource.org/licenses/
 Geolocation is made possible by the DB-IP.com IP to City database,
 released under a CC license.
 
-[fn:1] There is a small catch: CSS and JavaScript for layout and plots
-are downloaded from a CDN.  Technically, thus, if you generate HTML
-reports and open them, a request is performed and the CDN might keep a
-track (see [[https://en.wikipedia.org/wiki/Content_delivery_network#Security_and_privacy][CDN Security and Privacy on Wikipedia]] for more details).
-Textual reports don't have this issue.