Made log override optional, added prefix, docs

Author: benjaminbojko

packages/content/test/config.js

@@ -12,62 +12,69 @@ const config = {
   },
   "sources": [
     {
-      "id": "spaceships",
+      "id": "dummyjson",
       "type": "json",
       "files": {
-          "spaceships.json": "https://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=spaceship",
-          "rockets.json": "https://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=rocket"
-      },
-      "strip": "services/feeds/",
-      "imageTransforms": [
-        {"scale": 0.75}
-      ]
-    },
-    {
-      "id": "astronauts",
-      "files": {
-        "astronauts.json": "https://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=astronauts"
-      },
-      "strip": "services/feeds/"
-    },
-    {
-      "id": "strapiTest",
-      "type": "strapi",
-      "version": 3,
-      "baseUrl": "http:localhost:1337/",
-      "queries": ["poems"],
-      "limit": 100,
-      "maxNumPages": -1,
-      "pageNumZeroPad": 0,
-    },
-    {
-      "id": "contentfulTest",
-      "type": "contentful",
-      "space": "qc670l0h4zjf",
-      "locale": "en-US",
-      "filename": "content.json",
-      "protocol": "https",
-      "searchParams": {
-        "limit": 1000,
-        "include": 10
-      },
-      "contentTypes": [],
-      "imageParams": {
-        "f": "face",
-        "fit": "crop",
-        "w": 512,
-        "h": 512
+        "photos.json": "https://dummyjson.com/products"
       }
     },
-    {
-      "id": "airtableTest",
-      "type": "airtable",
-      "baseId": "apppsX7HeYHO7rMjd",
-      "defaultView": "Grid view",
-      "tables": ["data"],
-      "keyValueTables": ["settings"],
-      "appendLocalAttachmentPaths": true,
-    }
+    // {
+    //   "id": "spaceships",
+    //   "type": "json",
+    //   "files": {
+    //       "spaceships.json": "https://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=spaceship",
+    //       "rockets.json": "https://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=rocket"
+    //   },
+    //   "strip": "services/feeds/",
+    //   "imageTransforms": [
+    //     {"scale": 0.75}
+    //   ]
+    // },
+    // {
+    //   "id": "astronauts",
+    //   "files": {
+    //     "astronauts.json": "https://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=astronauts"
+    //   },
+    //   "strip": "services/feeds/"
+    // },
+    // {
+    //   "id": "strapiTest",
+    //   "type": "strapi",
+    //   "version": 3,
+    //   "baseUrl": "http:localhost:1337/",
+    //   "queries": ["poems"],
+    //   "limit": 100,
+    //   "maxNumPages": -1,
+    //   "pageNumZeroPad": 0,
+    // },
+    // {
+    //   "id": "contentfulTest",
+    //   "type": "contentful",
+    //   "space": "qc670l0h4zjf",
+    //   "locale": "en-US",
+    //   "filename": "content.json",
+    //   "protocol": "https",
+    //   "searchParams": {
+    //     "limit": 1000,
+    //     "include": 10
+    //   },
+    //   "contentTypes": [],
+    //   "imageParams": {
+    //     "f": "face",
+    //     "fit": "crop",
+    //     "w": 512,
+    //     "h": 512
+    //   }
+    // },
+    // {
+    //   "id": "airtableTest",
+    //   "type": "airtable",
+    //   "baseId": "apppsX7HeYHO7rMjd",
+    //   "defaultView": "Grid view",
+    //   "tables": ["data"],
+    //   "keyValueTables": ["settings"],
+    //   "appendLocalAttachmentPaths": true,
+    // }
   ]
 };
 

packages/launchpad/docs/logging.md

@@ -46,6 +46,7 @@ See: https://github.com/winstonjs/winston#creating-your-own-logger for all avail
 | <a name="module_log-manager.LogOptions+fileOptions">`fileOptions`</a> |  <code>LogFileOptions</code>|  <code>new LogFileOptions(fileOptions)</code>  | Options for individual files and streams. |
 | <a name="module_log-manager.LogOptions+level">`level`</a> |  <code>string</code>|  <code>'info'</code>  | The maximum log level to display in all default logs. |
 | <a name="module_log-manager.LogOptions+format">`format`</a> |  <code>winston.Logform.Format</code>|  <code>LogOptions.DEFAULT\_LOG\_FORMAT</code>  | The format for how each line is logged. |
+| <a name="module_log-manager.LogOptions+overrideConsole">`overrideConsole`</a> |  <code>boolean</code>|  <code>true</code>  | Route all console logs to the log manager. This helps<br>ensure that logs are routed to files and rotated properly.<br><br>This will also freeze the console object, so it can't be<br>modified further during runtime.<br><br>All console logs will be prefixed with `(console)`. |
 
 
 ###  LogFileOptions

packages/utils/lib/log-manager.js

@@ -38,6 +38,7 @@ export class LogOptions {
 		fileOptions = new LogFileOptions(),
 		level = 'info',
 		format = LogOptions.DEFAULT_LOG_FORMAT,
+		overrideConsole = true,
 		...rest
 	} = {}) {
 		/**
@@ -68,6 +69,20 @@ export class LogOptions {
 		 */
 		this.format = format;
 
+		/**
+		 * Route all console logs to the log manager. This helps
+		 * ensure that logs are routed to files and rotated properly.
+		 * 
+		 * This will also freeze the console object, so it can't be
+		 * modified further during runtime.
+		 * 
+		 * All console logs will be prefixed with `(console)`.
+		 * 
+		 * @type {boolean}
+		 * @default true
+		 */
+		 this.overrideConsole = true;
+		
 		Object.assign(this, rest);
 	}
 }
@@ -180,8 +195,10 @@ class LogManager {
 				new winston.transports.DailyRotateFile({ ...this._config.fileOptions, filename: this.getFilePath('launchpad-error', false), level: 'error'}),
 			],
 		});
-
-		this.overrideConsoleMethods();
+		
+		if (this._config.overrideConsole) {
+			this.overrideConsoleMethods();
+		}
 	}
 
 	/**
@@ -219,7 +236,7 @@ class LogManager {
 	 */
 	overrideConsoleMethods() {	
 		// Override console methods
-		const logger = this.getLogger();
+		const logger = this.getLogger('console');
 		console.log = logger.info.bind(logger);
 		console.info = logger.info.bind(logger);
 		console.warn = logger.warn.bind(logger);