Split debug setting. Closes hapijs#2247

Eran Hammer · Eran Hammer · commit 98acb52c6f86 · 2014-12-03T00:59:13.000-08:00
diff --git a/docs/Reference.md b/docs/Reference.md
@@ -162,13 +162,23 @@ Creates a new `Server` object where:
           [`server.state()`](#serverstatename-options) or implicitly (without definition) using
           the [state configuration](#serverstatename-options) object.
 
-    - `debug` - determines which logged events are sent to the console:
+    - `debug` - determines which logged events are sent to the console (this should only be used
+      for development and does not affect which events are actually logged internally and
+      recorded). Set to `false` to disable all console logging, or to an object with:
+        - `log` - a string array of server log tags to be displayed via `console.error()` when
+          the events are logged via [`server.log()`](#serverlogtags-data-timestamp) as well as
+          internally generated [server logs](#server-logs). For example, to display all errors,
+          set the option to `['error']`. To turn off all console debug messages set it to `false`.
+          Defaults to uncaught errors thrown in external code (these errors are handled
+          automatically and result in an Internal Server Error response) or runtime errors due to
+          developer error.
         - `request` - a string array of request log tags to be displayed via `console.error()` when
-          the events are logged via [`request.log()`](#requestlogtags-data-timestamp). Defaults to
-          uncaught errors thrown in external code (these errors are handled automatically and
-          result in an Internal Server Error response) or runtime errors due to developer error.
-          For example, to display all errors, change the option to `['error']`. To turn off all
-          console debug messages set it to `false`.
+          the events are logged via [`request.log()`](#requestlogtags-data-timestamp) as well as
+          internally generated [request logs](#request-logs). For example, to display all errors,
+          set the option to `['error']`. To turn off all console debug messages set it to `false`.
+          Defaults to uncaught errors thrown in external code (these errors are handled
+          automatically and result in an Internal Server Error response) or runtime errors due to
+          developer error.
 
     - `files` - file system related settings:
         - `etagsCacheMaxSize` - sets the maximum number of file etag hash values stored in the
diff --git a/lib/defaults.js b/lib/defaults.js
@@ -6,7 +6,10 @@ var Os = require('os');
 // Declare internals
 
 exports.server = {
-    debug: { request: ['implementation'] },
+    debug: {
+        request: ['implementation'],
+        log: ['implementation']
+    },
     load: {
         sampleInterval: 0
     },
diff --git a/lib/plugin.js b/lib/plugin.js
@@ -360,8 +360,8 @@ internals.Plugin.prototype.log = function (tags, data, timestamp, _internal) {
     this.root._events.emit('log', event, tagsMap);
 
     if (this.root._settings.debug &&
-        this.root._settings.debug.request &&
-        Hoek.intersect(tagsMap, this.root._settings.debug.request, true)) {
+        this.root._settings.debug.log &&
+        Hoek.intersect(tagsMap, this.root._settings.debug.log, true)) {
 
         console.error('Debug:', event.tags.join(', '), (data ? '\n    ' + (data.stack || (typeof data === 'object' ? Hoek.stringify(data) : data)) : ''));
     }
diff --git a/lib/schema.js b/lib/schema.js
@@ -174,7 +174,8 @@ internals.server = Joi.object({
     ]).allow(null),
     connections: internals.connectionBase,
     debug: Joi.object({
-        request: Joi.array().allow(false)
+        request: Joi.array().allow(false),
+        log: Joi.array().allow(false)
     }).allow(false),
     files: Joi.object({
         etagsCacheMaxSize: Joi.number().min(0)
diff --git a/test/plugin.js b/test/plugin.js
@@ -1712,9 +1712,9 @@ describe('Plugin', function () {
             done();
         });
 
-        it('does not output events when debug.request disabled', function (done) {
+        it('does not output events when debug.log disabled', function (done) {
 
-            var server = new Hapi.Server({ debug: { request: false } });
+            var server = new Hapi.Server({ debug: { log: false } });
             server.connection();
 
             var i = 0;

Original file line number	Diff line number	Diff line change
`@@ -360,8 +360,8 @@ internals.Plugin.prototype.log = function (tags, data, timestamp, _internal) {`
`360`	`360`	`this.root._events.emit('log', event, tagsMap);`
`361`	`361`
`362`	`362`	`if (this.root._settings.debug &&`
`363`		`- this.root._settings.debug.request &&`
`364`		`- Hoek.intersect(tagsMap, this.root._settings.debug.request, true)) {`
	`363`	`+ this.root._settings.debug.log &&`
	`364`	`+ Hoek.intersect(tagsMap, this.root._settings.debug.log, true)) {`
`365`	`365`
`366`	`366`	`console.error('Debug:', event.tags.join(', '), (data ? '\n ' + (data.stack \|\| (typeof data === 'object' ? Hoek.stringify(data) : data)) : ''));`
`367`	`367`	`}`