tabletcommand-logger 2.2.0 → 2.3.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 +5 -1
- package/build/middleware/logger.js.map +1 -1
- package/build/middleware/metrics.js +19 -4
- package/build/middleware/metrics.js.map +1 -1
- package/build/middleware/status-logger.js +1 -1
- package/build/middleware/status-logger.js.map +1 -1
- package/build/test/middleware-metrics.js +14 -1
- package/build/test/middleware-metrics.js.map +1 -1
- package/cspell.json +3 -2
- package/definitions/middleware/logger.d.ts +1 -1
- package/definitions/middleware/logger.d.ts.map +1 -1
- package/definitions/middleware/metrics.d.ts +1 -0
- package/definitions/middleware/metrics.d.ts.map +1 -1
- package/definitions/middleware/status-logger.d.ts +1 -1
- package/definitions/middleware/status-logger.d.ts.map +1 -1
- package/package.json +14 -13
- package/src/middleware/logger.ts +6 -2
- package/src/middleware/metrics.ts +21 -4
- package/src/middleware/status-logger.ts +2 -2
- package/src/test/middleware-metrics.ts +15 -1
|
@@ -5,6 +5,10 @@ function loggerMiddleware(logger) {
|
|
|
5
5
|
// This doesn't fire the log immediately, but waits until the response is finished
|
|
6
6
|
// This means we have a chance of logging the response code
|
|
7
7
|
res.on("finish", () => {
|
|
8
|
+
// Skip this if no logger is set
|
|
9
|
+
if (!logger) {
|
|
10
|
+
return;
|
|
11
|
+
}
|
|
8
12
|
logger.info({
|
|
9
13
|
remoteAddress: req.ip,
|
|
10
14
|
method: req.method,
|
|
@@ -23,7 +27,7 @@ function loggerMiddleware(logger) {
|
|
|
23
27
|
status: res.statusCode ? res.statusCode : 0
|
|
24
28
|
}, "access_log");
|
|
25
29
|
});
|
|
26
|
-
next();
|
|
30
|
+
return next();
|
|
27
31
|
};
|
|
28
32
|
}
|
|
29
33
|
exports.default = loggerMiddleware;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":";;AAOA,SAAwB,gBAAgB,CAAC,
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":";;AAOA,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,GAAG,CAAC,WAAW;gBACpB,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,EAAE,YAAY,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AA7BD,mCA6BC"}
|
|
@@ -34,10 +34,7 @@ function metrics(filter) {
|
|
|
34
34
|
function setStatsDKey(req, hostname, env) {
|
|
35
35
|
let method = req.method || "unknown_method";
|
|
36
36
|
method = method.toLowerCase();
|
|
37
|
-
const
|
|
38
|
-
const urlItem = new url_1.URL(req.url, defaultBase);
|
|
39
|
-
let path = urlItem.pathname.toLowerCase();
|
|
40
|
-
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
37
|
+
const path = cleanUpParams(req);
|
|
41
38
|
let filterFunc = defaultFilter;
|
|
42
39
|
if (lodash_1.default.isFunction(filter)) {
|
|
43
40
|
filterFunc = filter;
|
|
@@ -61,10 +58,28 @@ function metrics(filter) {
|
|
|
61
58
|
return next();
|
|
62
59
|
};
|
|
63
60
|
}
|
|
61
|
+
function cleanUpParams(req) {
|
|
62
|
+
var _a, _b;
|
|
63
|
+
const defaultBase = "http://localhost";
|
|
64
|
+
const urlItem = new url_1.URL((_a = req.url) !== null && _a !== void 0 ? _a : "/", defaultBase);
|
|
65
|
+
let path = urlItem.pathname.toLowerCase();
|
|
66
|
+
// Attempt to replace :params values with their keys
|
|
67
|
+
if (lodash_1.default.isObject(req.params)) {
|
|
68
|
+
lodash_1.default.forEach((_b = req.params) !== null && _b !== void 0 ? _b : {}, (value, key) => {
|
|
69
|
+
const foundIndex = path.lastIndexOf(value);
|
|
70
|
+
if (foundIndex >= 0) {
|
|
71
|
+
path = path.substring(0, foundIndex) + key + path.substring(foundIndex + value.length);
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
76
|
+
return path;
|
|
77
|
+
}
|
|
64
78
|
return {
|
|
65
79
|
defaultFilter,
|
|
66
80
|
setStatsDKey,
|
|
67
81
|
statsd,
|
|
82
|
+
cleanUpParams,
|
|
68
83
|
};
|
|
69
84
|
}
|
|
70
85
|
exports.default = metrics;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/middleware/metrics.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,6BAA0B;AAE1B,oDAAuB;AACvB,kDAAiC;AACjC,oEAA2C;AAK3C,MAAM,cAAc,GAAG,IAAA,wBAAa,GAAE,CAAC;AAEvC,8GAA8G;AAC9G,6CAA6C;AAC7C,SAAwB,OAAO,CAAC,MAAuB;IACrD,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,yCAAyC,CAAC,CAAC;IAEtE,SAAS,aAAa,CAAC,MAAc;QACnC,MAAM,SAAS,GAAG,eAAe,CAAC;QAClC,MAAM,YAAY,GAAG,cAAc,CAAC;QACpC,IAAI,IAAI,GAAG,MAAM,CAAC;QAClB,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACnD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAS,IAAI;gBAC3C,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpC,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1C,OAAO,CAAC,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YACH,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC7B;QACD,IAAI,IAAI,KAAK,MAAM,EAAE;YACnB,KAAK,CAAC,oBAAoB,IAAI,GAAG,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,YAAY,CAAC,GAAY,EAAE,QAAgB,EAAE,GAAW;QAC/D,IAAI,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,gBAAgB,CAAC;QAC5C,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QAC9B,MAAM,
|
|
1
|
+
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/middleware/metrics.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,6BAA0B;AAE1B,oDAAuB;AACvB,kDAAiC;AACjC,oEAA2C;AAK3C,MAAM,cAAc,GAAG,IAAA,wBAAa,GAAE,CAAC;AAEvC,8GAA8G;AAC9G,6CAA6C;AAC7C,SAAwB,OAAO,CAAC,MAAuB;IACrD,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,yCAAyC,CAAC,CAAC;IAEtE,SAAS,aAAa,CAAC,MAAc;QACnC,MAAM,SAAS,GAAG,eAAe,CAAC;QAClC,MAAM,YAAY,GAAG,cAAc,CAAC;QACpC,IAAI,IAAI,GAAG,MAAM,CAAC;QAClB,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACnD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAS,IAAI;gBAC3C,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpC,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1C,OAAO,CAAC,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YACH,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC7B;QACD,IAAI,IAAI,KAAK,MAAM,EAAE;YACnB,KAAK,CAAC,oBAAoB,IAAI,GAAG,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,YAAY,CAAC,GAAY,EAAE,QAAgB,EAAE,GAAW;QAC/D,IAAI,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,gBAAgB,CAAC;QAC5C,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,UAAU,GAAG,aAAa,CAAC;QAC/B,IAAI,gBAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YACxB,UAAU,GAAG,MAAM,CAAC;SACrB;QACD,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,GAAG,CAAC,SAAS,GAAG;YACd,QAAQ;YACR,GAAG;YACH,MAAM;YACN,MAAM;YACN,YAAY;SACb,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACZ,KAAK,CAAC,kBAAkB,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,SAAS,MAAM;QACb,OAAO,SAAS,UAAU,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;YACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,YAAE,CAAC,QAAQ,EAAE,CAAC;YACjE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,YAAY,CAAC;YACjD,YAAY,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;YACjC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACzB,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;IAED,SAAS,aAAa,CAAC,GAAqB;;QAC1C,MAAM,WAAW,GAAG,kBAAkB,CAAC;QACvC,MAAM,OAAO,GAAG,IAAI,SAAG,CAAC,MAAA,GAAG,CAAC,GAAG,mCAAI,GAAG,EAAE,WAAW,CAAC,CAAC;QACrD,IAAI,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAE1C,oDAAoD;QACpD,IAAI,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC1B,gBAAC,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,MAAM,mCAAI,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACzC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBAC3C,IAAI,UAAU,IAAI,CAAC,EAAE;oBACnB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;iBACxF;YACH,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,aAAa;QACb,YAAY;QACZ,MAAM;QACN,aAAa;KACd,CAAC;AACJ,CAAC;AA5ED,0BA4EC"}
|
|
@@ -48,7 +48,7 @@ function statusLogger(logger) {
|
|
|
48
48
|
function logRequest() {
|
|
49
49
|
res.removeListener("finish", logRequest);
|
|
50
50
|
res.removeListener("close", logRequest);
|
|
51
|
-
if (shouldIgnore(req, res)) {
|
|
51
|
+
if (shouldIgnore(req, res) || !logger) {
|
|
52
52
|
return;
|
|
53
53
|
}
|
|
54
54
|
const cleanReq = lodash_1.default.pick(req, [
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"status-logger.js","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":";;;;;AAMA,oDAAuB;AAEvB,SAAS,YAAY,CAAC,GAAY,EAAE,GAAa;IAC/C,IAAI,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;QAC7C,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;AAED,SAAS,eAAe,CAAC,OAAa,EAAE,SAAgB;IACtD,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;AAED,SAAwB,YAAY,CAAC,
|
|
1
|
+
{"version":3,"file":"status-logger.js","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":";;;;;AAMA,oDAAuB;AAEvB,SAAS,YAAY,CAAC,GAAY,EAAE,GAAa;IAC/C,IAAI,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;QAC7C,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;AAED,SAAS,eAAe,CAAC,OAAa,EAAE,SAAgB;IACtD,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;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,IAAsB;YAChD,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;YAEH,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;AA/DD,+BA+DC"}
|
|
@@ -31,7 +31,7 @@ describe("Metrics Middleware", function () {
|
|
|
31
31
|
});
|
|
32
32
|
context("setStatsDKey", () => {
|
|
33
33
|
it("Parses URL without a set base hostname", () => {
|
|
34
|
-
const sampleUrl = "/api/v2/cad-vehicle-status?apikey=
|
|
34
|
+
const sampleUrl = "/api/v2/cad-vehicle-status?apikey=some123key";
|
|
35
35
|
const req = {
|
|
36
36
|
method: "POST",
|
|
37
37
|
url: sampleUrl,
|
|
@@ -43,5 +43,18 @@ describe("Metrics Middleware", function () {
|
|
|
43
43
|
chai_1.assert.equal(req.statsdKey, expectedStatsdKey);
|
|
44
44
|
});
|
|
45
45
|
});
|
|
46
|
+
context("cleanUpParams", () => {
|
|
47
|
+
it("cleans up params", () => {
|
|
48
|
+
const req = {
|
|
49
|
+
url: "/api/a1/admin/department/abcd",
|
|
50
|
+
params: {
|
|
51
|
+
departmentId: "abcd",
|
|
52
|
+
x123: "admin",
|
|
53
|
+
}
|
|
54
|
+
};
|
|
55
|
+
const path = metrics.cleanUpParams(req);
|
|
56
|
+
chai_1.assert.strictEqual(path, "api.a1.x123.department.departmentId");
|
|
57
|
+
});
|
|
58
|
+
});
|
|
46
59
|
});
|
|
47
60
|
//# sourceMappingURL=middleware-metrics.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"middleware-metrics.js","sourceRoot":"","sources":["../../src/test/middleware-metrics.ts"],"names":[],"mappings":";;;;;AAAA,+BAA8B;AAE9B,oEAAkD;AAClD,MAAM,OAAO,GAAG,IAAA,iBAAa,GAAE,CAAC;AAEhC,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,OAAO,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,gCAAgC,EAAE;YACnC,MAAM,IAAI,GAAG,+CAA+C,CAAC;YAC7D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE;YACtC,MAAM,IAAI,GAAG,oDAAoD,CAAC;YAClE,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE;YAC1C,MAAM,IAAI,GAAG,4CAA4C,CAAC;YAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE;YAC7B,MAAM,IAAI,GAAG,kBAAkB,CAAC;YAChC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,SAAS,GAAG,
|
|
1
|
+
{"version":3,"file":"middleware-metrics.js","sourceRoot":"","sources":["../../src/test/middleware-metrics.ts"],"names":[],"mappings":";;;;;AAAA,+BAA8B;AAE9B,oEAAkD;AAClD,MAAM,OAAO,GAAG,IAAA,iBAAa,GAAE,CAAC;AAEhC,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,OAAO,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,gCAAgC,EAAE;YACnC,MAAM,IAAI,GAAG,+CAA+C,CAAC;YAC7D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE;YACtC,MAAM,IAAI,GAAG,oDAAoD,CAAC;YAClE,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE;YAC1C,MAAM,IAAI,GAAG,4CAA4C,CAAC;YAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE;YAC7B,MAAM,IAAI,GAAG,kBAAkB,CAAC;YAChC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,SAAS,GAAG,8CAA8C,CAAC;YACjE,MAAM,GAAG,GAAqB;gBAC5B,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,SAAS;aACf,CAAC;YACF,MAAM,QAAQ,GAAG,GAAG,CAAC;YACrB,MAAM,GAAG,GAAG,GAAG,CAAC;YAChB,OAAO,CAAC,YAAY,CAAC,GAAc,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;YACpD,MAAM,iBAAiB,GAAG,yCAAyC,CAAC;YACpE,aAAM,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,eAAe,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAC1B,MAAM,GAAG,GAAqB;gBAC5B,GAAG,EAAE,+BAA+B;gBACpC,MAAM,EAAE;oBACN,YAAY,EAAE,MAAM;oBACpB,IAAI,EAAE,OAAO;iBACd;aACF,CAAC;YACF,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACxC,aAAM,CAAC,WAAW,CAAC,IAAI,EAAE,qCAAqC,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/cspell.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// cSpell Settings
|
|
2
2
|
{
|
|
3
3
|
// Version of the setting file. Always 0.1
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.2",
|
|
5
5
|
// language - current active spelling language
|
|
6
6
|
"language": "en-US",
|
|
7
7
|
// words - list of words to be always considered correct
|
|
@@ -9,7 +9,8 @@
|
|
|
9
9
|
"tabletcommand",
|
|
10
10
|
"backend",
|
|
11
11
|
"Ursache",
|
|
12
|
-
"bamse"
|
|
12
|
+
"bamse",
|
|
13
|
+
"apikey"
|
|
13
14
|
],
|
|
14
15
|
// flagWords - list of words to be always considered incorrect
|
|
15
16
|
// This is useful for offensive words and common spelling errors.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import bunyan from "bunyan";
|
|
2
2
|
import { NextFunction, Request, Response } from "express";
|
|
3
|
-
export default function loggerMiddleware(logger
|
|
3
|
+
export default function loggerMiddleware(logger?: bunyan): (req: Request, res: Response, next: NextFunction) => void;
|
|
4
4
|
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAEjB,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,MAAM,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,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"}
|
|
@@ -4,6 +4,7 @@ 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
|
+
cleanUpParams: (req: Partial<Request>) => string;
|
|
7
8
|
};
|
|
8
9
|
export declare type MetricsModule = ReturnType<typeof metrics>;
|
|
9
10
|
export {};
|
|
@@ -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,aAAK,cAAc,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;AAMpD,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,MAAM,CAAC,EAAE,cAAc;4BAGtB,MAAM,KAAG,MAAM;wBAmBnB,OAAO,YAAY,MAAM,OAAO,MAAM;
|
|
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,aAAK,cAAc,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;AAMpD,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,MAAM,CAAC,EAAE,cAAc;4BAGtB,MAAM,KAAG,MAAM;wBAmBnB,OAAO,YAAY,MAAM,OAAO,MAAM;wBAoB/B,OAAO,OAAO,QAAQ,QAAQ,YAAY;yBAShD,QAAQ,OAAO,CAAC,KAAG,MAAM;EAyBtD;AAED,oBAAY,aAAa,GAAG,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import bunyan from "bunyan";
|
|
2
2
|
import { NextFunction, Request, Response } from "express";
|
|
3
|
-
export default function statusLogger(logger
|
|
3
|
+
export default function statusLogger(logger?: bunyan): (req: Request, res: Response, next: NextFunction) => void;
|
|
4
4
|
export declare type StatusLoggerModule = ReturnType<typeof statusLogger>;
|
|
5
5
|
//# 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,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAwBjB,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,MAAM,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"status-logger.d.ts","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAwBjB,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,SACf,OAAO,OAAO,QAAQ,QAAQ,YAAY,UA8D9E;AAED,oBAAY,kBAAkB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tabletcommand-logger",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.3.0",
|
|
4
4
|
"description": "Tablet Command Logging Configuration",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "gulp ts",
|
|
@@ -23,24 +23,24 @@
|
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"@types/bunyan": "^1.8.8",
|
|
26
|
-
"@types/chai": "^4.3.
|
|
26
|
+
"@types/chai": "^4.3.4",
|
|
27
27
|
"@types/debug": "4.1.7",
|
|
28
|
-
"@types/express": "^4.17.
|
|
29
|
-
"@types/express-serve-static-core": "^4.17.
|
|
28
|
+
"@types/express": "^4.17.15",
|
|
29
|
+
"@types/express-serve-static-core": "^4.17.31",
|
|
30
30
|
"@types/gulp-copy": "0.0.4",
|
|
31
|
-
"@types/lodash": "^4.14.
|
|
32
|
-
"@types/mocha": "^
|
|
33
|
-
"@types/node": "^18.
|
|
34
|
-
"@typescript-eslint/eslint-plugin": "^5.
|
|
35
|
-
"@typescript-eslint/parser": "^5.
|
|
36
|
-
"chai": "^4.3.
|
|
31
|
+
"@types/lodash": "^4.14.191",
|
|
32
|
+
"@types/mocha": "^10.0.1",
|
|
33
|
+
"@types/node": "^18.11.18",
|
|
34
|
+
"@typescript-eslint/eslint-plugin": "^5.47.1",
|
|
35
|
+
"@typescript-eslint/parser": "^5.47.1",
|
|
36
|
+
"chai": "^4.3.7",
|
|
37
37
|
"del": "^6.1.1",
|
|
38
|
-
"eslint": "^8.
|
|
38
|
+
"eslint": "^8.30.0",
|
|
39
39
|
"eslint-config-standard": "^17.0.0",
|
|
40
40
|
"eslint-plugin-import": "^2.26.0",
|
|
41
41
|
"eslint-plugin-mocha-only": "0.0.3",
|
|
42
42
|
"eslint-plugin-node": "^11.1.0",
|
|
43
|
-
"eslint-plugin-promise": "^6.
|
|
43
|
+
"eslint-plugin-promise": "^6.1.1",
|
|
44
44
|
"eslint-plugin-security": "^1.5.0",
|
|
45
45
|
"eslint-plugin-standard": "^4.1.0",
|
|
46
46
|
"gulp": "^4.0.2",
|
|
@@ -49,6 +49,7 @@
|
|
|
49
49
|
"gulp-eslint": "^6.0.0",
|
|
50
50
|
"gulp-mocha": "^8.0.0",
|
|
51
51
|
"gulp-shell": "^0.8.0",
|
|
52
|
-
"mocha": "^10.
|
|
52
|
+
"mocha": "^10.2.0",
|
|
53
|
+
"typescript": "~4.7.4"
|
|
53
54
|
}
|
|
54
55
|
}
|
package/src/middleware/logger.ts
CHANGED
|
@@ -5,11 +5,15 @@ import {
|
|
|
5
5
|
Response,
|
|
6
6
|
} from "express";
|
|
7
7
|
|
|
8
|
-
export default function loggerMiddleware(logger
|
|
8
|
+
export default function loggerMiddleware(logger?: bunyan) {
|
|
9
9
|
return function accessLogMiddleware(req: Request, res: Response, next: NextFunction) {
|
|
10
10
|
// This doesn't fire the log immediately, but waits until the response is finished
|
|
11
11
|
// This means we have a chance of logging the response code
|
|
12
12
|
res.on("finish", () => {
|
|
13
|
+
// Skip this if no logger is set
|
|
14
|
+
if (!logger) {
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
13
17
|
logger.info({
|
|
14
18
|
remoteAddress: req.ip,
|
|
15
19
|
method: req.method,
|
|
@@ -28,6 +32,6 @@ export default function loggerMiddleware(logger: bunyan) {
|
|
|
28
32
|
status: res.statusCode ? res.statusCode : 0
|
|
29
33
|
}, "access_log");
|
|
30
34
|
});
|
|
31
|
-
next();
|
|
35
|
+
return next();
|
|
32
36
|
};
|
|
33
37
|
}
|
|
@@ -37,10 +37,7 @@ export default function metrics(filter?: FilterFunction) {
|
|
|
37
37
|
function setStatsDKey(req: Request, hostname: string, env: string) {
|
|
38
38
|
let method = req.method || "unknown_method";
|
|
39
39
|
method = method.toLowerCase();
|
|
40
|
-
const
|
|
41
|
-
const urlItem = new URL(req.url, defaultBase);
|
|
42
|
-
let path = urlItem.pathname.toLowerCase();
|
|
43
|
-
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
40
|
+
const path = cleanUpParams(req);
|
|
44
41
|
let filterFunc = defaultFilter;
|
|
45
42
|
if (_.isFunction(filter)) {
|
|
46
43
|
filterFunc = filter;
|
|
@@ -66,10 +63,30 @@ export default function metrics(filter?: FilterFunction) {
|
|
|
66
63
|
};
|
|
67
64
|
}
|
|
68
65
|
|
|
66
|
+
function cleanUpParams(req: Partial<Request>): string {
|
|
67
|
+
const defaultBase = "http://localhost";
|
|
68
|
+
const urlItem = new URL(req.url ?? "/", defaultBase);
|
|
69
|
+
let path = urlItem.pathname.toLowerCase();
|
|
70
|
+
|
|
71
|
+
// Attempt to replace :params values with their keys
|
|
72
|
+
if (_.isObject(req.params)) {
|
|
73
|
+
_.forEach(req.params ?? {}, (value, key) => {
|
|
74
|
+
const foundIndex = path.lastIndexOf(value);
|
|
75
|
+
if (foundIndex >= 0) {
|
|
76
|
+
path = path.substring(0, foundIndex) + key + path.substring(foundIndex + value.length);
|
|
77
|
+
}
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
82
|
+
return path;
|
|
83
|
+
}
|
|
84
|
+
|
|
69
85
|
return {
|
|
70
86
|
defaultFilter,
|
|
71
87
|
setStatsDKey,
|
|
72
88
|
statsd,
|
|
89
|
+
cleanUpParams,
|
|
73
90
|
};
|
|
74
91
|
}
|
|
75
92
|
|
|
@@ -27,7 +27,7 @@ function requestDuration(endTime: Date, startTime?: Date): number {
|
|
|
27
27
|
return endTime.valueOf() - startTime.valueOf();
|
|
28
28
|
}
|
|
29
29
|
|
|
30
|
-
export default function statusLogger(logger
|
|
30
|
+
export default function statusLogger(logger?: bunyan) {
|
|
31
31
|
return function requestLogger(req: Request, res: Response, next: NextFunction) {
|
|
32
32
|
if (!_.isObject(req._startTime)) {
|
|
33
33
|
req._startTime = new Date();
|
|
@@ -58,7 +58,7 @@ export default function statusLogger(logger: bunyan) {
|
|
|
58
58
|
res.removeListener("finish", logRequest);
|
|
59
59
|
res.removeListener("close", logRequest);
|
|
60
60
|
|
|
61
|
-
if (shouldIgnore(req, res)) {
|
|
61
|
+
if (shouldIgnore(req, res) || !logger) {
|
|
62
62
|
return;
|
|
63
63
|
}
|
|
64
64
|
|
|
@@ -32,7 +32,7 @@ describe("Metrics Middleware", function() {
|
|
|
32
32
|
|
|
33
33
|
context("setStatsDKey", () => {
|
|
34
34
|
it("Parses URL without a set base hostname", () => {
|
|
35
|
-
const sampleUrl = "/api/v2/cad-vehicle-status?apikey=
|
|
35
|
+
const sampleUrl = "/api/v2/cad-vehicle-status?apikey=some123key";
|
|
36
36
|
const req: Partial<Request> = {
|
|
37
37
|
method: "POST",
|
|
38
38
|
url: sampleUrl,
|
|
@@ -44,4 +44,18 @@ describe("Metrics Middleware", function() {
|
|
|
44
44
|
assert.equal(req.statsdKey, expectedStatsdKey);
|
|
45
45
|
});
|
|
46
46
|
});
|
|
47
|
+
|
|
48
|
+
context("cleanUpParams", () => {
|
|
49
|
+
it("cleans up params", () => {
|
|
50
|
+
const req: Partial<Request> = {
|
|
51
|
+
url: "/api/a1/admin/department/abcd",
|
|
52
|
+
params: {
|
|
53
|
+
departmentId: "abcd",
|
|
54
|
+
x123: "admin",
|
|
55
|
+
}
|
|
56
|
+
};
|
|
57
|
+
const path = metrics.cleanUpParams(req);
|
|
58
|
+
assert.strictEqual(path, "api.a1.x123.department.departmentId");
|
|
59
|
+
});
|
|
60
|
+
});
|
|
47
61
|
});
|