tabletcommand-logger 3.2.7 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/.cspell/project-words.txt +28 -0
  2. package/CLAUDE.md +150 -0
  3. package/README.md +111 -1
  4. package/build/index.js +11 -3
  5. package/build/index.js.map +1 -1
  6. package/build/logger-types.js +3 -0
  7. package/build/logger-types.js.map +1 -0
  8. package/build/middleware/logger.js +94 -149
  9. package/build/middleware/logger.js.map +1 -1
  10. package/build/middleware/status-logger.js.map +1 -1
  11. package/build/otel.js +54 -0
  12. package/build/otel.js.map +1 -0
  13. package/build/pino-logger.js +97 -0
  14. package/build/pino-logger.js.map +1 -0
  15. package/build/redaction.js +351 -0
  16. package/build/redaction.js.map +1 -0
  17. package/build/test/logger-factory.js +207 -0
  18. package/build/test/logger-factory.js.map +1 -0
  19. package/build/test/middleware-logger.js +282 -0
  20. package/build/test/middleware-logger.js.map +1 -1
  21. package/build/test/middleware-status-logger.js.map +1 -1
  22. package/build/test/otel-mixin.js +139 -0
  23. package/build/test/otel-mixin.js.map +1 -0
  24. package/build/test/redaction.js +293 -0
  25. package/build/test/redaction.js.map +1 -0
  26. package/build/test/signature.js +111 -0
  27. package/build/test/signature.js.map +1 -0
  28. package/build/winston-logger.js +18 -47
  29. package/build/winston-logger.js.map +1 -1
  30. package/definitions/index.d.ts +5 -2
  31. package/definitions/index.d.ts.map +1 -1
  32. package/definitions/logger-types.d.ts +38 -0
  33. package/definitions/logger-types.d.ts.map +1 -0
  34. package/definitions/middleware/logger.d.ts +4 -6
  35. package/definitions/middleware/logger.d.ts.map +1 -1
  36. package/definitions/middleware/status-logger.d.ts +2 -2
  37. package/definitions/middleware/status-logger.d.ts.map +1 -1
  38. package/definitions/otel.d.ts +8 -0
  39. package/definitions/otel.d.ts.map +1 -0
  40. package/definitions/pino-logger.d.ts +6 -0
  41. package/definitions/pino-logger.d.ts.map +1 -0
  42. package/definitions/redaction.d.ts +25 -0
  43. package/definitions/redaction.d.ts.map +1 -0
  44. package/definitions/test/logger-factory.d.ts +2 -0
  45. package/definitions/test/logger-factory.d.ts.map +1 -0
  46. package/definitions/test/otel-mixin.d.ts +2 -0
  47. package/definitions/test/otel-mixin.d.ts.map +1 -0
  48. package/definitions/test/redaction.d.ts +2 -0
  49. package/definitions/test/redaction.d.ts.map +1 -0
  50. package/definitions/test/signature.d.ts +2 -0
  51. package/definitions/test/signature.d.ts.map +1 -0
  52. package/definitions/winston-logger.d.ts +2 -13
  53. package/definitions/winston-logger.d.ts.map +1 -1
  54. package/eslint.config.mjs +1 -0
  55. package/package.json +17 -5
  56. package/src/index.ts +6 -3
  57. package/src/logger-types.ts +50 -0
  58. package/src/middleware/logger.ts +101 -164
  59. package/src/middleware/status-logger.ts +2 -4
  60. package/src/otel.ts +57 -0
  61. package/src/pino-logger.ts +110 -0
  62. package/src/redaction.ts +368 -0
  63. package/src/test/logger-factory.ts +216 -0
  64. package/src/test/middleware-logger.ts +321 -2
  65. package/src/test/middleware-status-logger.ts +2 -2
  66. package/src/test/otel-mixin.ts +119 -0
  67. package/src/test/redaction.ts +409 -0
  68. package/src/test/signature.ts +126 -0
  69. package/src/winston-logger.ts +2 -72
  70. package/tabletcommand-logger-4.0.0.tgz +0 -0
@@ -1,53 +1,24 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
2
16
  var __importDefault = (this && this.__importDefault) || function (mod) {
3
17
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
18
  };
5
19
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.default = logger;
7
- const winston_1 = require("winston");
8
- const winston_daily_rotate_file_1 = __importDefault(require("winston-daily-rotate-file"));
9
- const datadog_winston_1 = __importDefault(require("datadog-winston"));
10
- function logger(config) {
11
- const loggingEnabled = config.logToConsole === true || config.logToFile === true || config.logToDatadog === true;
12
- if (!loggingEnabled) {
13
- return null;
14
- }
15
- const trs = [];
16
- if (config.logToConsole) {
17
- const cfg = new winston_1.transports.Console();
18
- trs.push(cfg);
19
- }
20
- if (config.logToFile) {
21
- const daily = new winston_daily_rotate_file_1.default({
22
- filename: `${config.filename}-%DATE%.json`,
23
- dirname: config.dirname,
24
- datePattern: "YYYY-MM-DD",
25
- zippedArchive: true,
26
- maxFiles: "52d",
27
- utc: true,
28
- watchLog: true,
29
- });
30
- trs.push(daily);
31
- }
32
- if (config.logToDatadog) {
33
- const dd = new datadog_winston_1.default({
34
- apiKey: config.datadogApiKey,
35
- service: config.name,
36
- });
37
- trs.push(dd);
38
- }
39
- const loggerClient = (0, winston_1.createLogger)({
40
- level: "info",
41
- format: winston_1.format.combine(
42
- // If you pass in a TimestampOptions, it will convert the date from UTC to local TZ
43
- winston_1.format.timestamp(), winston_1.format.errors({ stack: true }), winston_1.format.splat(), winston_1.format.json()),
44
- defaultMeta: {
45
- ...config.extraMeta,
46
- service: config.name,
47
- },
48
- transports: trs,
49
- exitOnError: false,
50
- });
51
- return loggerClient;
52
- }
20
+ exports.default = void 0;
21
+ __exportStar(require("./pino-logger"), exports);
22
+ var pino_logger_1 = require("./pino-logger");
23
+ Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(pino_logger_1).default; } });
53
24
  //# sourceMappingURL=winston-logger.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"winston-logger.js","sourceRoot":"","sources":["../src/winston-logger.ts"],"names":[],"mappings":";;;;;AAiBA,yBAoDC;AArED,qCAAmE;AAEnE,0FAAwD;AACxD,sEAA+C;AAc/C,SAAwB,MAAM,CAAC,MAAoB;IACjD,MAAM,cAAc,GAAG,MAAM,CAAC,YAAY,KAAK,IAAI,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI,CAAC;IACjH,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,GAAG,GAAgB,EAAE,CAAC;IAE5B,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,MAAM,GAAG,GAAc,IAAI,oBAAU,CAAC,OAAO,EAAE,CAAC;QAChD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,MAAM,KAAK,GAAoB,IAAI,mCAAe,CAAC;YACjD,QAAQ,EAAE,GAAG,MAAM,CAAC,QAAQ,cAAc;YAC1C,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,WAAW,EAAE,YAAY;YACzB,aAAa,EAAE,IAAI;YACnB,QAAQ,EAAE,KAAK;YACf,GAAG,EAAE,IAAI;YACT,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,IAAI,yBAAgB,CAAC;YAC9B,MAAM,EAAE,MAAM,CAAC,aAAa;YAC5B,OAAO,EAAE,MAAM,CAAC,IAAI;SACrB,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IAED,MAAM,YAAY,GAAG,IAAA,sBAAY,EAAC;QAChC,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,gBAAM,CAAC,OAAO;QACpB,mFAAmF;QACnF,gBAAM,CAAC,SAAS,EAAE,EAClB,gBAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAC9B,gBAAM,CAAC,KAAK,EAAE,EACd,gBAAM,CAAC,IAAI,EAAE,CACd;QACD,WAAW,EAAE;YACX,GAAG,MAAM,CAAC,SAAS;YACnB,OAAO,EAAE,MAAM,CAAC,IAAI;SACrB;QACD,UAAU,EAAE,GAAG;QACf,WAAW,EAAE,KAAK;KACnB,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC"}
1
+ {"version":3,"file":"winston-logger.js","sourceRoot":"","sources":["../src/winston-logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,6CAAwC;AAA/B,uHAAA,OAAO,OAAA"}
@@ -1,15 +1,18 @@
1
- import _logger from "./winston-logger";
1
+ import _logger, { isPinoPrettyAvailable } from "./pino-logger";
2
2
  import _loggerMiddleware from "./middleware/logger";
3
3
  import _metricsMiddleware, { cleanUpParams } from "./middleware/metrics";
4
4
  import _statusLogger from "./middleware/status-logger";
5
- export { LoggerConfig } from "./winston-logger";
5
+ export { LoggerConfig, StrictLogger, StrictLogMethod, LoggerModule } from "./logger-types";
6
6
  export { redactHeaders, redactOriginalURL, redactQuery } from "./middleware/logger";
7
+ export { MAX_REDACT_DEPTH, redactSecrets, redactSetCookie, secretKind } from "./redaction";
8
+ export { isPinoPrettyAvailable } from "./pino-logger";
7
9
  export declare const logger: typeof _logger;
8
10
  export declare const loggerMiddleware: typeof _loggerMiddleware;
9
11
  export declare const metricsCleanUpParams: typeof cleanUpParams;
10
12
  export declare const metricsMiddleware: typeof _metricsMiddleware;
11
13
  export declare const statusLogger: typeof _statusLogger;
12
14
  declare const _default: {
15
+ isPinoPrettyAvailable: typeof isPinoPrettyAvailable;
13
16
  logger: typeof _logger;
14
17
  loggerMiddleware: typeof _loggerMiddleware;
15
18
  metricsMiddleware: typeof _metricsMiddleware;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,kBAAkB,EAAE,EAAE,aAAa,EAAG,MAAM,sBAAsB,CAAC;AAC1E,OAAO,aAAa,MAAM,4BAA4B,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEpF,eAAO,MAAM,MAAM,gBAAU,CAAC;AAC9B,eAAO,MAAM,gBAAgB,0BAAoB,CAAC;AAClD,eAAO,MAAM,oBAAoB,sBAAgB,CAAC;AAClD,eAAO,MAAM,iBAAiB,2BAAqB,CAAC;AACpD,eAAO,MAAM,YAAY,sBAAgB,CAAC;;;;;;;;AAE1C,wBAME"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,kBAAkB,EAAE,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,aAAa,MAAM,4BAA4B,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,eAAO,MAAM,MAAM,gBAAU,CAAC;AAC9B,eAAO,MAAM,gBAAgB,0BAAoB,CAAC;AAClD,eAAO,MAAM,oBAAoB,sBAAgB,CAAC;AAClD,eAAO,MAAM,iBAAiB,2BAAqB,CAAC;AACpD,eAAO,MAAM,YAAY,sBAAgB,CAAC;;;;;;;;;AAE1C,wBAOE"}
@@ -0,0 +1,38 @@
1
+ export type LogArgument = string | number | boolean | bigint | symbol | null | undefined;
2
+ export interface StrictLogMethod {
3
+ <T extends object>(obj: T, msg?: string, ...args: unknown[]): void;
4
+ (msg: string, ...args: LogArgument[]): void;
5
+ }
6
+ export interface StrictErrorLogMethod extends StrictLogMethod {
7
+ (err: unknown, msg?: string, ...args: LogArgument[]): void;
8
+ }
9
+ export interface StrictLogger {
10
+ fatal: StrictErrorLogMethod;
11
+ error: StrictErrorLogMethod;
12
+ warn: StrictErrorLogMethod;
13
+ info: StrictLogMethod;
14
+ debug: StrictLogMethod;
15
+ trace: StrictLogMethod;
16
+ level: string;
17
+ child(bindings: Record<string, unknown>): StrictLogger;
18
+ [key: string]: unknown;
19
+ }
20
+ export type LoggerConfig = {
21
+ name: string;
22
+ /** @deprecated No-op in v4 — logs write to stdout */
23
+ filename?: string;
24
+ /** @deprecated No-op in v4 — logs write to stdout */
25
+ dirname?: string;
26
+ logToConsole?: boolean;
27
+ /** @deprecated No-op in v4 — logs write to stdout */
28
+ logToFile?: boolean;
29
+ /** @deprecated No-op in v4 — shipping handled by k8s */
30
+ logToDatadog?: boolean;
31
+ /** @deprecated No-op in v4 */
32
+ datadogApiKey?: string;
33
+ extraMeta?: Record<string, unknown>;
34
+ level?: string;
35
+ pretty?: boolean;
36
+ };
37
+ export type LoggerModule = StrictLogger | null;
38
+ //# sourceMappingURL=logger-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger-types.d.ts","sourceRoot":"","sources":["../src/logger-types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAIzF,MAAM,WAAW,eAAe;IAE9B,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAGnE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;CAC7C;AAKD,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;CAC5D;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,oBAAoB,CAAC;IAC5B,KAAK,EAAE,oBAAoB,CAAC;IAC5B,IAAI,EAAE,oBAAoB,CAAC;IAC3B,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC;IACvD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,wDAAwD;IACxD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8BAA8B;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,IAAI,CAAC"}
@@ -1,8 +1,6 @@
1
- import { Logger } from "winston";
2
1
  import { NextFunction, Request, Response } from "express";
3
- import { Query } from "express-serve-static-core";
4
- export declare function redactHeaders(headers: Request["headers"]): Request["headers"];
5
- export declare function redactQuery(query: Query): Query;
6
- export declare function redactOriginalURL(maybeURL?: string): string;
7
- export default function loggerMiddleware(logger?: Logger): (req: Request, res: Response, next: NextFunction) => void;
2
+ import { StrictLogger } from "../logger-types";
3
+ import { redactHeaders, redactOriginalURL, redactQuery } from "../redaction";
4
+ export { redactHeaders, redactOriginalURL, redactQuery };
5
+ export default function loggerMiddleware(logger?: StrictLogger | null): (_req: Request, _res: Response, next: NextFunction) => void;
8
6
  //# sourceMappingURL=logger.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AA6FlD,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAU7E;AAYD,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAS/C;AAaD,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAc3D;AAED,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,MAAM,CAAC,EAAE,MAAM,IAClB,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,UA4BpF"}
1
+ {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAG1D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,WAAW,EAEZ,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,CAAC;AAEzD,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,IAAI,UAE5B,OAAO,QAAQ,QAAQ,QAAQ,YAAY,UA+GnF"}
@@ -1,9 +1,9 @@
1
- import { Logger } from "winston";
2
1
  import { NextFunction, Request, Response } from "express";
2
+ import { StrictLogger } from "../logger-types";
3
3
  import { redactQuery } from "./logger";
4
4
  export { redactQuery };
5
5
  export declare function shouldIgnore(req: Request, res: Response): boolean;
6
6
  export declare function requestDuration(endTime: Date, startTime?: Date): number;
7
- export default function statusLogger(logger?: Logger): (req: Request, res: Response, next: NextFunction) => void;
7
+ export default function statusLogger(logger?: StrictLogger | null): (req: Request, res: Response, next: NextFunction) => void;
8
8
  export type StatusLoggerModule = ReturnType<typeof statusLogger>;
9
9
  //# sourceMappingURL=status-logger.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"status-logger.d.ts","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAoC,WAAW,EAAE,MAAM,UAAU,CAAC;AAEzE,OAAO,EAAE,WAAW,EAAE,CAAC;AAIvB,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAkBjE;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAMvE;AAED,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,IACpB,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,UAgE9E;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC"}
1
+ {"version":3,"file":"status-logger.d.ts","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAoC,WAAW,EAAE,MAAM,UAAU,CAAC;AAEzE,OAAO,EAAE,WAAW,EAAE,CAAC;AAIvB,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAkBjE;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAMvE;AAED,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,IAAI,IACjC,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,UAgE9E;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC"}
@@ -0,0 +1,8 @@
1
+ export interface OtelSpanContext {
2
+ trace_id?: string;
3
+ span_id?: string;
4
+ trace_flags?: string;
5
+ }
6
+ export declare function resetOtelForTesting(): void;
7
+ export declare function getOtelTraceContext(): OtelSpanContext;
8
+ //# sourceMappingURL=otel.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"otel.d.ts","sourceRoot":"","sources":["../src/otel.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAmBD,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED,wBAAgB,mBAAmB,IAAI,eAAe,CA4BrD"}
@@ -0,0 +1,6 @@
1
+ import { DestinationStream } from "pino";
2
+ import { LoggerConfig, StrictLogger, LoggerModule } from "./logger-types";
3
+ export { LoggerConfig, StrictLogger, LoggerModule };
4
+ export declare function isPinoPrettyAvailable(): boolean;
5
+ export default function logger(config: LoggerConfig, customDestination?: DestinationStream): StrictLogger | null;
6
+ //# sourceMappingURL=pino-logger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pino-logger.d.ts","sourceRoot":"","sources":["../src/pino-logger.ts"],"names":[],"mappings":"AAAA,OAAa,EAAiB,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAI1E,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;AAEpD,wBAAgB,qBAAqB,IAAI,OAAO,CAY/C;AAED,MAAM,CAAC,OAAO,UAAU,MAAM,CAC5B,MAAM,EAAE,YAAY,EACpB,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,YAAY,GAAG,IAAI,CAuErB"}
@@ -0,0 +1,25 @@
1
+ import { Request } from "express";
2
+ import { Query } from "express-serve-static-core";
3
+ export declare const keyHeaders: string[];
4
+ export declare const keyParams: string[];
5
+ export declare function isKeyParam(name: string): boolean;
6
+ export declare function decodeName(name: string): string;
7
+ export declare const redacted = "<redacted>";
8
+ export declare function keepPrefix(value: string): string;
9
+ export declare function redactAuthorization(value: string): string;
10
+ export declare function redactCookie(value: string): string;
11
+ export declare function redactSetCookie(value: string): string;
12
+ export declare function redactorFor(name: string): (value: string) => string;
13
+ export declare function redactHeaderValue(name: string, value: unknown): string | string[];
14
+ export declare function redactHeaders(headers: Request["headers"]): Request["headers"];
15
+ export declare function redactQueryValue(value: Query[string]): Query[string];
16
+ export declare function redactQuery(query: Query): Query;
17
+ export declare function redactParamPair(pair: string): string;
18
+ export declare function redactOriginalURL(maybeURL?: string): string;
19
+ export declare function normalizeKey(key: string): string;
20
+ export type SecretKind = "full" | "prefix" | "authorization" | "cookie" | "set-cookie";
21
+ export declare function secretKind(key: string): SecretKind | null;
22
+ export declare function redactSecretValue(kind: SecretKind, value: unknown): unknown;
23
+ export declare const MAX_REDACT_DEPTH = 10;
24
+ export declare function redactSecrets<T>(value: T): T;
25
+ //# sourceMappingURL=redaction.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"redaction.d.ts","sourceRoot":"","sources":["../src/redaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAKlD,eAAO,MAAM,UAAU,UAKtB,CAAC;AAIF,eAAO,MAAM,SAAS,UAIrB,CAAC;AAIF,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGhD;AAMD,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAM/C;AAED,eAAO,MAAM,QAAQ,eAAe,CAAC;AAErC,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAQD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMzD;AAGD,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAOlD;AAKD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAwBrD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAWnE;AAKD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,EAAE,CASjF;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAW7E;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAQpE;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAS/C;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMpD;AAKD,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAc3D;AAMD,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAmDD,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEvF,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAsBzD;AAmBD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAW3E;AAID,eAAO,MAAM,gBAAgB,KAAK,CAAC;AA8DnC,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAE5C"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=logger-factory.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger-factory.d.ts","sourceRoot":"","sources":["../../src/test/logger-factory.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=otel-mixin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"otel-mixin.d.ts","sourceRoot":"","sources":["../../src/test/otel-mixin.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=redaction.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"redaction.d.ts","sourceRoot":"","sources":["../../src/test/redaction.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=signature.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../src/test/signature.ts"],"names":[],"mappings":""}
@@ -1,14 +1,3 @@
1
- import { Logger } from "winston";
2
- export type LoggerConfig = {
3
- name: string;
4
- filename: string;
5
- dirname: string;
6
- logToConsole: boolean;
7
- logToFile: boolean;
8
- logToDatadog: boolean;
9
- datadogApiKey: string;
10
- extraMeta?: Record<string, unknown>;
11
- };
12
- export default function logger(config: LoggerConfig): Logger | null;
13
- export type LoggerModule = ReturnType<typeof logger>;
1
+ export * from "./pino-logger";
2
+ export { default } from "./pino-logger";
14
3
  //# sourceMappingURL=winston-logger.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"winston-logger.d.ts","sourceRoot":"","sources":["../src/winston-logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoC,MAAM,EAAE,MAAM,SAAS,CAAC;AAKnE,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IAEnB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,GAAG,IAAI,CAoDlE;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAC"}
1
+ {"version":3,"file":"winston-logger.d.ts","sourceRoot":"","sources":["../src/winston-logger.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC"}
package/eslint.config.mjs CHANGED
@@ -90,6 +90,7 @@ export default defineConfig([
90
90
  files: ["src/test/**"],
91
91
  rules: {
92
92
  "@typescript-eslint/no-floating-promises": [0],
93
+ "n/no-unpublished-import": [0],
93
94
  },
94
95
  }
95
96
  ]);
package/package.json CHANGED
@@ -1,7 +1,19 @@
1
1
  {
2
2
  "name": "tabletcommand-logger",
3
- "version": "3.2.7",
3
+ "version": "4.0.0",
4
4
  "description": "Tablet Command Logging Configuration",
5
+ "peerDependencies": {
6
+ "@opentelemetry/api": "^1.0.0",
7
+ "pino-pretty": "^13.0.0"
8
+ },
9
+ "peerDependenciesMeta": {
10
+ "@opentelemetry/api": {
11
+ "optional": true
12
+ },
13
+ "pino-pretty": {
14
+ "optional": true
15
+ }
16
+ },
5
17
  "scripts": {
6
18
  "build": "gulp ts",
7
19
  "lint": "gulp lint",
@@ -16,18 +28,17 @@
16
28
  "main": "build/index.js",
17
29
  "types": "definitions/index.d.ts",
18
30
  "dependencies": {
19
- "datadog-winston": "^1.6.0",
20
31
  "debug": "^4.4.3",
21
32
  "express-statsd": "^0.3.0",
22
33
  "lodash": "^4.18.1",
23
- "winston": "^3.19.0",
24
- "winston-daily-rotate-file": "^5.0.0"
34
+ "pino": "^10.4.0",
35
+ "pino-http": "^11.0.0"
25
36
  },
26
37
  "devDependencies": {
27
38
  "@eslint/eslintrc": "^3.3.5",
28
39
  "@eslint/js": "^9.39.4",
40
+ "@opentelemetry/api": "^1.10.0",
29
41
  "@types/chai": "^5.2.3",
30
- "@types/datadog-winston": "^1.0.7",
31
42
  "@types/debug": "4.1.13",
32
43
  "@types/express": "^4.17.25",
33
44
  "@types/express-serve-static-core": "^4.19.8",
@@ -46,6 +57,7 @@
46
57
  "gulp": "^5.0.1",
47
58
  "gulp-execa": "^8.0.1",
48
59
  "neostandard": "^0.13.0",
60
+ "pino-pretty": "^13.2.0",
49
61
  "tsx": "^4.21.0",
50
62
  "type-coverage": "^2.29.7",
51
63
  "typescript": "~5.9.3"
package/src/index.ts CHANGED
@@ -1,10 +1,12 @@
1
- import _logger from "./winston-logger";
1
+ import _logger, { isPinoPrettyAvailable } from "./pino-logger";
2
2
  import _loggerMiddleware from "./middleware/logger";
3
- import _metricsMiddleware, { cleanUpParams, } from "./middleware/metrics";
3
+ import _metricsMiddleware, { cleanUpParams } from "./middleware/metrics";
4
4
  import _statusLogger from "./middleware/status-logger";
5
5
 
6
- export { LoggerConfig } from "./winston-logger";
6
+ export { LoggerConfig, StrictLogger, StrictLogMethod, LoggerModule } from "./logger-types";
7
7
  export { redactHeaders, redactOriginalURL, redactQuery } from "./middleware/logger";
8
+ export { MAX_REDACT_DEPTH, redactSecrets, redactSetCookie, secretKind } from "./redaction";
9
+ export { isPinoPrettyAvailable } from "./pino-logger";
8
10
 
9
11
  export const logger = _logger;
10
12
  export const loggerMiddleware = _loggerMiddleware;
@@ -13,6 +15,7 @@ export const metricsMiddleware = _metricsMiddleware;
13
15
  export const statusLogger = _statusLogger;
14
16
 
15
17
  export default {
18
+ isPinoPrettyAvailable,
16
19
  logger,
17
20
  loggerMiddleware,
18
21
  metricsMiddleware,
@@ -0,0 +1,50 @@
1
+ export type LogArgument = string | number | boolean | bigint | symbol | null | undefined;
2
+
3
+ // The inverted Winston call `(msg, obj)` matches neither overload: the first needs an
4
+ // object first, the second only takes primitives after the message.
5
+ export interface StrictLogMethod {
6
+ // 1. Structured object first (Pino convention)
7
+ <T extends object>(obj: T, msg?: string, ...args: unknown[]): void;
8
+
9
+ // 2. String message only, followed by optional primitive interpolation values
10
+ (msg: string, ...args: LogArgument[]): void;
11
+ }
12
+
13
+ // error/warn/fatal also take a caught value, which is `unknown` under strict mode, so
14
+ // `catch (err) { logger.error(err, "msg") }` compiles without a cast. The message must
15
+ // still be a string, so the inverted `(msg, obj)` call stays a compile error.
16
+ export interface StrictErrorLogMethod extends StrictLogMethod {
17
+ (err: unknown, msg?: string, ...args: LogArgument[]): void;
18
+ }
19
+
20
+ export interface StrictLogger {
21
+ fatal: StrictErrorLogMethod;
22
+ error: StrictErrorLogMethod;
23
+ warn: StrictErrorLogMethod;
24
+ info: StrictLogMethod;
25
+ debug: StrictLogMethod;
26
+ trace: StrictLogMethod;
27
+ level: string;
28
+ child(bindings: Record<string, unknown>): StrictLogger;
29
+ [key: string]: unknown;
30
+ }
31
+
32
+ export type LoggerConfig = {
33
+ name: string;
34
+ /** @deprecated No-op in v4 — logs write to stdout */
35
+ filename?: string;
36
+ /** @deprecated No-op in v4 — logs write to stdout */
37
+ dirname?: string;
38
+ logToConsole?: boolean;
39
+ /** @deprecated No-op in v4 — logs write to stdout */
40
+ logToFile?: boolean;
41
+ /** @deprecated No-op in v4 — shipping handled by k8s */
42
+ logToDatadog?: boolean;
43
+ /** @deprecated No-op in v4 */
44
+ datadogApiKey?: string;
45
+ extraMeta?: Record<string, unknown>;
46
+ level?: string;
47
+ pretty?: boolean;
48
+ };
49
+
50
+ export type LoggerModule = StrictLogger | null;