feat: add telemetry to cf-container-logger (#151)

Author: vasil-cf

.eslintrc.json

@@ -88,7 +88,8 @@
     "node/shebang": "off",
     "node/no-deprecated-api": "warn",
     "no-useless-constructor": "warn",
-    "no-return-await": "off"
+    "no-return-await": "off",
+    "import/extensions": ["error", "never", { "json": "always" }]
   },
 
   "overrides": [
@@ -125,5 +126,17 @@
         ]
       }
     }
-  ]
+  ],
+
+  "settings": {
+    "import/resolver": {
+      "typescript": {
+        "alwaysTryTypes": true,
+        "project": ["tsconfig.json"]
+      },
+      "node": {
+        "extensions": [".js", ".ts", ".json"]
+      }
+    }
+  }
 }

.nvmrc

@@ -1 +1 @@
-v22.17.1
+v22.18.0

Dockerfile

@@ -1,4 +1,4 @@
-ARG NODE_VERSION=22.17.1
+ARG NODE_VERSION=22.18.0
 FROM node:${NODE_VERSION}-bookworm-slim AS base
 # that workdir MUST NOT be changed because of backward compatibility with the engine <= 1.177.7
 WORKDIR /root/cf-runtime

README.md

@@ -4,7 +4,6 @@
     # FIREBASE_AUTH_URL - the main firebase ref to authenticate on initialization
     # FIREBASE_SECRET - the secret key to write to the firebase auth url and all future derived urls
     # LOGGER_ID - logger id. if a container will include this id in its label, we will log it
-    # LOG_TO_CONSOLE - by default, logging to console is disabled and only logging to a file is enabled. set this env to log to console to
     # LISTEN_ON_EXISTING - by default, if not provided, will only listen for new containers. this will enable listening on existing containers
 
 # Container labels

lib/@types/index.d.ts

@@ -1,7 +1,7 @@
 const EventEmitter = require('events');
 const Q = require('q');
 const promiseRetry = require('promise-retry');
-const logger = require('cf-logs').Logger('codefresh:containerLogger');
+const { Logger } = require('@codefresh-io/cf-telemetry/logs');
 const CFError = require('cf-errors');
 const { Transform } = require('stream');
 
@@ -11,6 +11,8 @@ const { LoggerStrategy } = require('./enums');
 // eslint-disable-next-line import/no-unresolved
 const { DeprecatedImagesInterceptorStream } = require('./metric/deprecated-images/deprecated-images-interceptor.stream');
 
+const logger = new Logger('codefresh:containerLogger');
+
 const CONTAINER_START_RETRY_TIMEOUT_SECONDS = 1;
 const CONTAINER_START_RETRY_LIMIT = 10;
 const BUFFER_SIZE = 2 * 1024 * 1024; // 2 MiB

lib/ContainerLogger.js

@@ -1,4 +1,13 @@
-const { getServerAddress } = require('./helpers');
+/* eslint-disable promise/catch-or-return */
+
+// ↓ Should be imported first
+const { terminate } = 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, registerExitHandlers } = require('./helpers');
+
+const logger = new Logger('codefresh:containerLogger:addNewMask');
 
 const exitCodes = {
     success: 0,
@@ -14,7 +23,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;
     }
 };
@@ -23,7 +32,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
@@ -34,24 +43,26 @@ 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);
+            terminate().finally(() => process.exit(exitCodes.success));
         } else {
-            console.error(`could not create mask for secret: ${secret.key}. Server responded with: ${response.statusCode}\n\n${response.body}`);
-            process.exit(exitCodes.error);
+            logger.error(`could not create mask for secret: ${secret.key}. Server responded with: ${response.statusCode}\n\n${response.body}`);
+            terminate().finally(() => process.exit(exitCodes.error));
         }
     } catch (error) {
-        console.error(`could not create mask for secret: ${secret.key}. Error: ${error}`);
-        process.exit(exitCodes.error);
+        logger.error(`could not create mask for secret: ${secret.key}. Error: ${error}`);
+        terminate().finally(() => process.exit(exitCodes.error));
     }
 }
 
 if (require.main === module) {
+    registerExitHandlers();
+
     // 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');
-        process.exit(exitCodes.missingArguments);
+        logger.log('not enough arguments, need secret key and secret value');
+        terminate().finally(() => process.exit(exitCodes.missingArguments));
     }
     const key = process.argv[2];
     const value = process.argv[3];

lib/addNewMask.js

@@ -1,10 +1,17 @@
+/* eslint-disable promise/catch-or-return */
+
+// ↓ Should be imported first
+const { terminate } = require('@codefresh-io/cf-telemetry/init');
+// ↓ Keep one blank line below to prevent automatic import reordering
+
 const { stat, writeFile, readFile } = require('node:fs/promises');
 const path = require('path');
-const logger = require('cf-logs').Logger('codefresh:containerLogger');
-const getPromiseWithResolvers = require('core-js-pure/es/promise/with-resolvers');
+const { Logger } = require('@codefresh-io/cf-telemetry/logs');
 const { BuildFinishedSignalFilename } = require('./enums');
 const { SERVER_ADDRESS_PATH } = require('./const');
 
+const logger = new Logger('codefresh:containerLogger');
+
 const checkFileInterval = 1000;
 
 function _watchForBuildFinishedSignal(deferred) {
@@ -19,7 +26,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();
         }
 
@@ -28,7 +35,7 @@ function _watchForBuildFinishedSignal(deferred) {
 }
 
 function watchForBuildFinishedSignal() {
-    const deferred = getPromiseWithResolvers();
+    const deferred = Promise.withResolvers();
 
     _watchForBuildFinishedSignal(deferred);
 
@@ -53,13 +60,23 @@ const getServerAddress = async () => {
     }
 };
 
+/**
+ * As `@codefresh-io/cf-telemetry/init` changes the original node.js behavior of how SIGTERM and SIGINT
+ * signals are handled, we revert this change back to the original node.js behavior.
+ */
+const registerExitHandlers = () => {
+    process.on('SIGTERM', () => {
+        terminate().finally(() => process.exit(143)); // default exit code for SIGTERM
+    });
+
+    process.on('SIGINT', () => {
+        terminate().finally(() => process.exit(130)); // default exit code for SIGINT
+    });
+};
+
 module.exports = {
-    /**
-     * Polyfill of `Promise.withResolvers`, TC39 Stage 4 proposal.
-     * @see https://github.com/tc39/proposal-promise-with-resolvers
-     */
-    getPromiseWithResolvers,
     watchForBuildFinishedSignal,
     saveServerAddress,
     getServerAddress,
+    registerExitHandlers,
 };

lib/helpers.js

@@ -1,12 +1,12 @@
 import fastify from 'fastify';
-import cfLogs from 'cf-logs';
+import { Logger } from '@codefresh-io/cf-telemetry/logs';
 
 import { saveServerAddress } from '../helpers';
 
 // eslint-disable-next-line import/no-unresolved
 import deprecatedImagesCollector from '../metric/deprecated-images/deprecated-images.collector';
 
-const logger = cfLogs.Logger('codefresh:containerLogger');
+const logger = new Logger('codefresh:containerLogger');
 
 export class HttpServer {
 

lib/http-server/index.ts

@@ -1,19 +1,25 @@
-const path = require('node:path');
-const cflogs = require('cf-logs');
-
-const loggerOptions = {
-    filePath: path.join(__dirname, '../logs', 'logs.log'),
-    console: process.env.LOG_TO_CONSOLE || false,
-    consoleOptions: {
-        timestamp() {
-            return new Date().toISOString();
-        }
-    }
-};
-cflogs.init(loggerOptions);
+// ↓ Should be imported first
+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 { watchForBuildFinishedSignal, registerExitHandlers } = require('./helpers');
+
+registerExitHandlers();
+
+const logs = new Logs('codefresh:containerLogger:index');
+
+const unhandledErrorsTotal = otel.cf.getMeter().createCounter(
+    'codefresh.unhandled_errors',
+    {
+        description: 'Number of unhandled errors',
+        unit: '{unhandled_error}',
+        valueType: otel.api.ValueType.INT,
+    },
+);
 
 const Logger = require('./logger');
-const { watchForBuildFinishedSignal } = require('./helpers');
 
 const taskLoggerConfig = JSON.parse(process.env.TASK_LOGGER_CONFIG);
 
@@ -30,24 +36,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) => {
-    console.log(`uncaughtException: ${error}`);
+    unhandledErrorsTotal.add(1, { 'cf.unhandled_error.type': 'uncaughtException' });
+    logs.log(`uncaughtException: ${error}`);
     logger.state.uncaughtException = error;
     logger._writeNewState();
 });
 
 process.on('unhandledRejection', (reason) => {
-    console.log(`unhandledRejection: ${reason}`);
+    unhandledErrorsTotal.add(1, { 'cf.unhandled_error.type': 'unhandledRejection' });
+    logs.log(`unhandledRejection: ${reason}`);
     logger.state.unhandledRejection = reason;
     logger._writeNewState();
 });