feat: Implement logger (#21)

Fixes #12

Author: erezrokah

.eslintrc

@@ -10,6 +10,7 @@
     "plugin:unicorn/recommended"
   ],
   "rules": {
+    "no-console": "error",
     "@typescript-eslint/no-unused-vars": 0
   },
   "overrides": [

package-lock.json

@@ -73,6 +73,7 @@
     "@apache-arrow/esnext-esm": "^12.0.1",
     "@cloudquery/plugin-pb-javascript": "^0.0.6",
     "boolean": "^3.2.0",
+    "winston": "^3.10.0",
     "yargs": "^17.7.2"
   }
 }

package.json

@@ -1,6 +1,9 @@
+import winston from 'winston';
 import grpc = require('@grpc/grpc-js');
 import { discovery1 } from '@cloudquery/plugin-pb-javascript';
 
+const SUPPORTED_VERSIONS = [3];
+
 export class DiscoveryServer extends discovery1.cloudquery.discovery.v1.UnimplementedDiscoveryService {
   GetVersions(
     call: grpc.ServerUnaryCall<
@@ -9,6 +12,9 @@ export class DiscoveryServer extends discovery1.cloudquery.discovery.v1.Unimplem
     >,
     callback: grpc.sendUnaryData<discovery1.cloudquery.discovery.v1.GetVersions.Response>,
   ): void {
-    return callback(null, new discovery1.cloudquery.discovery.v1.GetVersions.Response({ versions: [3] }));
+    return callback(
+      null,
+      new discovery1.cloudquery.discovery.v1.GetVersions.Response({ versions: SUPPORTED_VERSIONS }),
+    );
   }
 }

src/grpc/discovery.ts

@@ -1,3 +1,4 @@
+import winston from 'winston';
 import grpc = require('@grpc/grpc-js');
 import { pluginV3 } from '@cloudquery/plugin-pb-javascript';
 

src/grpc/plugin.ts

@@ -1,3 +1,4 @@
+import winston from 'winston';
 import grpc = require('@grpc/grpc-js');
 import { pluginV3 } from '@cloudquery/plugin-pb-javascript';
 import { discovery1 } from '@cloudquery/plugin-pb-javascript';
@@ -12,10 +13,14 @@ export const getServer = () => {
   return server;
 };
 
-export const startServer = (address: string) => {
+export const startServer = (logger: winston.Logger, address: string) => {
   const server = getServer();
   server.bindAsync(address, grpc.ServerCredentials.createInsecure(), (error, port) => {
+    if (error) {
+      logger.error(error);
+      return;
+    }
     server.start();
-    console.log('server running on port', port);
+    logger.info('server running on port', port);
   });
 };

src/grpc/server.ts

@@ -0,0 +1,26 @@
+import winston from 'winston';
+
+export enum LogLevel {
+  TRACE = 'trace',
+  DEBUG = 'debug',
+  INFO = 'info',
+  WARN = 'warn',
+  ERROR = 'error',
+}
+
+export enum LogFormat {
+  JSON = 'json',
+  TEXT = 'text',
+}
+
+export const createLogger = (level: LogLevel, format: LogFormat) => {
+  // Winston doesn't have a TRACE level, so we need to normalize it to DEBUG.
+  const normalizedLevel = level === LogLevel.TRACE ? LogLevel.DEBUG : level;
+  const logger = winston.createLogger({
+    level: normalizedLevel,
+    format: format == LogFormat.JSON ? winston.format.json() : winston.format.simple(),
+    transports: [new winston.transports.Console()],
+  });
+
+  return logger;
+};

src/logger/logger.ts

@@ -1,17 +1,17 @@
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { startServer } from '../grpc/server.js';
+import { LogFormat, LogLevel, createLogger } from '../logger/logger.js';
 
 const NETWORK_CHOICES = ['tcp', 'tcp4', 'tcp6', 'unix', 'unixpacket'] as const;
-const LOG_LEVEL_CHOICES = ['trace', 'debug', 'info', 'warn', 'error'] as const;
-const LOG_FORMAT_CHOICES = ['json', 'text'] as const;
+
 const TELEMETRY_LEVEL_CHOICES = ['none', 'errors', 'stats', 'all'] as const;
 
 export type ServeArguments = {
   address: string;
   network: (typeof NETWORK_CHOICES)[number];
-  logLevel: (typeof LOG_LEVEL_CHOICES)[number];
-  logFormat: (typeof LOG_FORMAT_CHOICES)[number];
+  logLevel: LogLevel;
+  logFormat: LogFormat;
   sentry: boolean;
   otelEndpoint: string;
   otelEndpointInsecure: boolean;
@@ -24,8 +24,9 @@ export const serve = yargs(hideBin(process.argv))
     'start plugin gRPC server',
     () => {},
     ({ address, network, logLevel, logFormat, sentry: sentry, otelEndpoint, telemetryLevel }: ServeArguments) => {
-      console.log({ address, network, logLevel, logFormat, sentry, otelEndpoint, telemetryLevel });
-      startServer(address);
+      const logger = createLogger(logLevel, logFormat);
+      logger.info(JSON.stringify({ address, network, logLevel, logFormat, sentry, otelEndpoint, telemetryLevel }));
+      startServer(logger, address);
     },
   )
   .options({
@@ -45,14 +46,14 @@ export const serve = yargs(hideBin(process.argv))
     'log-level': {
       alias: 'l',
       type: 'string',
-      choices: LOG_LEVEL_CHOICES,
+      choices: Object.values(LogLevel),
       description: 'log level',
       default: 'info',
     },
     'log-format': {
       alias: 'f',
       type: 'string',
-      choices: LOG_FORMAT_CHOICES,
+      choices: Object.values(LogFormat),
       description: 'log format',
       default: 'text',
     },