Merge pull request #547 from roemhildtg/feat-enketo-debugger-namespace

feat(app): add enketo namespace to all debug statements

app/controllers/media-controller.js

@@ -8,7 +8,7 @@ const request = require('request');
 const express = require('express');
 
 const router = express.Router();
-const debug = require('debug')('media-controller');
+const debug = require('debug')('enketo:media-controller');
 const {
     RequestFilteringHttpAgent,
     RequestFilteringHttpsAgent,

app/lib/communicator.js

@@ -6,7 +6,7 @@ const request = require('request');
 const { Auth } = require('request/lib/auth');
 const TError = require('./custom-error').TranslatedError;
 const config = require('../models/config-model').server;
-const debug = require('debug')('openrosa-communicator');
+const debug = require('debug')('enketo:openrosa-communicator');
 const Xml2Js = require('xml2js');
 
 const parser = new Xml2Js.Parser();

app/models/cache-model.js

@@ -9,7 +9,7 @@ const utils = require('../lib/utils');
 
 const prefix = 'ca:';
 const expiry = 30 * 24 * 60 * 60;
-const debug = require('debug')('cache-model');
+const debug = require('debug')('enketo:cache-model');
 
 const clientGet = promisify(cacheClient.get).bind(cacheClient);
 const clientSet = promisify(cacheClient.set).bind(cacheClient);

app/models/survey-model.js

@@ -8,7 +8,7 @@ const TError = require('../lib/custom-error').TranslatedError;
 const config = require('./config-model').server;
 
 const pending = {};
-const debug = require('debug')('survey-model');
+const debug = require('debug')('enketo:survey-model');
 
 /**
  * @typedef {import('./account-model').AccountObj} AccountObj

config/express.js

@@ -14,7 +14,7 @@ const errorHandler = require('../app/controllers/error-handler');
 
 const controllersPath = path.join(__dirname, '../app/controllers');
 const app = express();
-const debug = require('debug')('express');
+const debug = require('debug')('enketo:express');
 const config = require('../app/models/config-model');
 
 // general

tutorials/00-getting-started.md

@@ -58,3 +58,11 @@ To configure your own custom external authentication also see [this document](ht
 Run with `npm start` from project root.
 
 You can now check that the app is running by going to e.g. http://localhost:8005 (depending on your server and port set in config/config.json or the port forwarding set up in Vagrant (default is 8006))
+
+### How to enable debug logs
+
+Enketo uses the npm `debug` module. All debug statements are prefixed with `enketo:` and will not appear unless the environment variable is set. To enable debugging logs for enketo specifically, set `DEBUG` as follows:
+
+```bash
+export DEBUG=enketo*
+```