tabletcommand-logger 3.0.4 → 3.2.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.
- package/build/middleware/logger.js +9 -1
- package/build/middleware/logger.js.map +1 -1
- package/build/middleware/status-logger.js +13 -0
- package/build/middleware/status-logger.js.map +1 -1
- package/build/winston-logger.js +4 -1
- package/build/winston-logger.js.map +1 -1
- package/definitions/middleware/logger.d.ts +1 -0
- package/definitions/middleware/logger.d.ts.map +1 -1
- package/definitions/middleware/metrics.d.ts +2 -2
- package/definitions/middleware/metrics.d.ts.map +1 -1
- package/definitions/middleware/status-logger.d.ts +6 -1
- package/definitions/middleware/status-logger.d.ts.map +1 -1
- package/definitions/winston-logger.d.ts +3 -2
- package/definitions/winston-logger.d.ts.map +1 -1
- package/package.json +13 -13
- package/src/middleware/logger.ts +9 -1
- package/src/middleware/status-logger.ts +15 -2
- package/src/winston-logger.ts +5 -1
- package/definitions/bunyan-logger.d.ts +0 -4
- package/definitions/bunyan-logger.d.ts.map +0 -1
- package/definitions/middleware/types.d.ts +0 -1
- package/definitions/middleware/types.d.ts.map +0 -1
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.redactOriginalURL = void 0;
|
|
4
|
+
function redactOriginalURL(maybeURL) {
|
|
5
|
+
if (!maybeURL) {
|
|
6
|
+
return "";
|
|
7
|
+
}
|
|
8
|
+
return maybeURL.replace(/apikey=.*?(&|$)/, "apikey=xxx&");
|
|
9
|
+
}
|
|
10
|
+
exports.redactOriginalURL = redactOriginalURL;
|
|
3
11
|
function loggerMiddleware(logger) {
|
|
4
12
|
return function accessLogMiddleware(req, res, next) {
|
|
5
13
|
// This doesn't fire the log immediately, but waits until the response is finished
|
|
@@ -12,7 +20,7 @@ function loggerMiddleware(logger) {
|
|
|
12
20
|
logger.info({
|
|
13
21
|
remoteAddress: req.ip,
|
|
14
22
|
method: req.method,
|
|
15
|
-
url: req.originalUrl,
|
|
23
|
+
url: redactOriginalURL(req.originalUrl),
|
|
16
24
|
protocol: req.protocol,
|
|
17
25
|
hostname: req.hostname,
|
|
18
26
|
httpVersion: `${req.httpVersionMajor}.${req.httpVersionMinor}`,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":";;;AAOA,SAAgB,iBAAiB,CAAC,QAAiB;IACjD,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;AAC5D,CAAC;AAND,8CAMC;AAED,SAAwB,gBAAgB,CAAC,MAAe;IACtD,OAAO,SAAS,mBAAmB,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QACjF,kFAAkF;QAClF,2DAA2D;QAC3D,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;YACpB,gCAAgC;YAChC,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO;aACR;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,aAAa,EAAE,GAAG,CAAC,EAAE;gBACrB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC;gBACvC,QAAQ,EAAE,GAAG,CAAC,QAAQ;gBACtB,QAAQ,EAAE,GAAG,CAAC,QAAQ;gBACtB,WAAW,EAAE,GAAG,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAC,gBAAgB,EAAE;gBAC9D,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC;gBACpC,yBAAyB;gBACzB,GAAG,EAAE;oBACH,IAAI,EAAE,GAAG,CAAC,IAAe;oBACzB,OAAO,EAAE,GAAG,CAAC,OAAO;oBACpB,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,WAAW,EAAE,GAAG,CAAC,WAAW;iBAC7B;gBACD,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aAC5C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AA7BD,mCA6BC"}
|
|
@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.redactQuery = exports.requestDuration = exports.shouldIgnore = void 0;
|
|
6
7
|
const lodash_1 = __importDefault(require("lodash"));
|
|
8
|
+
const logger_1 = require("./logger");
|
|
7
9
|
const allowedMethods = ["POST"];
|
|
8
10
|
function shouldIgnore(req, res) {
|
|
9
11
|
var _a;
|
|
@@ -22,12 +24,21 @@ function shouldIgnore(req, res) {
|
|
|
22
24
|
}
|
|
23
25
|
return false;
|
|
24
26
|
}
|
|
27
|
+
exports.shouldIgnore = shouldIgnore;
|
|
25
28
|
function requestDuration(endTime, startTime) {
|
|
26
29
|
if (!lodash_1.default.isObject(startTime) || !lodash_1.default.isDate(startTime)) {
|
|
27
30
|
return 0;
|
|
28
31
|
}
|
|
29
32
|
return endTime.valueOf() - startTime.valueOf();
|
|
30
33
|
}
|
|
34
|
+
exports.requestDuration = requestDuration;
|
|
35
|
+
function redactQuery(q) {
|
|
36
|
+
if (lodash_1.default.isString(q.apikey)) {
|
|
37
|
+
q.apikey = q.apikey.substring(0, 7);
|
|
38
|
+
}
|
|
39
|
+
return q;
|
|
40
|
+
}
|
|
41
|
+
exports.redactQuery = redactQuery;
|
|
31
42
|
function statusLogger(logger) {
|
|
32
43
|
return function requestLogger(req, res, next) {
|
|
33
44
|
if (!lodash_1.default.isObject(req._startTime)) {
|
|
@@ -69,6 +80,8 @@ function statusLogger(logger) {
|
|
|
69
80
|
"path",
|
|
70
81
|
"query",
|
|
71
82
|
]);
|
|
83
|
+
cleanReq.originalUrl = (0, logger_1.redactOriginalURL)(req.originalUrl);
|
|
84
|
+
cleanReq.query = redactQuery(req.query);
|
|
72
85
|
const cleanRes = lodash_1.default.pick(res, [
|
|
73
86
|
"bodyCopy",
|
|
74
87
|
"responseTime",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"status-logger.js","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"status-logger.js","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":";;;;;;AAQA,oDAAuB;AAEvB,qCAA6C;AAE7C,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,CAAC;AAEhC,SAAgB,YAAY,CAAC,GAAY,EAAE,GAAa;;IACtD,IAAI,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;QAC7C,OAAO,IAAI,CAAC;KACb;IAED,6CAA6C;IAC7C,MAAM,CAAC,GAAG,CAAC,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,mCAAI,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IACnD,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,IAAI,CAAC;KACb;IAED,MAAM,SAAS,GAAY,gBAAC,CAAC,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAC5D,IAAI,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QACvD,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAlBD,oCAkBC;AAED,SAAgB,eAAe,CAAC,OAAa,EAAE,SAAgB;IAC7D,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;QAClD,OAAO,CAAC,CAAC;KACV;IAED,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;AACjD,CAAC;AAND,0CAMC;AAED,SAAgB,WAAW,CAAC,CAAQ;IAClC,IAAI,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;QACxB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KACrC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAND,kCAMC;AAED,SAAwB,YAAY,CAAC,MAAe;IAClD,OAAO,SAAS,aAAa,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QAC3E,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YAC/B,GAAG,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;SAC7B;QAED,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpB,mCAAmC;QACnC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEnC,kCAAkC;QAClC,GAAG,CAAC,IAAI,GAAG,SAAS,OAAO,CAAC,IAAa;YACvC,IAAI,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpB,IAAI;oBACF,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;iBACjC;gBAAC,OAAO,CAAC,EAAE;oBACV,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;iBACrB;aACF;iBAAM;gBACL,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;aACrB;YACD,OAAO,CAAC,IAAI,CAAC,CAAC;YACd,GAAG,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,IAAI,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;YAC/D,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QAEF,SAAS,UAAU;YACjB,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACzC,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAExC,IAAI,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE;gBACrC,OAAO;aACR;YAED,MAAM,QAAQ,GAAG,gBAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3B,MAAM;gBACN,eAAe;gBACf,SAAS;gBACT,aAAa;gBACb,QAAQ;gBACR,aAAa;gBACb,MAAM;gBACN,OAAO;aACR,CAAC,CAAC;YACH,QAAQ,CAAC,WAAW,GAAG,IAAA,0BAAiB,EAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC1D,QAAQ,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAExC,MAAM,QAAQ,GAAG,gBAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3B,UAAU;gBACV,cAAc;gBACd,YAAY;aACb,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG,EAAE,QAAQ;gBACb,GAAG,EAAE,QAAQ;aACd,CAAC,CAAC;QACL,CAAC;QAED,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC7B,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAE5B,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAjED,+BAiEC"}
|
package/build/winston-logger.js
CHANGED
|
@@ -40,7 +40,10 @@ function logger(config) {
|
|
|
40
40
|
format: winston_1.format.combine(
|
|
41
41
|
// If you pass in a TimestampOptions, it will convert the date from UTC to local TZ
|
|
42
42
|
winston_1.format.timestamp(), winston_1.format.errors({ stack: true }), winston_1.format.splat(), winston_1.format.json()),
|
|
43
|
-
defaultMeta: {
|
|
43
|
+
defaultMeta: {
|
|
44
|
+
...config.extraMeta,
|
|
45
|
+
service: config.name,
|
|
46
|
+
},
|
|
44
47
|
transports: trs,
|
|
45
48
|
exitOnError: false,
|
|
46
49
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"winston-logger.js","sourceRoot":"","sources":["../src/winston-logger.ts"],"names":[],"mappings":";;;;;AAAA,qCAAmE;AAEnE,0FAAwD;AACxD,sEAA+C;
|
|
1
|
+
{"version":3,"file":"winston-logger.js","sourceRoot":"","sources":["../src/winston-logger.ts"],"names":[],"mappings":";;;;;AAAA,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;QACnB,OAAO,IAAI,CAAC;KACb;IAED,MAAM,GAAG,GAAgB,EAAE,CAAC;IAE5B,IAAI,MAAM,CAAC,YAAY,EAAE;QACvB,MAAM,GAAG,GAAc,IAAI,oBAAU,CAAC,OAAO,EAAE,CAAC;QAChD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACf;IAED,IAAI,MAAM,CAAC,SAAS,EAAE;QACpB,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;KACjB;IAED,IAAI,MAAM,CAAC,YAAY,EAAE;QACvB,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;KACd;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;AApDD,yBAoDC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Logger } from "winston";
|
|
2
2
|
import { NextFunction, Request, Response } from "express";
|
|
3
|
+
export declare function redactOriginalURL(maybeURL?: string): string;
|
|
3
4
|
export default function loggerMiddleware(logger?: Logger): (req: Request, res: Response, next: NextFunction) => void;
|
|
4
5
|
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAEjB,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,MAAM,CAAC,EAAE,MAAM,SACb,OAAO,OAAO,QAAQ,QAAQ,YAAY,UA4BpF"}
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAEjB,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAM3D;AAED,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,MAAM,CAAC,EAAE,MAAM,SACb,OAAO,OAAO,QAAQ,QAAQ,YAAY,UA4BpF"}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { Request, Response, NextFunction } from "express";
|
|
2
|
-
|
|
2
|
+
type FilterFunction = (parameter: string) => string;
|
|
3
3
|
export default function metrics(filter?: FilterFunction): {
|
|
4
4
|
defaultFilter: (pathIn: string) => string;
|
|
5
5
|
setStatsDKey: (req: Request, hostname: string, env: string) => void;
|
|
6
6
|
statsd: () => (req: Request, res: Response, next: NextFunction) => void;
|
|
7
7
|
};
|
|
8
8
|
export declare function cleanUpParams(req: Partial<Request>): void;
|
|
9
|
-
export
|
|
9
|
+
export type MetricsModule = ReturnType<typeof metrics>;
|
|
10
10
|
export {};
|
|
11
11
|
//# sourceMappingURL=metrics.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../src/middleware/metrics.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE1D,
|
|
1
|
+
{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../src/middleware/metrics.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE1D,KAAK,cAAc,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;AAMpD,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,MAAM,CAAC,EAAE,cAAc;4BAMtB,MAAM,KAAG,MAAM;wBAmBnB,OAAO,YAAY,MAAM,OAAO,MAAM;wBA4B/B,OAAO,OAAO,QAAQ,QAAQ,YAAY;EAiB7E;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,QAsBlD;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC"}
|
|
@@ -1,5 +1,10 @@
|
|
|
1
|
+
/// <reference types="qs" />
|
|
1
2
|
import { Logger } from "winston";
|
|
2
3
|
import { NextFunction, Request, Response } from "express";
|
|
4
|
+
import { Query } from "express-serve-static-core";
|
|
5
|
+
export declare function shouldIgnore(req: Request, res: Response): boolean;
|
|
6
|
+
export declare function requestDuration(endTime: Date, startTime?: Date): number;
|
|
7
|
+
export declare function redactQuery(q: Query): import("qs").ParsedQs;
|
|
3
8
|
export default function statusLogger(logger?: Logger): (req: Request, res: Response, next: NextFunction) => void;
|
|
4
|
-
export
|
|
9
|
+
export type StatusLoggerModule = ReturnType<typeof statusLogger>;
|
|
5
10
|
//# 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;
|
|
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;AACjB,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAOlD,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,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,yBAMnC;AAED,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,SACf,OAAO,OAAO,QAAQ,QAAQ,YAAY,UAgE9E;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Logger } from "winston";
|
|
2
|
-
export
|
|
2
|
+
export type LoggerConfig = {
|
|
3
3
|
name: string;
|
|
4
4
|
filename: string;
|
|
5
5
|
dirname: string;
|
|
@@ -7,7 +7,8 @@ export declare type LoggerConfig = {
|
|
|
7
7
|
logToFile: boolean;
|
|
8
8
|
logToDatadog: boolean;
|
|
9
9
|
datadogApiKey: string;
|
|
10
|
+
extraMeta?: Record<string, unknown>;
|
|
10
11
|
};
|
|
11
12
|
export default function logger(config: LoggerConfig): Logger | null;
|
|
12
|
-
export
|
|
13
|
+
export type LoggerModule = ReturnType<typeof logger>;
|
|
13
14
|
//# 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,
|
|
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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tabletcommand-logger",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.2.0",
|
|
4
4
|
"description": "Tablet Command Logging Configuration",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "gulp ts",
|
|
@@ -17,10 +17,10 @@
|
|
|
17
17
|
"types": "definitions/index.d.ts",
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"datadog-winston": "^1.6.0",
|
|
20
|
-
"debug": "^4.3.
|
|
20
|
+
"debug": "^4.3.7",
|
|
21
21
|
"express-statsd": "^0.3.0",
|
|
22
22
|
"lodash": "^4.17.21",
|
|
23
|
-
"winston": "^3.
|
|
23
|
+
"winston": "^3.17.0",
|
|
24
24
|
"winston-daily-rotate-file": "^5.0.0"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
@@ -28,22 +28,22 @@
|
|
|
28
28
|
"@types/datadog-winston": "^1.0.7",
|
|
29
29
|
"@types/debug": "4.1.12",
|
|
30
30
|
"@types/express": "^4.17.21",
|
|
31
|
-
"@types/express-serve-static-core": "^4.19.
|
|
31
|
+
"@types/express-serve-static-core": "^4.19.6",
|
|
32
32
|
"@types/gulp-copy": "0.0.7",
|
|
33
33
|
"@types/lodash": "^4.17.0",
|
|
34
|
-
"@types/mocha": "^10.0.
|
|
35
|
-
"@types/node": "^
|
|
34
|
+
"@types/mocha": "^10.0.10",
|
|
35
|
+
"@types/node": "^22.10.1",
|
|
36
36
|
"@typescript-eslint/eslint-plugin": "^6.20.0",
|
|
37
37
|
"@typescript-eslint/parser": "^6.20.0",
|
|
38
|
-
"chai": "^4.
|
|
38
|
+
"chai": "^4.5.0",
|
|
39
39
|
"del": "^6.1.1",
|
|
40
|
-
"eslint": "^8.
|
|
40
|
+
"eslint": "^8.57.1",
|
|
41
41
|
"eslint-config-standard": "^17.1.0",
|
|
42
|
-
"eslint-plugin-import": "^2.
|
|
42
|
+
"eslint-plugin-import": "^2.31.0",
|
|
43
43
|
"eslint-plugin-mocha-only": "0.0.3",
|
|
44
44
|
"eslint-plugin-node": "^11.1.0",
|
|
45
|
-
"eslint-plugin-promise": "^6.
|
|
46
|
-
"eslint-plugin-security": "^2.1.
|
|
45
|
+
"eslint-plugin-promise": "^6.6.0",
|
|
46
|
+
"eslint-plugin-security": "^2.1.1",
|
|
47
47
|
"eslint-plugin-standard": "^4.1.0",
|
|
48
48
|
"gulp": "^4.0.2",
|
|
49
49
|
"gulp-cli": "^2.3.0",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"gulp-eslint": "^6.0.0",
|
|
52
52
|
"gulp-mocha": "^8.0.0",
|
|
53
53
|
"gulp-shell": "^0.8.0",
|
|
54
|
-
"mocha": "^10.
|
|
55
|
-
"typescript": "~4.
|
|
54
|
+
"mocha": "^10.8.2",
|
|
55
|
+
"typescript": "~4.9.5"
|
|
56
56
|
}
|
|
57
57
|
}
|
package/src/middleware/logger.ts
CHANGED
|
@@ -5,6 +5,14 @@ import {
|
|
|
5
5
|
Response,
|
|
6
6
|
} from "express";
|
|
7
7
|
|
|
8
|
+
export function redactOriginalURL(maybeURL?: string): string {
|
|
9
|
+
if (!maybeURL) {
|
|
10
|
+
return "";
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
return maybeURL.replace(/apikey=.*?(&|$)/, "apikey=xxx&");
|
|
14
|
+
}
|
|
15
|
+
|
|
8
16
|
export default function loggerMiddleware(logger?: Logger) {
|
|
9
17
|
return function accessLogMiddleware(req: Request, res: Response, next: NextFunction) {
|
|
10
18
|
// This doesn't fire the log immediately, but waits until the response is finished
|
|
@@ -17,7 +25,7 @@ export default function loggerMiddleware(logger?: Logger) {
|
|
|
17
25
|
logger.info({
|
|
18
26
|
remoteAddress: req.ip,
|
|
19
27
|
method: req.method,
|
|
20
|
-
url: req.originalUrl,
|
|
28
|
+
url: redactOriginalURL(req.originalUrl),
|
|
21
29
|
protocol: req.protocol,
|
|
22
30
|
hostname: req.hostname,
|
|
23
31
|
httpVersion: `${req.httpVersionMajor}.${req.httpVersionMinor}`,
|
|
@@ -5,11 +5,14 @@ import {
|
|
|
5
5
|
Request,
|
|
6
6
|
Response,
|
|
7
7
|
} from "express";
|
|
8
|
+
import { Query } from "express-serve-static-core";
|
|
8
9
|
import _ from "lodash";
|
|
9
10
|
|
|
11
|
+
import { redactOriginalURL } from "./logger";
|
|
12
|
+
|
|
10
13
|
const allowedMethods = ["POST"];
|
|
11
14
|
|
|
12
|
-
function shouldIgnore(req: Request, res: Response): boolean {
|
|
15
|
+
export function shouldIgnore(req: Request, res: Response): boolean {
|
|
13
16
|
if (_.isObject(res) && res.statusCode === 304) {
|
|
14
17
|
return true;
|
|
15
18
|
}
|
|
@@ -29,7 +32,7 @@ function shouldIgnore(req: Request, res: Response): boolean {
|
|
|
29
32
|
return false;
|
|
30
33
|
}
|
|
31
34
|
|
|
32
|
-
function requestDuration(endTime: Date, startTime?: Date): number {
|
|
35
|
+
export function requestDuration(endTime: Date, startTime?: Date): number {
|
|
33
36
|
if (!_.isObject(startTime) || !_.isDate(startTime)) {
|
|
34
37
|
return 0;
|
|
35
38
|
}
|
|
@@ -37,6 +40,14 @@ function requestDuration(endTime: Date, startTime?: Date): number {
|
|
|
37
40
|
return endTime.valueOf() - startTime.valueOf();
|
|
38
41
|
}
|
|
39
42
|
|
|
43
|
+
export function redactQuery(q: Query) {
|
|
44
|
+
if (_.isString(q.apikey)) {
|
|
45
|
+
q.apikey = q.apikey.substring(0, 7);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
return q;
|
|
49
|
+
}
|
|
50
|
+
|
|
40
51
|
export default function statusLogger(logger?: Logger) {
|
|
41
52
|
return function requestLogger(req: Request, res: Response, next: NextFunction) {
|
|
42
53
|
if (!_.isObject(req._startTime)) {
|
|
@@ -82,6 +93,8 @@ export default function statusLogger(logger?: Logger) {
|
|
|
82
93
|
"path",
|
|
83
94
|
"query",
|
|
84
95
|
]);
|
|
96
|
+
cleanReq.originalUrl = redactOriginalURL(req.originalUrl);
|
|
97
|
+
cleanReq.query = redactQuery(req.query);
|
|
85
98
|
|
|
86
99
|
const cleanRes = _.pick(res, [
|
|
87
100
|
"bodyCopy",
|
package/src/winston-logger.ts
CHANGED
|
@@ -12,6 +12,7 @@ export type LoggerConfig = {
|
|
|
12
12
|
|
|
13
13
|
logToDatadog: boolean,
|
|
14
14
|
datadogApiKey: string,
|
|
15
|
+
extraMeta?: Record<string, unknown>,
|
|
15
16
|
};
|
|
16
17
|
|
|
17
18
|
export default function logger(config: LoggerConfig): Logger | null {
|
|
@@ -57,7 +58,10 @@ export default function logger(config: LoggerConfig): Logger | null {
|
|
|
57
58
|
format.splat(),
|
|
58
59
|
format.json()
|
|
59
60
|
),
|
|
60
|
-
defaultMeta: {
|
|
61
|
+
defaultMeta: {
|
|
62
|
+
...config.extraMeta,
|
|
63
|
+
service: config.name,
|
|
64
|
+
},
|
|
61
65
|
transports: trs,
|
|
62
66
|
exitOnError: false,
|
|
63
67
|
});
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"bunyan-logger.d.ts","sourceRoot":"","sources":["../src/bunyan-logger.ts"],"names":[],"mappings":"AAAA,OAAO,MAAkB,MAAM,QAAQ,CAAC;AAExC,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAmCvH;AAED,oBAAY,YAAY,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/middleware/types.ts"],"names":[],"mappings":""}
|