@companieshouse/structured-logging-node 2.0.1 → 2.0.3

package/lib/LoggerFactory.js

@@ -1,9 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+const api = __importStar(require("@opentelemetry/api-logs"));
+const sdk_logs_1 = require("@opentelemetry/sdk-logs");
+const resources_1 = require("@opentelemetry/resources");
 const HumanFormatFactory_1 = __importDefault(require("./formatting/HumanFormatFactory"));
 const JsonFormatFactory_1 = __importDefault(require("./formatting/JsonFormatFactory"));
+const exporter_logs_otlp_http_1 = require("@opentelemetry/exporter-logs-otlp-http");
+const winston_transport_1 = require("@opentelemetry/winston-transport");
 const config_1 = __importDefault(require("./config"));
 const levelConfig_1 = __importDefault(require("./levelConfig"));
 const winston_1 = __importDefault(require("winston"));
@@ -18,10 +46,24 @@ class LoggerFactory {
     }
     static create(options) {
         winston_1.default.addColors(levelConfig_1.default.colours);
+        if (config_1.default.otelLogEnabled) {
+            const loggerProvider = new sdk_logs_1.LoggerProvider({
+                // Service.name, service.version correlated with logs
+                resource: (0, resources_1.detectResources)({
+                    detectors: [resources_1.envDetector, resources_1.processDetector, resources_1.hostDetector]
+                })
+            });
+            loggerProvider.addLogRecordProcessor(new sdk_logs_1.BatchLogRecordProcessor(new exporter_logs_otlp_http_1.OTLPLogExporter()));
+            api.logs.setGlobalLoggerProvider(loggerProvider);
+        }
+        const transports = [
+            new winston_1.default.transports.Console(this.createTransportOptions(options.namespace)),
+            ...config_1.default.otelLogEnabled ? [new winston_transport_1.OpenTelemetryTransportV3()] : []
+        ];
         return winston_1.default.createLogger({
             level: config_1.default.level,
             levels: levelConfig_1.default.levels,
-            transports: [new winston_1.default.transports.Console(this.createTransportOptions(options.namespace))],
+            transports: transports,
             exitOnError: false
         });
     }

package/lib/LoggerFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"LoggerFactory.js","sourceRoot":"","sources":["../src/LoggerFactory.ts"],"names":[],"mappings":";;;;AAAA,yFAAiE;AACjE,uFAA+D;AAG/D,sDAA8B;AAC9B,gEAAsC;AACtC,sDAA8B;AAE9B,MAAM,aAAa;IAEP,MAAM,CAAC,sBAAsB,CAAC,SAAiB;QACnD,OAAO;YACH,gBAAgB,EAAE,IAAI;YACtB,MAAM,EAAE,gBAAM,CAAC,aAAa,CAAC,CAAC;gBAC1B,4BAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;gBACtC,2BAAiB,CAAC,MAAM,CAAC,SAAS,CAAC;SAC1C,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,OAAsB;QAEvC,iBAAO,CAAC,SAAS,CAAC,qBAAS,CAAC,OAAO,CAAC,CAAC;QAErC,OAAO,iBAAO,CAAC,YAAY,CAAC;YACxB,KAAK,EAAE,gBAAM,CAAC,KAAK;YACnB,MAAM,EAAE,qBAAS,CAAC,MAAM;YACxB,UAAU,EAAE,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5F,WAAW,EAAE,KAAK;SACrB,CAAqB,CAAC;IAC3B,CAAC;CACJ;AAED,iBAAS,aAAa,CAAC"}
+{"version":3,"file":"LoggerFactory.js","sourceRoot":"","sources":["../src/LoggerFactory.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA+C;AAC/C,sDAAkF;AAClF,wDAAuG;AACvG,yFAAiE;AACjE,uFAA+D;AAE/D,oFAAyE;AACzE,wEAA4E;AAE5E,sDAA8B;AAC9B,gEAAsC;AACtC,sDAA8B;AAE9B,MAAM,aAAa;IAEP,MAAM,CAAC,sBAAsB,CAAC,SAAiB;QACnD,OAAO;YACH,gBAAgB,EAAE,IAAI;YACtB,MAAM,EAAE,gBAAM,CAAC,aAAa,CAAC,CAAC;gBAC1B,4BAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;gBACtC,2BAAiB,CAAC,MAAM,CAAC,SAAS,CAAC;SAC1C,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,OAAsB;QAEvC,iBAAO,CAAC,SAAS,CAAC,qBAAS,CAAC,OAAO,CAAC,CAAC;QAErC,IAAI,gBAAM,CAAC,cAAc,EAAE;YACvB,MAAM,cAAc,GAAG,IAAI,yBAAc,CAAC;gBAC1C,qDAAqD;gBACjD,QAAQ,EAAE,IAAA,2BAAe,EAAC;oBACtB,SAAS,EAAE,CAAC,uBAAW,EAAE,2BAAe,EAAE,wBAAY,CAAC;iBAC1D,CAAC;aACL,CAAC,CAAC;YAEH,cAAc,CAAC,qBAAqB,CAChC,IAAI,kCAAuB,CAAC,IAAI,yCAAe,EAAE,CAAC,CACrD,CAAC;YACF,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;SACpD;QAED,MAAM,UAAU,GAAG;YACf,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9E,GAAG,gBAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,4CAAwB,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;SACnE,CAAC;QAEF,OAAO,iBAAO,CAAC,YAAY,CAAC;YACxB,KAAK,EAAE,gBAAM,CAAC,KAAK;YACnB,MAAM,EAAE,qBAAS,CAAC,MAAM;YACxB,UAAU,EAAE,UAAU;YACtB,WAAW,EAAE,KAAK;SACrB,CAAqB,CAAC;IAC3B,CAAC;CACJ;AAED,iBAAS,aAAa,CAAC"}

package/lib/config.d.ts

@@ -1,5 +1,6 @@
 declare const config: {
     level: string;
     humanReadable: boolean;
+    otelLogEnabled: boolean;
 };
 export = config;

package/lib/config.js

@@ -3,7 +3,8 @@ const config = {
     level: process.env.LOG_LEVEL === undefined ? "info" : process.env.LOG_LEVEL.toLowerCase(),
     humanReadable: process.env.HUMAN_LOG === undefined ?
         false :
-        process.env.HUMAN_LOG === "1"
+        process.env.HUMAN_LOG === "1",
+    otelLogEnabled: process.env.OTEL_LOG_ENABLED === "true"
 };
 module.exports = config;
 //# sourceMappingURL=config.js.map

package/lib/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA,MAAM,MAAM,GAAG;IACX,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE;IACzF,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAChD,KAAK,CAAC,CAAC;QACP,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,GAAG;CACpC,CAAC;AAEF,iBAAS,MAAM,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA,MAAM,MAAM,GAAG;IACX,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE;IACzF,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAChD,KAAK,CAAC,CAAC;QACP,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,GAAG;IACjC,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,MAAM;CAC1D,CAAC;AAEF,iBAAS,MAAM,CAAC"}

package/lib/formatting/HumanFormatFactory.js

@@ -8,6 +8,7 @@ class HumanFormatFactory {
     static create(namespace) {
         const colorizer = winston_1.default.format.colorize();
         return winston_1.default.format.printf(function (info) {
+            /* eslint camelcase: ["error", {allow: ["trace_id", "span_id", "trace_flags"]}] */
             const messageInfo = {
                 created: (0, moment_1.default)().format("YYYY-MM-DDTHH:mm:ss.SSSZ"),
                 namespace: namespace,
@@ -16,7 +17,10 @@ class HumanFormatFactory {
                 path: info.path,
                 method: info.method,
                 status: info.status,
-                duration: info.duration
+                duration: info.duration,
+                trace_id: info.trace_id,
+                span_id: info.span_id,
+                trace_flags: info.trace_flags
             };
             const keys = Object.keys(messageInfo).sort();
             let message = colorizer.colorize(info.level, `${messageInfo.created} ${messageInfo.event}: ${info.message}`);

package/lib/formatting/HumanFormatFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"HumanFormatFactory.js","sourceRoot":"","sources":["../../src/formatting/HumanFormatFactory.ts"],"names":[],"mappings":";;;;AACA,oDAA4B;AAC5B,sDAA8B;AAE9B,MAAM,kBAAkB;IAEb,MAAM,CAAC,MAAM,CAAC,SAAiB;QAElC,MAAM,SAAS,GAAG,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAE5C,OAAO,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,IAAI;YAEvC,MAAM,WAAW,GAAgB;gBAC7B,OAAO,EAAE,IAAA,gBAAM,GAAE,CAAC,MAAM,CAAC,0BAA0B,CAAC;gBACpD,SAAS,EAAE,SAAS;gBACpB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;aAC1B,CAAC;YAEF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC;YAE7C,IAAI,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YAE7G,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG;gBACtB,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;oBAChC,OAAO,IAAI,UAAU,GAAG,KAAK,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;iBACnD;YACL,CAAC,CAAC,CAAC;YAEH,OAAO,OAAO,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED,iBAAS,kBAAkB,CAAC"}
+{"version":3,"file":"HumanFormatFactory.js","sourceRoot":"","sources":["../../src/formatting/HumanFormatFactory.ts"],"names":[],"mappings":";;;;AACA,oDAA4B;AAC5B,sDAA8B;AAE9B,MAAM,kBAAkB;IAEb,MAAM,CAAC,MAAM,CAAC,SAAiB;QAElC,MAAM,SAAS,GAAG,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAE5C,OAAO,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,IAAI;YAEvC,kFAAkF;YAClF,MAAM,WAAW,GAAgB;gBAC7B,OAAO,EAAE,IAAA,gBAAM,GAAE,CAAC,MAAM,CAAC,0BAA0B,CAAC;gBACpD,SAAS,EAAE,SAAS;gBACpB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW;aAChC,CAAC;YAEF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC;YAE7C,IAAI,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YAE7G,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG;gBACtB,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;oBAChC,OAAO,IAAI,UAAU,GAAG,KAAK,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;iBACnD;YACL,CAAC,CAAC,CAAC;YAEH,OAAO,OAAO,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED,iBAAS,kBAAkB,CAAC"}

package/lib/formatting/JsonFormatFactory.js

@@ -7,11 +7,15 @@ const winston_1 = __importDefault(require("winston"));
 class JsonFormatFactory {
     static create(namespace) {
         return winston_1.default.format.printf(function (info) {
+            /* eslint camelcase: ["error", {allow: ["trace_id", "span_id", "trace_flags"]}] */
             const message = {
                 created: (0, moment_1.default)().format("YYYY-MM-DDTHH:mm:ss.SSSZ"),
                 event: info.level,
                 namespace: namespace,
                 context: info.context,
+                trace_id: info.trace_id,
+                span_id: info.span_id,
+                trace_flags: info.trace_flags,
                 data: {
                     message: info.message,
                     path: info.path,

package/lib/formatting/JsonFormatFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"JsonFormatFactory.js","sourceRoot":"","sources":["../../src/formatting/JsonFormatFactory.ts"],"names":[],"mappings":";;;;AAAA,oDAA4B;AAC5B,sDAA8B;AAE9B,MAAM,iBAAiB;IAEZ,MAAM,CAAC,MAAM,CAAC,SAAiB;QAElC,OAAO,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,IAAI;YAEvC,MAAM,OAAO,GAAG;gBACZ,OAAO,EAAE,IAAA,gBAAM,GAAE,CAAC,MAAM,CAAC,0BAA0B,CAAC;gBACpD,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,SAAS,EAAE,SAAS;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE;oBACF,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBAC1B;aACJ,CAAC;YAEF,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED,iBAAS,iBAAiB,CAAC"}
+{"version":3,"file":"JsonFormatFactory.js","sourceRoot":"","sources":["../../src/formatting/JsonFormatFactory.ts"],"names":[],"mappings":";;;;AAAA,oDAA4B;AAC5B,sDAA8B;AAE9B,MAAM,iBAAiB;IAEZ,MAAM,CAAC,MAAM,CAAC,SAAiB;QAElC,OAAO,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,IAAI;YAEvC,kFAAkF;YAClF,MAAM,OAAO,GAAG;gBACZ,OAAO,EAAE,IAAA,gBAAM,GAAE,CAAC,MAAM,CAAC,0BAA0B,CAAC;gBACpD,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,SAAS,EAAE,SAAS;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,IAAI,EAAE;oBACF,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBAC1B;aACJ,CAAC;YAEF,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED,iBAAS,iBAAiB,CAAC"}

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@companieshouse/structured-logging-node",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "A logging solution for CHS structured logging in node apps.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
     "lint": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts'",
     "lint:fix": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts' --fix",
-    "test": "mocha -r ts-node/register --recursive --reporter nyan test --extension ts",
+    "test": "mocha -r ts-node/register --recursive test --extension ts",
     "test:watch": "mocha -r ts-node/register --recursive --reporter nyan test --extension ts --watch",
+    "test:coverage": "nyc --reporter=lcov --reporter=text-summary npm test",
     "build": "tsc",
     "sonarqube": "sonar-scanner",
     "prepublishOnly": "[ ! -d node_modules ] && npm install; tsc",
@@ -21,6 +22,11 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/api-logs": "^0.200.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.56.1",
+    "@opentelemetry/sdk-logs": "^0.200.0",
+    "@opentelemetry/winston-transport": "^0.11.0",
     "moment": "^2.29.4",
     "on-finished": "~2.3.0",
     "winston": "~3.3.3"
@@ -36,17 +42,18 @@
     "chai": "~4.2.0",
     "eslint": "^7.32.0",
     "eslint-config-standard": "14.1.1",
+    "eslint-plugin-chai-friendly": "~0.6.0",
     "eslint-plugin-import": "2.23.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-standard": "5.0.0",
-    "eslint-plugin-chai-friendly": "~0.6.0",
-    "mocha": "^9.2.2",
+    "mocha": "^11.1.0",
     "mockdate": "~3.0.2",
     "proxyquire": "~2.1.3",
     "sonarqube-scanner": "^2.9.1",
     "ts-node": "^10.8.1",
-    "typescript": "^4.1.6"
+    "typescript": "^4.1.6",
+    "nyc": "^15.1.0"
   },
   "files": [
     "lib/**/*"