Add options to include additional fields as log attributes

Author: christiand93

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cf-nodejs-logging-support",
-  "version": "7.4.0-beta.3",
+  "version": "7.4.0-beta.4",
   "description": "Logging tool for Cloud Foundry",
   "keywords": [
     "logging",

package.json

@@ -18,10 +18,12 @@ export class RecordMetadata {
     stacktrace?: string[]
     errorName?: string
     errorMessage?: string
+    customFieldNames: string[]
 
     constructor(type: RecordType, level: Level) {
         this.type = type
         this.level = level
+        this.customFieldNames = new Array<string>()
     }
 }
 

src/lib/logger/record.ts

@@ -136,6 +136,8 @@ export default class RecordFactory {
                     indexedCustomFields[key] = value;
                 }
             }
+
+            record.metadata.customFieldNames.push(key)
         });
 
         // Write custom fields in the correct order and correlates i to the place in registeredCustomFields

src/lib/logger/recordFactory.ts

@@ -6,13 +6,19 @@ import { Level } from '../logger/level'
 
 export class OpenTelemetryLogsOutputPlugin implements OutputPlugin {
     private logger: Logger
+    private includeFieldsAsAttributes: FieldInclusionMode
 
     public constructor(loggerProvider?: LoggerProvider) {
         if (loggerProvider) {
             this.logger = loggerProvider.getLogger('default')
         } else {
             this.logger = logsAPI.getLoggerProvider().getLogger("default")
         }
+        this.includeFieldsAsAttributes = FieldInclusionMode.CustomFieldsOnly
+    }
+
+    public setIncludeFieldsAsAttributes(includeFieldsAsAttributes: FieldInclusionMode) {
+        this.includeFieldsAsAttributes = includeFieldsAsAttributes
     }
 
     public writeRecord(record: Record): void {
@@ -21,16 +27,8 @@ export class OpenTelemetryLogsOutputPlugin implements OutputPlugin {
         }
 
         let attributes = {} as LogAttributes
-
-        if (record.metadata.errorName) {
-            attributes["exception.type"] = record.metadata.errorName
-        }
-        if (record.metadata.errorMessage) {
-            attributes["exception.message"] = record.metadata.errorMessage
-        }
-        if (record.metadata.rawStacktrace) {
-            attributes["exception.stacktrace"] = record.metadata.rawStacktrace
-        }
+        this.populateExceptionAttributes(record, attributes)
+        this.populateAdditionalAttributes(record, attributes)
 
         let severityNumber = this.mapLevelToSeverityNumber(record.metadata.level)
 
@@ -58,4 +56,42 @@ export class OpenTelemetryLogsOutputPlugin implements OutputPlugin {
         }
         return SeverityNumber.UNSPECIFIED
     }
+
+    private populateExceptionAttributes(record: Record, attributes: LogAttributes) {
+        if (record.metadata.errorName) {
+            attributes["exception.type"] = record.metadata.errorName
+        }
+        if (record.metadata.errorMessage) {
+            attributes["exception.message"] = record.metadata.errorMessage
+        }
+        if (record.metadata.rawStacktrace) {
+            attributes["exception.stacktrace"] = record.metadata.rawStacktrace
+        }
+    }
+
+    private populateAdditionalAttributes(record: Record, attributes: LogAttributes) {
+        switch(this.includeFieldsAsAttributes) {
+            case FieldInclusionMode.AllFields:
+                for (let key in record.payload) {
+                    attributes[key] = record.payload[key]
+                }
+            break;
+            case FieldInclusionMode.CustomFieldsOnly:
+                for (let key of record.metadata.customFieldNames) {
+                    if (record.payload[key] !== undefined) {
+                        attributes[key] = record.payload[key]
+                    }
+                }
+            break;
+            case FieldInclusionMode.None:
+            default:
+                return;
+        }
+    }
+}
+
+export enum FieldInclusionMode {
+    AllFields = "all",
+    CustomFieldsOnly = "custom-fields",
+    None = "none"
 }