@nestjs-labs/nestjs-pino-extra 1.0.0 → 1.1.0-alpha.1

package/dist/formatters.d.ts

@@ -1,10 +0,0 @@
-/**
- * add custom formatters
- * https://github.com/pinojs/pino-http?tab=readme-ov-file#custom-formatters
- */
-export declare function getOtelFormatters(spanIdKey?: string, traceIdKey?: string): {
-    level: (label: string) => {
-        level: string;
-    };
-    log(object: Record<string, unknown>): Record<string, unknown>;
-};

package/dist/formatters.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOtelFormatters = getOtelFormatters;
-const api_1 = require("@opentelemetry/api");
-/**
- * add custom formatters
- * https://github.com/pinojs/pino-http?tab=readme-ov-file#custom-formatters
- */
-function getOtelFormatters(spanIdKey = 'spanId', traceIdKey = 'traceId') {
-    return {
-        level: (label) => {
-            return { level: label };
-        },
-        // Workaround for PinoInstrumentation (does not support latest version yet)
-        log(object) {
-            var _a;
-            const span = api_1.trace.getSpan(api_1.context.active());
-            if (!span)
-                return object;
-            const spanContext = (_a = api_1.trace.getSpan(api_1.context.active())) === null || _a === void 0 ? void 0 : _a.spanContext();
-            if (!spanContext)
-                return object;
-            const { spanId, traceId } = spanContext;
-            return { ...object, [spanIdKey]: spanId, [traceIdKey]: traceId };
-        },
-    };
-}
-//# sourceMappingURL=formatters.js.map

package/dist/formatters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatters.js","sourceRoot":"","sources":["../src/formatters.ts"],"names":[],"mappings":";;AAMA,8CAmBC;AAzBD,4CAAoD;AAEpD;;;GAGG;AACH,SAAgB,iBAAiB,CAC/B,YAAoB,QAAQ,EAC5B,aAAqB,SAAS;IAE9B,OAAO;QACL,KAAK,EAAE,CAAC,KAAa,EAAE,EAAE;YACvB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAC1B,CAAC;QACD,2EAA2E;QAC3E,GAAG,CAAC,MAA+B;;YACjC,MAAM,IAAI,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI;gBAAE,OAAO,MAAM,CAAC;YACzB,MAAM,WAAW,GAAG,MAAA,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,WAAW,EAAE,CAAC;YACnE,IAAI,CAAC,WAAW;gBAAE,OAAO,MAAM,CAAC;YAEhC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;YACxC,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;QACnE,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { context, trace } from '@opentelemetry/api';\n\n/**\n * add custom formatters\n * https://github.com/pinojs/pino-http?tab=readme-ov-file#custom-formatters\n */\nexport function getOtelFormatters(\n  spanIdKey: string = 'spanId',\n  traceIdKey: string = 'traceId',\n) {\n  return {\n    level: (label: string) => {\n      return { level: label };\n    },\n    // Workaround for PinoInstrumentation (does not support latest version yet)\n    log(object: Record<string, unknown>) {\n      const span = trace.getSpan(context.active());\n      if (!span) return object;\n      const spanContext = trace.getSpan(context.active())?.spanContext();\n      if (!spanContext) return object;\n\n      const { spanId, traceId } = spanContext;\n      return { ...object, [spanIdKey]: spanId, [traceIdKey]: traceId };\n    },\n  };\n}\n"]}

package/dist/options.d.ts

@@ -1,5 +0,0 @@
-import type { Options } from 'pino-http';
-/**
- * get pino http option
- */
-export declare function getPinoHttpOption(level?: string, spanIdKey?: string, traceIdKey?: string): Options;

package/dist/options.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPinoHttpOption = getPinoHttpOption;
-const node_crypto_1 = require("node:crypto");
-const pino_1 = require("pino");
-const formatters_1 = require("./formatters");
-const serializers_1 = require("./serializers");
-/**
- * get pino http option
- */
-function getPinoHttpOption(level = 'info', spanIdKey = 'spanId', traceIdKey = 'traceId') {
-    return {
-        // https://getpino.io/#/docs/api?id=timestamp-boolean-function
-        // Change time value in production log.
-        // timestamp: stdTimeFunctions.isoTime,
-        level,
-        quietReqLogger: false,
-        timestamp: pino_1.default.stdTimeFunctions.isoTime,
-        customAttributeKeys: {
-            req: 'req',
-            res: 'res',
-            err: 'err',
-            responseTime: 'taken(ms)',
-        },
-        formatters: (0, formatters_1.getOtelFormatters)(spanIdKey, traceIdKey),
-        serializers: (0, serializers_1.getSerializers)(),
-        redact: {
-            paths: [
-                'password',
-                'reqBody.password',
-                'user.password',
-                'reqBody.user.password',
-            ],
-        },
-        genReqId: function (req, res) {
-            var _a;
-            const reqId = (_a = req.id) !== null && _a !== void 0 ? _a : req.headers['x-request-id'];
-            if (reqId)
-                return reqId;
-            const id = (0, node_crypto_1.randomUUID)();
-            res.setHeader('X-Request-Id', id);
-            return id;
-        },
-        // Define a custom logger level
-        customLogLevel(_, res, err) {
-            if (res.statusCode >= 400 && res.statusCode < 500) {
-                return 'warn';
-            }
-            else if (res.statusCode >= 500 || err) {
-                return 'error';
-            }
-            else if (res.statusCode >= 300 && res.statusCode < 400) {
-                return 'silent';
-            }
-            return 'info';
-        },
-    };
-}
-//# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;AAYA,8CAoDC;AA/DD,6CAAyC;AAEzC,+BAAwB;AAGxB,6CAAiD;AACjD,+CAA+C;AAE/C;;GAEG;AACH,SAAgB,iBAAiB,CAC/B,QAAgB,MAAM,EACtB,YAAoB,QAAQ,EAC5B,aAAqB,SAAS;IAE9B,OAAO;QACL,8DAA8D;QAC9D,uCAAuC;QACvC,uCAAuC;QACvC,KAAK;QACL,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,cAAI,CAAC,gBAAgB,CAAC,OAAO;QACxC,mBAAmB,EAAE;YACnB,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,YAAY,EAAE,WAAW;SAC1B;QACD,UAAU,EAAE,IAAA,8BAAiB,EAAC,SAAS,EAAE,UAAU,CAAC;QACpD,WAAW,EAAE,IAAA,4BAAc,GAAE;QAC7B,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,UAAU;gBACV,kBAAkB;gBAClB,eAAe;gBACf,uBAAuB;aACxB;SACF;QACD,QAAQ,EAAE,UAAU,GAAG,EAAE,GAAG;;YAC1B,MAAM,KAAK,GAAG,MAAA,GAAG,CAAC,EAAE,mCAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACpD,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;YACxB,MAAM,EAAE,GAAG,IAAA,wBAAU,GAAE,CAAC;YACxB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAClC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,+BAA+B;QAC/B,cAAc,CACZ,CAAkB,EAClB,GAAoC,EACpC,GAAW;YAEX,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;gBAClD,OAAO,MAAM,CAAC;YAChB,CAAC;iBAAM,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;gBACxC,OAAO,OAAO,CAAC;YACjB,CAAC;iBAAM,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import type { IncomingMessage, ServerResponse } from 'http';\nimport { randomUUID } from 'node:crypto';\n\nimport pino from 'pino';\nimport type { Options } from 'pino-http';\n\nimport { getOtelFormatters } from './formatters';\nimport { getSerializers } from './serializers';\n\n/**\n * get pino http option\n */\nexport function getPinoHttpOption(\n  level: string = 'info',\n  spanIdKey: string = 'spanId',\n  traceIdKey: string = 'traceId',\n): Options {\n  return {\n    // https://getpino.io/#/docs/api?id=timestamp-boolean-function\n    // Change time value in production log.\n    // timestamp: stdTimeFunctions.isoTime,\n    level,\n    quietReqLogger: false,\n    timestamp: pino.stdTimeFunctions.isoTime,\n    customAttributeKeys: {\n      req: 'req',\n      res: 'res',\n      err: 'err',\n      responseTime: 'taken(ms)',\n    },\n    formatters: getOtelFormatters(spanIdKey, traceIdKey),\n    serializers: getSerializers(),\n    redact: {\n      paths: [\n        'password',\n        'reqBody.password',\n        'user.password',\n        'reqBody.user.password',\n      ],\n    },\n    genReqId: function (req, res) {\n      const reqId = req.id ?? req.headers['x-request-id'];\n      if (reqId) return reqId;\n      const id = randomUUID();\n      res.setHeader('X-Request-Id', id);\n      return id;\n    },\n    // Define a custom logger level\n    customLogLevel(\n      _: IncomingMessage,\n      res: ServerResponse<IncomingMessage>,\n      err?: Error,\n    ) {\n      if (res.statusCode >= 400 && res.statusCode < 500) {\n        return 'warn';\n      } else if (res.statusCode >= 500 || err) {\n        return 'error';\n      } else if (res.statusCode >= 300 && res.statusCode < 400) {\n        return 'silent';\n      }\n\n      return 'info';\n    },\n  };\n}\n"]}

package/dist/serializers.d.ts

@@ -1,8 +0,0 @@
-import type { SerializerFn } from 'pino';
-/**
- * get serializers
- * https://github.com/pinojs/pino-http?tab=readme-ov-file#custom-serializers--custom-log-attribute-keys
- */
-export declare function getSerializers(): {
-    [key: string]: SerializerFn;
-};

package/dist/serializers.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSerializers = getSerializers;
-/**
- * get serializers
- * https://github.com/pinojs/pino-http?tab=readme-ov-file#custom-serializers--custom-log-attribute-keys
- */
-function getSerializers() {
-    return {
-        req(req) {
-            const request = req.raw;
-            return {
-                id: req.id,
-                method: req.method,
-                url: req.url,
-                headers: request.headers,
-                query: request.query,
-                body: request.body,
-            };
-        },
-        res(response) {
-            const { statusCode: status, ...serialized } = response;
-            return Object.assign({ status }, serialized);
-        },
-        err(err) {
-            return err;
-        },
-    };
-}
-//# sourceMappingURL=serializers.js.map

package/dist/serializers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializers.js","sourceRoot":"","sources":["../src/serializers.ts"],"names":[],"mappings":";;AAWA,wCAuBC;AA3BD;;;GAGG;AACH,SAAgB,cAAc;IAC5B,OAAO;QACL,GAAG,CAAC,GAAsB;YACxB,MAAM,OAAO,GAAG,GAAG,CAAC,GAEnB,CAAC;YACF,OAAO;gBACL,EAAE,EAAE,GAAG,CAAC,EAAE;gBACV,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,GAAG,CAAC,GAAG;gBACZ,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,QAA4B;YAC9B,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,QAAQ,CAAC;YACvD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;QAC/C,CAAC;QACD,GAAG,CAAC,GAAoB;YACtB,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import type { SerializerFn } from 'pino';\nimport type {\n  SerializedError,\n  SerializedRequest,\n  SerializedResponse,\n} from 'pino-std-serializers';\n\n/**\n * get serializers\n * https://github.com/pinojs/pino-http?tab=readme-ov-file#custom-serializers--custom-log-attribute-keys\n */\nexport function getSerializers(): { [key: string]: SerializerFn } {\n  return {\n    req(req: SerializedRequest) {\n      const request = req.raw as unknown as Request & {\n        query: Record<string, unknown>;\n      };\n      return {\n        id: req.id,\n        method: req.method,\n        url: req.url,\n        headers: request.headers,\n        query: request.query,\n        body: request.body,\n      };\n    },\n    res(response: SerializedResponse) {\n      const { statusCode: status, ...serialized } = response;\n      return Object.assign({ status }, serialized);\n    },\n    err(err: SerializedError) {\n      return err;\n    },\n  };\n}\n"]}

package/dist/streams.d.ts

@@ -1,20 +0,0 @@
-import pino from 'pino';
-/**
- * create pretty stream entry
- */
-export declare function createPrettyStreamEntry(app: string, level: pino.Level): pino.StreamEntry;
-/**
- * create loki stream entry
- * https://github.com/pinojs/pino/blob/master/docs/transports.md#pino-loki
- */
-export declare function createLokiStreamEntry(app: string, level: pino.Level, host: string): pino.StreamEntry;
-/**
- * create file stream entry
- * https://github.com/iccicci/rotating-file-stream?tab=readme-ov-file#initialrotation
- */
-export declare function createFileStreamEntry(app: string, level: pino.Level, filepath: string): pino.StreamEntry;
-/**
- * add multi destination stream
- * support pretty, file, loki
- */
-export declare function getMultiDestinationStream(app: string, level?: pino.Level, filepath?: string, loki?: string): pino.MultiStreamRes;

package/dist/streams.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPrettyStreamEntry = createPrettyStreamEntry;
-exports.createLokiStreamEntry = createLokiStreamEntry;
-exports.createFileStreamEntry = createFileStreamEntry;
-exports.getMultiDestinationStream = getMultiDestinationStream;
-const node_path_1 = require("node:path");
-const pino_1 = require("pino");
-const pino_loki_1 = require("pino-loki");
-const pino_pretty_1 = require("pino-pretty");
-const rotating_file_stream_1 = require("rotating-file-stream");
-/**
- * create pretty stream entry
- */
-function createPrettyStreamEntry(app, level) {
-    const stream = (0, pino_pretty_1.default)({
-        translateTime: false,
-        hideObject: false,
-        colorize: true,
-    });
-    return { level, stream };
-}
-/**
- * create loki stream entry
- * https://github.com/pinojs/pino/blob/master/docs/transports.md#pino-loki
- */
-function createLokiStreamEntry(app, level, host) {
-    const stream = (0, pino_loki_1.pinoLoki)({
-        replaceTimestamp: true,
-        batching: true,
-        interval: 5,
-        host, // Change if Loki hostname is different
-        labels: { app },
-    });
-    return { level, stream };
-}
-/**
- * create file stream entry
- * https://github.com/iccicci/rotating-file-stream?tab=readme-ov-file#initialrotation
- */
-function createFileStreamEntry(app, level, filepath) {
-    const { dir, base } = node_path_1.default.parse(filepath);
-    const stream = (0, rotating_file_stream_1.createStream)(base, {
-        size: '1G', // 1G rotate every 1 Gigabyte written
-        interval: '1d', // rotate daily
-        compress: 'gzip', // compress rotated files
-        path: dir,
-    });
-    return { level, stream };
-}
-/**
- * add multi destination stream
- * support pretty, file, loki
- */
-function getMultiDestinationStream(app, level = 'info', filepath, loki) {
-    const entries = [createPrettyStreamEntry(app, level)];
-    if (filepath)
-        entries.push(createFileStreamEntry(app, level, filepath));
-    if (loki)
-        entries.push(createLokiStreamEntry(app, level, loki));
-    return pino_1.default.multistream(entries);
-}
-//# sourceMappingURL=streams.js.map

package/dist/streams.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"streams.js","sourceRoot":"","sources":["../src/streams.ts"],"names":[],"mappings":";;AAUA,0DAUC;AAMD,sDAaC;AAMD,sDAcC;AAMD,8DAWC;AA5ED,yCAA6B;AAE7B,+BAAwB;AACxB,yCAAqC;AACrC,6CAAqC;AACrC,+DAAoD;AAEpD;;GAEG;AACH,SAAgB,uBAAuB,CACrC,GAAW,EACX,KAAiB;IAEjB,MAAM,MAAM,GAAG,IAAA,qBAAU,EAAC;QACxB,aAAa,EAAE,KAAK;QACpB,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CACnC,GAAW,EACX,KAAiB,EACjB,IAAY;IAEZ,MAAM,MAAM,GAAG,IAAA,oBAAQ,EAAC;QACtB,gBAAgB,EAAE,IAAI;QACtB,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,uCAAuC;QAC7C,MAAM,EAAE,EAAE,GAAG,EAAE;KAChB,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CACnC,GAAW,EACX,KAAiB,EACjB,QAAgB;IAEhB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,mBAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE3C,MAAM,MAAM,GAAG,IAAA,mCAAY,EAAC,IAAI,EAAE;QAChC,IAAI,EAAE,IAAI,EAAE,qCAAqC;QACjD,QAAQ,EAAE,IAAI,EAAE,eAAe;QAC/B,QAAQ,EAAE,MAAM,EAAE,yBAAyB;QAC3C,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,SAAgB,yBAAyB,CACvC,GAAW,EACX,QAAoB,MAAM,EAC1B,QAAiB,EACjB,IAAa;IAEb,MAAM,OAAO,GAAuB,CAAC,uBAAuB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAC1E,IAAI,QAAQ;QAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IACxE,IAAI,IAAI;QAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhE,OAAO,cAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC","sourcesContent":["import path from 'node:path';\n\nimport pino from 'pino';\nimport { pinoLoki } from 'pino-loki';\nimport pinoPretty from 'pino-pretty';\nimport { createStream } from 'rotating-file-stream';\n\n/**\n * create pretty stream entry\n */\nexport function createPrettyStreamEntry(\n  app: string,\n  level: pino.Level,\n): pino.StreamEntry {\n  const stream = pinoPretty({\n    translateTime: false,\n    hideObject: false,\n    colorize: true,\n  });\n  return { level, stream };\n}\n\n/**\n * create loki stream entry\n * https://github.com/pinojs/pino/blob/master/docs/transports.md#pino-loki\n */\nexport function createLokiStreamEntry(\n  app: string,\n  level: pino.Level,\n  host: string,\n): pino.StreamEntry {\n  const stream = pinoLoki({\n    replaceTimestamp: true,\n    batching: true,\n    interval: 5,\n    host, // Change if Loki hostname is different\n    labels: { app },\n  });\n  return { level, stream };\n}\n\n/**\n * create file stream entry\n * https://github.com/iccicci/rotating-file-stream?tab=readme-ov-file#initialrotation\n */\nexport function createFileStreamEntry(\n  app: string,\n  level: pino.Level,\n  filepath: string,\n): pino.StreamEntry {\n  const { dir, base } = path.parse(filepath);\n\n  const stream = createStream(base, {\n    size: '1G', // 1G rotate every 1 Gigabyte written\n    interval: '1d', // rotate daily\n    compress: 'gzip', // compress rotated files\n    path: dir,\n  });\n  return { level, stream };\n}\n\n/**\n * add multi destination stream\n * support pretty, file, loki\n */\nexport function getMultiDestinationStream(\n  app: string,\n  level: pino.Level = 'info',\n  filepath?: string,\n  loki?: string,\n): pino.MultiStreamRes {\n  const entries: pino.StreamEntry[] = [createPrettyStreamEntry(app, level)];\n  if (filepath) entries.push(createFileStreamEntry(app, level, filepath));\n  if (loki) entries.push(createLokiStreamEntry(app, level, loki));\n\n  return pino.multistream(entries);\n}\n"]}