fix: replace console by telemetry logger

Author: vasil-cf

lib/addNewMask.js

@@ -2,8 +2,11 @@
 require('@codefresh-io/cf-telemetry/init');
 // ↓ Keep one blank line below to prevent automatic import reordering
 
+const { Logger } = require('@codefresh-io/cf-telemetry/logs');
 const { getServerAddress } = require('./helpers');
 
+const logger = new Logger('codefresh:containerLogger:addNewMask');
+
 const exitCodes = {
     success: 0,
     error: 1,
@@ -18,7 +21,7 @@ const exitCodes = {
 let exitWithError = true;
 const exitHandler = (exitCode) => {
     if ((!exitCode || !process.exitCode) && exitWithError) {
-        console.warn(`Unexpected exit with code 0. Exiting with ${exitCodes.unexpectedSuccess} instead`);
+        logger.warn(`Unexpected exit with code 0. Exiting with ${exitCodes.unexpectedSuccess} instead`);
         process.exitCode = exitCodes.unexpectedSuccess;
     }
 };
@@ -27,7 +30,7 @@ process.on('exit', exitHandler);
 async function updateMasks(secret) {
     try {
         const serverAddress = await getServerAddress();
-        console.debug(`server address: ${serverAddress}`);
+        logger.debug(`server address: ${serverAddress}`);
         const url = new URL('secrets', serverAddress);
 
         // eslint-disable-next-line import/no-unresolved
@@ -38,23 +41,23 @@ async function updateMasks(secret) {
         });
 
         if (response.statusCode === 201) {
-            console.log(`successfully updated masks with secret: ${secret.key}`);
+            logger.log(`successfully updated masks with secret: ${secret.key}`);
             exitWithError = false;
             process.exit(exitCodes.success);
         } else {
-            console.error(`could not create mask for secret: ${secret.key}. Server responded with: ${response.statusCode}\n\n${response.body}`);
+            logger.error(`could not create mask for secret: ${secret.key}. Server responded with: ${response.statusCode}\n\n${response.body}`);
             process.exit(exitCodes.error);
         }
     } catch (error) {
-        console.error(`could not create mask for secret: ${secret.key}. Error: ${error}`);
+        logger.error(`could not create mask for secret: ${secret.key}. Error: ${error}`);
         process.exit(exitCodes.error);
     }
 }
 
 if (require.main === module) {
     // first argument is the secret key second argument is the secret value
     if (process.argv.length < 4) {
-        console.log('not enough arguments, need secret key and secret value');
+        logger.log('not enough arguments, need secret key and secret value');
         process.exit(exitCodes.missingArguments);
     }
     const key = process.argv[2];

lib/helpers.js

@@ -21,7 +21,7 @@ function _watchForBuildFinishedSignal(deferred) {
         }
 
         if (fileExists) {
-            console.log(`FOUND FILE '${BuildFinishedSignalFilename}' --- engine signaling build is finished`);
+            logger.log(`FOUND FILE '${BuildFinishedSignalFilename}' --- engine signaling build is finished`);
             return deferred.resolve();
         }
 

lib/index.js

@@ -3,6 +3,9 @@ require('@codefresh-io/cf-telemetry/init');
 // ↓ Keep one blank line below to prevent automatic import reordering
 
 const otel = require('@codefresh-io/cf-telemetry/otel');
+const { Logger: Logs } = require('@codefresh-io/cf-telemetry/logs');
+
+const logs = new Logs('codefresh:containerLogger:index');
 
 const unhandledErrorsTotal = otel.cf.getMeter().createCounter(
     'codefresh.unhandled_errors',
@@ -31,26 +34,26 @@ logger.validate();
 logger.start();
 
 process.on('beforeExit', (code) => {
-    console.log(`beforeExit: ${code}`);
+    logs.log(`beforeExit: ${code}`);
     logger.state.beforeExitCode = code;
     logger._writeNewState();
 });
 process.on('exit', (code) => {
-    console.log(`exit: ${code}`);
+    logs.log(`exit: ${code}`);
     logger.state.exitCode = code;
     logger._writeNewState();
 });
 
 process.on('uncaughtException', (error) => {
     unhandledErrorsTotal.add(1, { 'cf.unhandled_error.type': 'uncaughtException' });
-    console.log(`uncaughtException: ${error}`);
+    logs.log(`uncaughtException: ${error}`);
     logger.state.uncaughtException = error;
     logger._writeNewState();
 });
 
 process.on('unhandledRejection', (reason) => {
     unhandledErrorsTotal.add(1, { 'cf.unhandled_error.type': 'unhandledRejection' });
-    console.log(`unhandledRejection: ${reason}`);
+    logs.log(`unhandledRejection: ${reason}`);
     logger.state.unhandledRejection = reason;
     logger._writeNewState();
 });

lib/isReady.js

@@ -4,24 +4,27 @@ require('@codefresh-io/cf-telemetry/init');
 
 const { readFileSync } = require('fs');
 const _ = require('lodash');
+const { Logger } = require('@codefresh-io/cf-telemetry/logs');
 const { ContainerHandlingStatus } = require('./enums');
 
+const logger = new Logger('codefresh:containerLogger:isReady');
+
 function isContainerReady(state, containerId) {
-    console.log(`checking if container ${containerId} is ready`);
+    logger.log(`checking if container ${containerId} is ready`);
     const containerState = _.get(state, `containers[${containerId}]`, {});
     const isReady = [
         ContainerHandlingStatus.LISTENING,
         ContainerHandlingStatus.WAITING_FOR_START,
         ContainerHandlingStatus.FINISHED,
     ].includes(containerState.status);
-    console.log(`container ${containerId} is: ${isReady ? 'READY' : 'NOT READY'}`);
+    logger.log(`container ${containerId} is: ${isReady ? 'READY' : 'NOT READY'}`);
     return isReady;
 }
 
 function isContainerLoggerReady(state) {
-    console.log(`checking if container logger is ready`);
+    logger.log(`checking if container logger is ready`);
     const isReady = state.status === 'ready';
-    console.log(`container logger is: ${isReady ? 'READY' : 'NOT READY'}`);
+    logger.log(`container logger is: ${isReady ? 'READY' : 'NOT READY'}`);
     return isReady;
 }
 

lib/waitUntilFinish.js

@@ -5,8 +5,11 @@ require('@codefresh-io/cf-telemetry/init');
 const fs = require('fs');
 const path = require('path');
 const Q = require('q');
+const { Logger } = require('@codefresh-io/cf-telemetry/logs');
 const { BuildFinishedSignalFilename } = require('./enums');
 
+const logger = new Logger('codefresh:containerLogger:waitUntilFinish');
+
 class Waiter {
 
     constructor(filepath, state) {
@@ -22,13 +25,13 @@ class Waiter {
                 this._checkFinished();
             })
             .catch(() => {
-                console.error('cannot update state');
+                logger.error('cannot update state');
             });
     }
 
     _checkFinished() {
         if (this.state.status === 'done') {
-            console.log(`Task logger has flushed all logs. Finishing waiter...`);
+            logger.log(`Task logger has flushed all logs. Finishing waiter...`);
             this._unwatchState();
             this.finished = true;
             clearInterval(this.sigInterval);
@@ -47,7 +50,7 @@ class Waiter {
     }
 
     _signalBuildFinished() {
-        console.log(`Creating file '${BuildFinishedSignalFilename}' to signal that build is finished`);
+        logger.log(`Creating file '${BuildFinishedSignalFilename}' to signal that build is finished`);
         fs.writeFileSync(path.resolve(__dirname, BuildFinishedSignalFilename), 'build is finished');
     }
 
@@ -65,7 +68,7 @@ class Waiter {
             fileContents = fs.readFileSync(filePath, 'utf8');
             return Q.resolve(JSON.parse(fileContents));
         } catch (err) {
-            console.error(`failed to parse json: "${fileContents}" cause: ${err}`);
+            logger.error(`failed to parse json: "${fileContents}" cause: ${err}`);
             if (tryNum < maxTries) {
                 return Q.delay(500).then(() => {
                     return Waiter._retryGetState(filePath, tryNum + 1, maxTries);