Add usage stats gathering

README.md

@@ -58,6 +58,7 @@
       --ui-highlight                highlight words or lines if defined string found in logs, default preset
       --ui-highlight-preset <path>  custom preset for highlighting (see ./preset/default.json)
       --path <path>                 prefix path for the running application, default /
+      --disable-usage-stats         disable gathering usage statistics
 
 Web interface runs on **http://127.0.0.1:[port]**.
 
@@ -121,3 +122,10 @@ http {
     }
 }
 ```
+
+### Usage statistics
+
+`frontail` by default (from `v4.5.0`) gathers __anonymous__ usage statistics in Google Analytics. It can be disabled with
+`--disable-usage-stats`.
+
+The data is used to help me understand how `frontail` is used and I can make it better.

index.js

@@ -12,6 +12,7 @@ const connectBuilder = require('./lib/connect_builder');
 const program = require('./lib/options_parser');
 const serverBuilder = require('./lib/server_builder');
 const daemonize = require('./lib/daemonize');
+const usageStats = require('./lib/stats');
 
 /**
  * Parse args
@@ -22,6 +23,13 @@ if (program.args.length === 0) {
   process.exit();
 }
 
+/**
+ * Init usage statistics
+ */
+const stats = usageStats(!program.disableUsageStats);
+stats.track('runtime', 'init');
+stats.time('runtime', 'runtime');
+
 /**
  * Validate params
  */
@@ -143,10 +151,13 @@ if (program.daemonize) {
     filesSocket.emit('line', line);
   });
 
+  stats.track('runtime', 'started');
+
   /**
    * Handle signals
    */
   const cleanExit = () => {
+    stats.timeEnd('runtime', 'runtime');
     process.exit();
   };
   process.on('SIGINT', cleanExit);

lib/options_parser.js

@@ -55,6 +55,7 @@ program
   .option(
     '--ui-highlight-preset <path>',
     'custom preset for highlighting (see ./preset/default.json)'
-  );
+  )
+  .option('--disable-usage-stats', 'disable gathering usage statistics');
 
 module.exports = program;

lib/stats.js

@@ -0,0 +1,65 @@
+'use strict';
+
+const ua = require('universal-analytics');
+const isDocker = require('is-docker');
+const Configstore = require('configstore');
+const uuidv4 = require('uuid/v4');
+const pkg = require('../package.json');
+
+const trackingID = 'UA-129582046-1';
+
+// Usage stats
+function Stats(enabled) {
+  this.timer = {};
+
+  if (enabled === true) {
+    const config = new Configstore(pkg.name);
+    let clientID = uuidv4();
+    if (config.has('clientID')) {
+      clientID = config.get('clientID');
+    } else {
+      config.set('clientID', clientID);
+    }
+
+    const tracker = ua(trackingID, clientID);
+    tracker.set('aip', 1); // Anonymize IP
+    tracker.set('an', 'frontail'); // Application Name
+    tracker.set('av', pkg.version); // Application Version
+    tracker.set('ds', 'app'); // Data Source
+    tracker.set('cd1', process.platform); // platform
+    tracker.set('cd2', process.arch); // arch
+    tracker.set('cd3', process.version.match(/^v(\d+\.\d+)/)[1]); // Node version
+    tracker.set('cd4', isDocker()); // is Docker
+    this.tracker = tracker;
+  }
+
+  return this;
+}
+
+Stats.prototype.track = function track(category, action) {
+  if (!this.tracker) {
+    return;
+  }
+  this.tracker.event(category, action).send();
+};
+
+Stats.prototype.time = function time(category, action) {
+  if (!this.tracker) {
+    return;
+  }
+
+  if (!this.timer[category]) {
+    this.timer[category] = {};
+  }
+  this.timer[category][action] = Date.now();
+};
+
+Stats.prototype.timeEnd = function timeEnd(category, action) {
+  if (!this.tracker) {
+    return;
+  }
+
+  this.tracker.timing(category, action, Date.now() - this.timer[category][action]).send();
+};
+
+module.exports = enabled => new Stats(enabled);