feat(node): debug and trace logging

Author: AndriiAndreiev

packages/node/src/lib/get-project-base-url.ts

@@ -7,6 +7,8 @@ import timeoutSignal from 'timeout-signal';
 import pkg from '../../package.json';
 import config from '../config';
 
+import { logger } from './logger';
+
 export function getCache(readmeApiKey: string) {
   const encodedApiKey = Buffer.from(`${readmeApiKey}:`).toString('base64');
   const cacheDir = findCacheDir({ name: pkg.name, create: true });
@@ -48,7 +50,7 @@ export async function getProjectBaseUrl(readmeApiKey: string, requestTimeout = c
         if (res.status >= 400 && res.status <= 599) {
           throw res;
         }
-
+        logger.debug({ message: `Fetch Base URL: Service responded with status ${res.status}: ${res.statusText}` });
         return res.json() as Promise<{ baseUrl: string }>;
       })
       .then(project => {

packages/node/src/lib/log.ts

@@ -31,6 +31,8 @@ function doSend(readmeApiKey: string, options: Options) {
       logger.error({ message: 'Error making API call', err });
     }
   });
+
+  logger.debug({ message: 'Queue is cleared.', args: { queue } });
 }
 // Make sure we flush the queue if the process is exited
 process.on('exit', doSend);
@@ -168,6 +170,7 @@ export function log(
     );
 
     queue.push(payload);
+    logger.debug({ message: 'Queue is appended.', args: { queue } });
     if (queue.length >= bufferLength) doSend(readmeApiKey, options);
 
     cleanup(); // eslint-disable-line @typescript-eslint/no-use-before-define

packages/node/src/lib/logger.ts

@@ -68,10 +68,11 @@ class DefaultLogger implements Logger {
   trace({ message, args }: Log): void {
     if (!this.config.isLoggingEnabled) return;
     const params: unknown[] = this.formatMessage('TRACE', message);
+    console.log(...params);
     if (args) {
-      params.push('\nArguments:', args);
+      console.dir(args, { depth: null });
+      console.log('\n');
     }
-    console.debug(...params);
   }
 
   /**
@@ -84,7 +85,7 @@ class DefaultLogger implements Logger {
     if (args) {
       params.push('\nArguments:', args);
     }
-    console.debug(...params);
+    console.debug(...params, '\n');
   }
 
   /**
@@ -100,7 +101,7 @@ class DefaultLogger implements Logger {
     if (err) {
       params.push('\n', err);
     }
-    console.error(...params);
+    console.error(...params, '\n');
   }
 }
 

packages/node/src/lib/metrics-log.ts

@@ -101,6 +101,7 @@ export function metricsAPICall(readmeAPIKey: string, body: OutgoingLogBody[], op
       // after the backoff expires, erase the old expiration time
       backoffExpiresAt = undefined;
     }
+    logger.trace({ message: 'Making a POST request to a service...', args: { body } });
     return fetch(new URL('/v1/request', config.host), {
       method: 'post',
       body: JSON.stringify(body),
@@ -121,6 +122,7 @@ export function metricsAPICall(readmeAPIKey: string, body: OutgoingLogBody[], op
             backoffExpiresAt.setSeconds(backoffExpiresAt.getSeconds() + BACKOFF_SECONDS);
           }
         }
+        logger.debug({ message: `Service responded with status ${response.status}: ${response.statusText}` });
         return response;
       })
       .finally(() => {