@contrast/logger - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0

lib/index.js

@@ -46,2 +46,4 @@ "use strict";
 const common_1 = require("@contrast/common");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 const pino_1 = __importDefault(require("pino"));
@@ -59,13 +61,24 @@ const serializers = __importStar(require("./serializers"));
     const config = core.config.agent.logger;
-    const targets = [
-        {
-            target: 'pino/file',
-            level: 'trace',
-            options: {
-                append: config.append,
-                destination: config.path,
-                mkdir: true,
-            },
-        },
-    ];
+    const targets = [];
+    let err;
+    if (config.path !== '/dev/null') {
+        try {
+            // fs methods throw if we don't have write permissions.
+            fs_1.default.mkdirSync(path_1.default.dirname(config.path), { recursive: true });
+            fs_1.default.openSync(config.path, config.append ? 'a' : 'w');
+            targets.push({
+                target: 'pino/file',
+                level: 'trace',
+                options: {
+                    append: config.append,
+                    destination: config.path,
+                },
+            });
+        }
+        catch (cause) {
+            err = new Error('Unable to write to the configured log file. To disable writing to a log file, set `agent.logger.path` to \'/dev/null\', or set CONTRAST__AGENT__LOGGER__PATH="/dev/null" in your environment', 
+            // @ts-expect-error `cause` requires ts to target es2022 or above, which corresponds to Node 17+, despite being added to Node in 16.9
+            { cause });
+        }
+    }
     if (config.stdout) {
@@ -78,2 +91,4 @@ targets.push({
     }
+    if (err && targets.length === 0)
+        throw err;
     const logger = core.logger = extend((0, pino_1.default)({
@@ -106,5 +121,7 @@ name: 'contrast',
     }
-    return core.logger;
+    if (err)
+        logger.error({ err });
+    return logger;
 }
 exports.default = init;
 //# sourceMappingURL=index.js.map

lib/serializers.d.ts

@@ -78,2 +78,6 @@ import { Config } from '@contrast/config';
             };
+            metrics: {
+                enable: boolean;
+                warn_ms: number;
+            };
         };
@@ -131,2 +135,4 @@ };
 export declare const err: (err: Error) => Record<string, any>;
+/** Excludes irrelevant information from the metrics object.  */
+export declare function metrics({ start, timeout, ...metrics }: any): any;
 /**
@@ -133,0 +139,0 @@ * Serializes requests for the contrast-ui http logger.

lib/serializers.js

@@ -17,3 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.res = exports.req = exports.err = exports.config = void 0;
+exports.res = exports.req = exports.metrics = exports.err = exports.config = void 0;
 const pino_1 = require("pino");
@@ -33,2 +33,7 @@ /**
 exports.err = pino_1.stdSerializers.wrapErrorSerializer(({ stdout, stderr, ...err }) => err);
+/** Excludes irrelevant information from the metrics object.  */
+function metrics({ start, timeout, ...metrics }) {
+    return metrics;
+}
+exports.metrics = metrics;
 /**
@@ -35,0 +40,0 @@ * Serializes requests for the contrast-ui http logger.

package.json

 {
   "name": "@contrast/logger",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Centralized logging for Contrast agent services",
@@ -5,0 +5,0 @@ "license": "SEE LICENSE IN LICENSE",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29472

increased by7.92%

Lines of code

388

increased by7.78%

Worsened metrics

Number of low supply chain risk alerts

3

increased by50%

No dependency changes