Enhance Logs with Color-Coding and Improved Readability (#2228)

* Enhance log readability by adding color-coding and formatting

* Remove incorrect logLevel value from env sample

.env.sample

@@ -138,6 +138,9 @@
 # Log level for the service.
 # LOG_LEVEL=
 
+# Make logs prrety and colorize
+# LOG_PRETTY_COLORIZE=
+
 # Targeted Messaging
 # TARGETED_MESSAGING_FILE_STORAGE_TYPE=
 

src/config/entities/__tests__/configuration.ts

@@ -176,6 +176,7 @@ export default (): ReturnType<typeof configuration> => ({
   log: {
     level: 'debug',
     silent: process.env.LOG_SILENT?.toLowerCase() === 'true',
+    prettyColorize: process.env.LOG_PRETTY_COLORIZE?.toLowerCase() === 'true',
   },
   mappings: {
     imitation: {

src/config/entities/configuration.ts

@@ -270,6 +270,7 @@ export default () => ({
   log: {
     level: process.env.LOG_LEVEL || 'debug',
     silent: process.env.LOG_SILENT?.toLowerCase() === 'true',
+    prettyColorize: process.env.LOG_PRETTY_COLORIZE?.toLowerCase() === 'true',
   },
   owners: {
     // There is no hook to invalidate the owners, so defaulting 0 disables the cache

src/logging/logging.module.ts

@@ -30,9 +30,13 @@ const LoggerTransports = Symbol('LoggerTransports');
 function winstonTransportsFactory(
   configurationService: IConfigurationService,
 ): Array<Transport> | Transport {
+  const prettyColorize =
+    configurationService.getOrThrow<boolean>('log.prettyColorize');
   return new winston.transports.Console({
     level: configurationService.getOrThrow<string>('log.level'),
-    format: winston.format.json(),
+    format: prettyColorize
+      ? winston.format.prettyPrint({ colorize: true })
+      : winston.format.json(),
   });
 }