fix: replace cf-logs by telemetry logger

Author: vasil-cf

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,10 +1,12 @@
 const { stat, writeFile, readFile } = require('node:fs/promises');
 const path = require('path');
-const logger = require('cf-logs').Logger('codefresh:containerLogger');
+const { Logger } = require('@codefresh-io/cf-telemetry/logs');
 const getPromiseWithResolvers = require('core-js-pure/es/promise/with-resolvers');
 const { BuildFinishedSignalFilename } = require('./enums');
 const { SERVER_ADDRESS_PATH } = require('./const');
 
+const logger = new Logger('codefresh:containerLogger');
+
 const checkFileInterval = 1000;
 
 function _watchForBuildFinishedSignal(deferred) {

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

@@ -3,8 +3,6 @@ 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 path = require('node:path');
-const cflogs = require('cf-logs');
 
 const unhandledErrorsTotal = otel.cf.getMeter().createCounter(
     'codefresh.unhandled_errors',
@@ -15,17 +13,6 @@ const unhandledErrorsTotal = otel.cf.getMeter().createCounter(
     },
 );
 
-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);
-
 const Logger = require('./logger');
 const { watchForBuildFinishedSignal } = require('./helpers');
 

lib/index.js

@@ -4,7 +4,7 @@ const _ = require('lodash');
 const Docker = require('dockerode');
 const DockerEvents = require('docker-events');
 const CFError = require('cf-errors');
-const logger = require('cf-logs').Logger('codefresh:containerLogger');
+const { Logger } = require('@codefresh-io/cf-telemetry/logs');
 const { TaskLogger } = require('@codefresh-io/task-logger');
 const { ContainerStatus } = require('./enums');
 const { LoggerStrategy } = require('./enums');
@@ -15,6 +15,8 @@ const { getPromiseWithResolvers } = require('./helpers');
 // eslint-disable-next-line import/no-unresolved,import/extensions
 const { HttpServer } = require('./http-server');
 
+const logger = new Logger('codefresh:containerLogger');
+
 const initialState = {
     pid: process.pid, status: 'init', lastLogsDate: new Date(), failedHealthChecks: [], restartCounter: 0, containers: {}
 };

lib/logger.js

@@ -1,9 +1,9 @@
-import cfLogs from 'cf-logs';
+import { Logger } from '@codefresh-io/cf-telemetry/logs';
 
 // eslint-disable-next-line import/no-unresolved
 import { DeprecatedImageDto } from './deprecated-image.dto';
 
-const logger = cfLogs.Logger('codefresh:containerLogger');
+const logger = new Logger('codefresh:containerLogger');
 
 // eslint-disable-next-line no-control-regex
 const DEPRECATED_IMAGE_REGEX = /^(?:\u001b\[31m\u001b\[1m)?\[DEPRECATION NOTICE].+?Suggest the author of (?<image>.+?) to/;

lib/metric/deprecated-images/deprecated-images.collector.ts

@@ -13,7 +13,6 @@
     "@codefresh-io/cf-telemetry": "^3.1.0",
     "@codefresh-io/task-logger": "^1.12.3",
     "cf-errors": "^0.1.17",
-    "cf-logs": "^1.1.28",
     "core-js-pure": "^3.37.1",
     "docker-events": "0.0.2",
     "dockerode": "^4.0.2",

package.json

@@ -29,9 +29,7 @@
     "rootDir": "./lib",                                  /* Specify the root folder within your source files. */
     "moduleResolution": "node16",                     /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    "paths": {
-      "cf-logs": ["./lib/@types"]
-    },                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    "paths": {},                                         /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
     // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
     // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */