✨ Added logging to n8n (#1381)

* Added logging to n8n

This commit adds logging to n8n using the Winston library.

For now, this commit only allows logging to console (default behavior)
or file (need to pass in config via environment variables).

Other logging methods can be further implemented using hooks. These were
skipped for now as it would require adding more dependencies.

Logging level is notice by default, meaning no additional messages would
be displayed at the moment. Logging level can be set to info or debug as
well to enrich the generated logs.

The ILogger interface was added to the workflow project as it would make
it available for all other projects but the implementation was done on
the cli project.

* Lint fixes and logging level naming. Also fixed the way we use the logger as it was not working previously

* Improvements to logging framework

Using appropriate single quotes
Improving the way the logger is declared

* Improved naming for Log Types

* Removed logger global variable, replacing it by a proxy

* Add logging to CLI commands

* Remove unused GenericHelpers

* Changed back some messages to console instead of logger and added npm
shortcuts for worker and webhook

* Fix typos

* Adding basic file rotation to logs as suggested by @mutdmour

* Fixed linting issues

* Correcting comment to correctly reflect space usage

* Added settings for log files rotation

* Correcting config type from String to Number

* Changed default file settings to number

To reflect previous changes to the type

* Changed the way log messages are added to be called statically. Also minor naming improvements

* Applying latest corrections sent by @ivov

* ⚡ Some logging improvements

* Saving logs to a folder inside n8n home instead of root

* Fixed broken tests and linting

* Changed some log messages to improve formatting

* Adding quotes to names  on log messages

* Added execution and session IDs to logs. Also removed unnecessary line breaks

* ⚡ Added file caller to log messages (#1657)

This is done using callsites library which already existed
in the project as another library's dependency. So in fact
it does not add any new dependency.

* Adding logs to help debug Salesforce node

* ⚡ Add function name to logs and add more logs

* ⚡ Improve some error messages

* ⚡ Improve some more log messages

* ⚡ Rename logging env variables to match others

Co-authored-by: dali <servfrdali@yahoo.fr>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>

packages/cli/commands/worker.ts

@@ -37,6 +37,14 @@ import {
 	WorkflowExecuteAdditionalData,
 } from '../src';
 
+import { 
+	getLogger,
+} from '../src/Logger';
+
+import {
+	LoggerProxy,
+} from 'n8n-workflow';
+
 import * as config from '../config';
 import * as Bull from 'bull';
 import * as Queue from '../src/Queue';
@@ -71,7 +79,7 @@ export class Worker extends Command {
 	 * get removed.
 	 */
 	static async stopProcess() {
-		console.log(`\nStopping n8n...`);
+		LoggerProxy.info(`Stopping n8n...`);
 
 		// Stop accepting new jobs
 		Worker.jobQueue.pause(true);
@@ -95,7 +103,7 @@ export class Worker extends Command {
 			while (Object.keys(Worker.runningJobs).length !== 0) {
 				if (count++ % 4 === 0) {
 					const waitLeft = Math.ceil((stopTime - new Date().getTime()) / 1000);
-					console.log(`Waiting for ${Object.keys(Worker.runningJobs).length} active executions to finish... (wait ${waitLeft} more seconds)`);
+					LoggerProxy.info(`Waiting for ${Object.keys(Worker.runningJobs).length} active executions to finish... (wait ${waitLeft} more seconds)`);
 				}
 				await new Promise((resolve) => {
 					setTimeout(resolve, 500);
@@ -103,7 +111,7 @@ export class Worker extends Command {
 			}
 
 		} catch (error) {
-			console.error('There was an error shutting down n8n.', error);
+			LoggerProxy.error('There was an error shutting down n8n.', error);
 		}
 
 		process.exit(Worker.processExistCode);
@@ -113,7 +121,7 @@ export class Worker extends Command {
 		const jobData = job.data as IBullJobData;
 		const executionDb = await Db.collections.Execution!.findOne(jobData.executionId) as IExecutionFlattedDb;
 		const currentExecutionDb = ResponseHelper.unflattenExecutionData(executionDb) as IExecutionResponse;
-		console.log(`Start job: ${job.id} (Workflow ID: ${currentExecutionDb.workflowData.id} | Execution: ${jobData.executionId})`);
+		LoggerProxy.info(`Start job: ${job.id} (Workflow ID: ${currentExecutionDb.workflowData.id} | Execution: ${jobData.executionId})`);
 
 		let staticData = currentExecutionDb.workflowData!.staticData;
 		if (jobData.loadStaticData === true) {
@@ -170,7 +178,10 @@ export class Worker extends Command {
 	}
 
 	async run() {
-		console.log('Starting n8n worker...');
+		const logger = getLogger();
+		LoggerProxy.init(logger);
+
+		console.info('Starting n8n worker...');
 
 		// Make sure that n8n shuts down gracefully if possible
 		process.on('SIGTERM', Worker.stopProcess);
@@ -183,11 +194,12 @@ export class Worker extends Command {
 
 				// Start directly with the init of the database to improve startup time
 				const startDbInitPromise = Db.init().catch(error => {
-					console.error(`There was an error initializing DB: ${error.message}`);
+					logger.error(`There was an error initializing DB: "${error.message}"`);
 
 					Worker.processExistCode = 1;
 					// @ts-ignore
 					process.emit('SIGINT');
+					process.exit(1);
 				});
 
 				// Make sure the settings exist
@@ -221,10 +233,10 @@ export class Worker extends Command {
 
 				const versions = await GenericHelpers.getVersions();
 
-				console.log('\nn8n worker is now ready');
-				console.log(` * Version: ${versions.cli}`);
-				console.log(` * Concurrency: ${flags.concurrency}`);
-				console.log('');
+				console.info('\nn8n worker is now ready');
+				console.info(` * Version: ${versions.cli}`);
+				console.info(` * Concurrency: ${flags.concurrency}`);
+				console.info('');
 
 				Worker.jobQueue.on('global:progress', (jobId, progress) => {
 					// Progress of a job got updated which does get used
@@ -252,27 +264,28 @@ export class Worker extends Command {
 							cumulativeTimeout += now - lastTimer;
 							lastTimer = now;
 							if (cumulativeTimeout > redisConnectionTimeoutLimit) {
-								console.error('Unable to connect to Redis after ' + redisConnectionTimeoutLimit + '. Exiting process.');
+								logger.error('Unable to connect to Redis after ' + redisConnectionTimeoutLimit + ". Exiting process.");
 								process.exit(1);
 							}
 						}
-						console.warn('Redis unavailable - trying to reconnect...');
+						logger.warn('Redis unavailable - trying to reconnect...');
 					} else if (error.toString().includes('Error initializing Lua scripts') === true) {
 						// This is a non-recoverable error
 						// Happens when worker starts and Redis is unavailable
 						// Even if Redis comes back online, worker will be zombie
-						console.error('Error initializing worker.');
+						logger.error('Error initializing worker.');
 						process.exit(2);
 					} else {
-						console.error('Error from queue: ', error);
+						logger.error('Error from queue: ', error);
 					}
 				});
 			} catch (error) {
-				this.error(`There was an error: ${error.message}`);
+				logger.error(`Worker process cannot continue. "${error.message}"`);
 
 				Worker.processExistCode = 1;
 				// @ts-ignore
 				process.emit('SIGINT');
+				process.exit(1);
 			}
 		})();