Simplify what disabling monitoring does

Author: imbstack

libraries/monitor/package.json

@@ -15,6 +15,7 @@
   "dependencies": {
     "app-root-dir": "^1.0.2",
     "chalk": "^2.4.2",
+    "debug": "^4.1.1",
     "fast-json-stable-stringify": "^2.0.0",
     "serialize-error": "^3.0.0"
   },

libraries/monitor/src/index.js

@@ -53,7 +53,7 @@ class MonitorManager {
   setup({
     level = 'info',
     patchGlobal = true,
-    bailOnUnhandledRejection = false,
+    bailOnUnhandledRejection = true,
     resourceInterval = 60,
     mock = false,
     enable = true,
@@ -69,13 +69,12 @@ class MonitorManager {
     }
     this.alreadySetup = true;
 
-    if (!enable) {
+    if (!enable || mock) {
       patchGlobal = false;
       processName = null;
     }
 
     this.mock = mock;
-    this.enable = enable;
     this.pretty = pretty;
     this.subject = 'root';
     this.metadata = metadata;
@@ -130,7 +129,6 @@ class MonitorManager {
       name: `taskcluster.${this.serviceName}.${this.subject}`,
       service: this.serviceName,
       level: this.levels['root'],
-      enable,
       pretty,
       destination: this.destination,
       metadata,
@@ -139,19 +137,18 @@ class MonitorManager {
     this.rootMonitor = new Monitor({
       logger,
       verify,
-      enable,
       types: this.types,
     });
 
-    if (patchGlobal && enable) {
+    if (patchGlobal) {
       this.uncaughtExceptionHandler = this._uncaughtExceptionHandler.bind(this);
       process.on('uncaughtException', this.uncaughtExceptionHandler);
 
       this.unhandledRejectionHandler = this._unhandledRejectionHandler.bind(this);
       process.on('unhandledRejection', this.unhandledRejectionHandler);
     }
 
-    if (processName && !mock && enable) {
+    if (processName) {
       this.rootMonitor.resources(processName, resourceInterval);
     }
 
@@ -177,8 +174,12 @@ class MonitorManager {
    */
   terminate() {
     this.rootMonitor.stopResourceMonitoring();
-    process.removeListener('uncaughtException', this.uncaughtExceptionHandler);
-    process.removeListener('unhandledRejection', this.unhandledRejectionHandler);
+    if (this.uncaughtExceptionHandler) {
+      process.removeListener('uncaughtException', this.uncaughtExceptionHandler);
+    }
+    if (this.unhandledRejectionHandler) {
+      process.removeListener('unhandledRejection', this.unhandledRejectionHandler);
+    }
     if (this.mock) {
       this.destination.end();
     }
@@ -204,12 +205,10 @@ class MonitorManager {
     return new Monitor({
       types: this.types,
       verify: this.verify,
-      enable: this.enable,
       logger: new Logger({
         name: `taskcluster.${this.serviceName}.${prefix}`,
         service: this.serviceName,
         level: this.levels[prefix] || this.levels.root,
-        enable: this.enable,
         pretty: this.pretty,
         destination: this.destination,
         metadata,

libraries/monitor/src/logger.js

@@ -15,6 +15,17 @@ const LEVELS = {
 };
 
 const LEVELS_REVERSE = [
+  'EMERGENCY',
+  'ALERT',
+  'CRITICAL',
+  'ERROR',
+  'WARNING',
+  'NOTICE',
+  'INFO',
+  'DEBUG',
+];
+
+const LEVELS_REVERSE_COLOR = [
   chalk.red.bold('EMERGENCY'),
   chalk.red.bold('ALERT'),
   chalk.red.bold('CRITICAL'),
@@ -33,14 +44,13 @@ const LEVELS_REVERSE = [
  * later if we want.
  */
 class Logger {
-  constructor({name, service, level, pretty=false, enable=true, destination=process.stdout, metadata=null}) {
+  constructor({name, service, level, pretty=false, destination=process.stdout, metadata=null}) {
     assert(name, 'Must specify Logger name.');
 
     this.name = name;
     this.service = service;
     this.destination = destination;
     this.pretty = pretty;
-    this.enable = enable;
     this.metadata = Object.keys(metadata).length > 0 ? metadata : null;
     this.pid = process.pid;
     this.hostname = os.hostname();
@@ -51,7 +61,7 @@ class Logger {
   }
 
   _log(level, type, fields) {
-    if (!this.enable || level > this.level) {
+    if (level > this.level) {
       return;
     }
 
@@ -98,7 +108,7 @@ class Logger {
         }
         return s;
       }, '');
-      const line = chalk`${(new Date()).toJSON()} ${LEVELS_REVERSE[level]} (${type}): {blue ${message}}{gray ${extra}}\n`;
+      const line = chalk`${(new Date()).toJSON()} ${LEVELS_REVERSE_COLOR[level]} (${type}): {blue ${message}}{gray ${extra}}\n`;
       this.destination.write(line);
     } else {
       this.destination.write(stringify({

libraries/monitor/src/monitor.js

@@ -1,12 +1,12 @@
+const debug = require('debug');
 const assert = require('assert');
 const serializeError = require('serialize-error');
 const TimeKeeper = require('./timekeeper');
 
 class Monitor {
-  constructor({logger, verify = false, enable = true, types = {}}) {
+  constructor({logger, verify = false, types = {}}) {
     this._log = logger;
     this.verify = verify;
-    this.enable = enable;
     this.log = {};
     Object.entries(types).forEach(([name, meta]) => {
       this.register({name, ...meta});
@@ -269,9 +269,6 @@ class Monitor {
     if (!(err instanceof Error)) {
       err = new Error(err);
     }
-    if (!this.enable) {
-      throw err;
-    }
     if (level) {
       if (typeof level === 'string') {
         extra['legacyLevel'] = level;

libraries/monitor/test/logger_test.js

@@ -173,18 +173,4 @@ suite('Logging', function() {
     assert(message.includes('ERROR'));
     assert(message.includes('whatever: foo\\nbar'));
   });
-
-  test('disabling works', function() {
-    const b = new MonitorManager({
-      serviceName: 'taskcluster-level',
-    });
-    b.setup({
-      level: 'debug',
-      mock: true,
-      enable: false,
-    });
-    const m = b.monitor();
-    m.info('something', {whatever: 5}); // This should not get logged
-    assert.equal(b.messages.length, 0);
-  });
 });

services/auth/config.yml

@@ -155,6 +155,7 @@ test:
     signingKey:          not-a-secret-so-you-cant-guess-it
     cryptoKey:           AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=
   monitoring:
+    level: warning
     enable: false
   # Test bucket for STS credentials
   test:

services/built-in-workers/config.yml

@@ -23,4 +23,5 @@ test:
     publishMetaData: false
 
   monitoring:
+    level: warning
     enable: false

services/github/config.yml

@@ -127,7 +127,8 @@ test:
     accountId: 'jungle'
 
   monitoring:
-    mock: true
+    level: warning
+    enable: false
 
   server:
     port: 60415

services/hooks/config.yml

@@ -72,6 +72,7 @@ test:
     signingKey:       'not a secret'
     cryptoKey:        'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA='
   monitoring:
+    level: warning
     enable: false
   server:
     port:             60401

services/index/config.yml

@@ -100,6 +100,7 @@ test:
     listenerQueueName: 'test-queue'
 
   monitoring:
+    level: warning
     enable: false
   server:
     port: 60020

services/login/config.yml

@@ -71,6 +71,7 @@ ngrok:
       clientId:     !env TASKCLUSTER_CLIENT_ID
       accessToken:  !env TASKCLUSTER_ACCESS_TOKEN
   monitoring:
+    level: warning
     enable: false
   server:
     port: 60174

services/notify/config.yml

@@ -82,6 +82,7 @@ test:
   azure:
     accountId:        'jungle'
   monitoring:
+    level: warning
     enable: false
   server:
     port:             60401

services/purge-cache/config.yml

@@ -63,8 +63,8 @@ test:
     cachePurgeExpirationDelay:   '7 days'
 
   monitoring:
+    level: warning
     enable: false
-    project: 'taskcluster-purge-cache'
 
   azure:
     accountId:                    'jungle'

services/queue/config.yml

@@ -232,6 +232,7 @@ load-test:
     azureReportChance:            0.0
     azureReportThreshold:         1000000
   monitoring:
+    level: warning
     enable: false
   server:
     env:              development

services/secrets/config.yml

@@ -82,6 +82,7 @@ test:
     signingKey:                   'REALULTIMATEPOWER.NET'
 
   monitoring:
+    level: warning
     enable: false
 
   server:

services/treeherder/config.yml

@@ -32,6 +32,7 @@ defaults:
 
 test:
   monitoring:
+    level: warning
     enable: false
 
 staging:

services/web-server/config.yml

@@ -44,7 +44,7 @@ development:
     # taskcluster-web's dev server assumes port 3050
     port: 3050
   monitoring:
-    project: taskcluster-web-server
+    level: warning
     enable: false
 
 production:

services/worker-manager/config.yml

@@ -34,6 +34,7 @@ test:
   taskcluster:
     rootUrl: 'http://localhost:5555'
   monitoring:
+    level: warning
     enable: false
   server:
     port: 5555