Implement OpenTelemetry plugin

Author: christiand93

.gitignore

@@ -1,5 +1,5 @@
-build/
 node_modules/
 coverage/
+build/
 .vscode/
 .nyc_output/

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cf-nodejs-logging-support",
-  "version": "7.4.3",
+  "version": "7.5.4-beta.0",
   "description": "Logging tool for Cloud Foundry",
   "keywords": [
     "logging",
@@ -62,6 +62,7 @@
     "README.md"
   ],
   "dependencies": {
+    "@opentelemetry/api-logs": "^0.51.0",
     "ajv": "^8.11.0",
     "json-stringify-safe": "^5.0.1",
     "jsonwebtoken": "^9.0.3",

package.json

@@ -6,5 +6,9 @@ exports = module.exports; // re-assign exports
 
 export default rootLogger;
 export * from "./lib/config/interfaces";
+export * from "./lib/logger/record";
 export * from "./lib/logger/level";
 export * from "./lib/logger/logger";
+export * from "./lib/plugins/interfaces";
+export * from "./lib/plugins/defaultOutput";
+export * from "./lib/plugins/otelOutput";

src/index.ts

@@ -114,8 +114,11 @@
         },
         "DetailName": {
             "enum": [
+                "errorMessage",
+                "errorName",
                 "level",
                 "message",
+                "rawStacktrace",
                 "requestReceivedAt",
                 "responseSentAt",
                 "responseTimeMs",

src/lib/config/default/config-schema.json

@@ -86,6 +86,9 @@ export enum DetailName {
     WrittenTs = "writtenTs",
     Message = "message",
     Stacktrace = "stacktrace",
+    RawStacktrace = "rawStacktrace",
+    ErrorName = "errorName",
+    ErrorMessage = "errorMessage",
     Level = "level"
 }
 

src/lib/config/interfaces.ts

@@ -0,0 +1,31 @@
+import { OutputPlugin } from "../plugins/interfaces";
+
+export default class PluginProvider {
+    private static instance: PluginProvider;
+    private outputPlugins: OutputPlugin[];
+
+    private constructor() {
+        this.outputPlugins = [];
+    }
+
+    static getInstance(): PluginProvider {
+        if (!PluginProvider.instance) {
+            PluginProvider.instance = new PluginProvider();
+        }
+        return PluginProvider.instance;
+    }
+
+    addOutputPlugin(outputPlugin: OutputPlugin) {
+        this.outputPlugins.push(outputPlugin);
+    }
+
+    setOutputPlugins(outputPlugins: OutputPlugin[]) {
+        this.outputPlugins = outputPlugins;
+    }
+
+    getOutputPlugins(): OutputPlugin[] {
+        return this.outputPlugins;
+    }
+}
+
+

src/lib/helper/levelUtils.ts

@@ -8,3 +8,29 @@ export enum Level {
     Debug = 4,
     Silly = 5
 }
+
+export class LevelUtils {
+    private static readonly defaultLevel: Level = Level.Info
+
+    static getLevel(level: String | Level): Level {
+        if (typeof level === 'string') {
+            const key = level.charAt(0).toUpperCase() + level.slice(1).toLowerCase();
+            const lvl: Level = Level[key as keyof typeof Level]
+            if (lvl !== undefined) {
+                return lvl;
+            }
+        } else {
+            return level as Level
+        }
+        return LevelUtils.defaultLevel;
+    }
+
+    static getName(level: Level): string {
+        return Level[level].toLowerCase()
+    }
+
+    static isLevelEnabled(threshold: Level, level: Level) {
+        if (level <= Level.Off) return false;
+        return level <= threshold
+    }
+}

src/lib/helper/pluginProvider.ts

@@ -1,17 +1,16 @@
-import LevelUtils from '../helper/levelUtils';
 import { isValidObject } from '../middleware/utils';
-import { Level } from './level';
+import { Level, LevelUtils } from './level';
 import RecordFactory from './recordFactory';
-import RecordWriter from './recordWriter';
 import Context from './context';
+import PluginProvider from '../helper/pluginProvider';
 
 export class Logger {
     private parent?: Logger = undefined
     private context?: Context;
     private registeredCustomFields: Array<string> = [];
     private customFields: Map<string, any> = new Map<string, any>()
     private recordFactory: RecordFactory;
-    private recordWriter: RecordWriter;
+
     protected loggingLevelThreshold: Level = Level.Inherit
 
     constructor(parent?: Logger, context?: Context) {
@@ -23,7 +22,6 @@ export class Logger {
             this.context = context;
         }
         this.recordFactory = RecordFactory.getInstance();
-        this.recordWriter = RecordWriter.getInstance();
     }
 
     createLogger(customFields?: Map<string, any> | Object, createNewContext?: boolean): Logger {
@@ -37,11 +35,7 @@ export class Logger {
     }
 
     setLoggingLevel(level: string | Level) {
-        if (typeof level === 'string') {
-            this.loggingLevelThreshold = LevelUtils.getLevel(level)
-        } else {
-            this.loggingLevelThreshold = level
-        }
+        this.loggingLevelThreshold = LevelUtils.getLevel(level)
     }
 
     getLoggingLevel(): string {
@@ -55,26 +49,14 @@ export class Logger {
         if (this.loggingLevelThreshold == Level.Inherit) {
             return this.parent!.isLoggingLevel(level)
         }
-        if (typeof level === 'string') {
-            return LevelUtils.isLevelEnabled(this.loggingLevelThreshold, LevelUtils.getLevel(level))
-        } else {
-            return LevelUtils.isLevelEnabled(this.loggingLevelThreshold, level)
-        }
+        return LevelUtils.isLevelEnabled(this.loggingLevelThreshold, LevelUtils.getLevel(level))
     }
 
     logMessage(level: string | Level, ...args: any) {
         if (!this.isLoggingLevel(level)) return;
         const loggerCustomFields = this.getCustomFieldsFromLogger(this);
-
-        let levelName: string;
-        if (typeof level === 'string') {
-            levelName = level;
-        } else {
-            levelName = LevelUtils.getName(level);
-        }
-
-        const record = this.recordFactory.buildMsgRecord(this.registeredCustomFields, loggerCustomFields, levelName, args, this.context);
-        this.recordWriter.writeLog(record);
+        const record = this.recordFactory.buildMsgRecord(this.registeredCustomFields, loggerCustomFields, LevelUtils.getLevel(level), args, this.context);
+        PluginProvider.getInstance().getOutputPlugins().forEach(output => { output.writeRecord(record) })
     }
 
     error(...args: any) {