tabletcommand-logger 2.3.3 → 2.4.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/metrics.js +13 -0
- package/build/middleware/metrics.js.map +1 -1
- package/build/middleware/status-logger.js.map +1 -1
- package/build/test/middleware-metrics.js +11 -0
- package/build/test/middleware-metrics.js.map +1 -1
- package/definitions/middleware/metrics.d.ts.map +1 -1
- package/package.json +17 -17
- package/src/middleware/metrics.ts +14 -0
- package/src/middleware/status-logger.ts +1 -1
- package/src/test/middleware-metrics.ts +12 -0
|
@@ -14,6 +14,9 @@ const monitorRequest = (0, express_statsd_1.default)();
|
|
|
14
14
|
// See https://github.com/uber/express-statsd
|
|
15
15
|
function metrics(filter) {
|
|
16
16
|
const debug = (0, debug_1.default)("tabletcommand-logger:middleware/metrics");
|
|
17
|
+
const allowedMethods = [
|
|
18
|
+
"GET", "POST",
|
|
19
|
+
];
|
|
17
20
|
function defaultFilter(pathIn) {
|
|
18
21
|
const uuidRegex = /[-a-f\d]{36}/i;
|
|
19
22
|
const mongoIdRegex = /[a-f\d]{24}/i;
|
|
@@ -53,8 +56,15 @@ function metrics(filter) {
|
|
|
53
56
|
].join(".");
|
|
54
57
|
debug(`req.statsdKey: ${req.statsdKey}`);
|
|
55
58
|
}
|
|
59
|
+
function shouldProcessRequest(req) {
|
|
60
|
+
const method = (req.method || "unknown_method").toUpperCase();
|
|
61
|
+
return allowedMethods.indexOf(method) >= 0;
|
|
62
|
+
}
|
|
56
63
|
function statsd() {
|
|
57
64
|
return function statsdFunc(req, res, next) {
|
|
65
|
+
if (!shouldProcessRequest(req)) {
|
|
66
|
+
return next();
|
|
67
|
+
}
|
|
58
68
|
const hostname = process.env.NODE_STATSD_PREFIX || os_1.default.hostname();
|
|
59
69
|
const env = process.env.NODE_ENV || "production";
|
|
60
70
|
setStatsDKey(req, hostname, env);
|
|
@@ -78,6 +88,9 @@ function cleanUpParams(req) {
|
|
|
78
88
|
// Attempt to replace :params values with their keys
|
|
79
89
|
if (lodash_1.default.isObject(req.params)) {
|
|
80
90
|
lodash_1.default.forEach((_a = req.params) !== null && _a !== void 0 ? _a : {}, (value, key) => {
|
|
91
|
+
if (!lodash_1.default.isString(value) || !lodash_1.default.isString(key)) {
|
|
92
|
+
return;
|
|
93
|
+
}
|
|
81
94
|
const foundIndex = path.lastIndexOf(value.toLowerCase());
|
|
82
95
|
if (foundIndex >= 0) {
|
|
83
96
|
path = path.substring(0, foundIndex) + key + path.substring(foundIndex + value.toLowerCase().length);
|
|
@@ -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;
|
|
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;IACtE,MAAM,cAAc,GAAG;QACrB,KAAK,EAAE,MAAM;KACd,CAAC;IAEF,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,WAAW,GAAG,kBAAkB,CAAC;QACvC,MAAM,OAAO,GAAG,IAAI,SAAG,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC1C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC3D,IAAI,UAAU,GAAG,aAAa,CAAC;QAC/B,IAAI,gBAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YACxB,UAAU,GAAG,MAAM,CAAC;SACrB;QACD,MAAM,YAAY,GAAW,UAAU,CAAC,IAAI,CAAC,CAAC;QAC9C,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,oBAAoB,CAAC,GAAY;QACxC,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,IAAI,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9D,OAAO,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,SAAS,MAAM;QACb,OAAO,SAAS,UAAU,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;YACxE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE;gBAC9B,OAAO,IAAI,EAAE,CAAC;aACf;YACD,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,OAAO;QACL,aAAa;QACb,YAAY;QACZ,MAAM;KACP,CAAC;AACJ,CAAC;AAtED,0BAsEC;AAED,SAAgB,aAAa,CAAC,GAAqB;;IACjD,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;QAC9B,OAAO;KACR;IAED,IAAI,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;IAEvC,oDAAoD;IACpD,IAAI,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QAC1B,gBAAC,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,MAAM,mCAAI,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACzC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC1C,OAAO;aACR;YACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACzD,IAAI,UAAU,IAAI,CAAC,EAAE;gBACnB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC;aACtG;QACH,CAAC,CAAC,CAAC;KACJ;IAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;AACrC,CAAC;AAtBD,sCAsBC"}
|
|
@@ -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,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,
|
|
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,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;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"}
|
|
@@ -57,5 +57,16 @@ describe("cleanUpParams", () => {
|
|
|
57
57
|
(0, metrics_2.cleanUpParams)(req);
|
|
58
58
|
chai_1.assert.strictEqual(req.statsdKey, "api.a1.x123.department.departmentid"); // cspell: words departmentid
|
|
59
59
|
});
|
|
60
|
+
it("cleans up params when values are undefined", () => {
|
|
61
|
+
const req = {
|
|
62
|
+
statsdKey: "api.a1.admin.department",
|
|
63
|
+
params: {
|
|
64
|
+
departmentId: undefined,
|
|
65
|
+
x123: "admin",
|
|
66
|
+
}
|
|
67
|
+
};
|
|
68
|
+
(0, metrics_2.cleanUpParams)(req);
|
|
69
|
+
chai_1.assert.strictEqual(req.statsdKey, "api.a1.x123.department");
|
|
70
|
+
});
|
|
60
71
|
});
|
|
61
72
|
//# 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,mDAAsD;AACtD,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;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,GAAG,GAAqB;YAC5B,SAAS,EAAE,8BAA8B;YACzC,MAAM,EAAE;gBACN,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,OAAO;aACd;SACF,CAAC;QACF,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACnB,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,qCAAqC,CAAC,CAAC,CAAC,6BAA6B;IACzG,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"middleware-metrics.js","sourceRoot":"","sources":["../../src/test/middleware-metrics.ts"],"names":[],"mappings":";;;;;AAAA,+BAA8B;AAE9B,oEAAkD;AAClD,mDAAsD;AACtD,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;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,GAAG,GAAqB;YAC5B,SAAS,EAAE,8BAA8B;YACzC,MAAM,EAAE;gBACN,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,OAAO;aACd;SACF,CAAC;QACF,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACnB,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,qCAAqC,CAAC,CAAC,CAAC,6BAA6B;IACzG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,GAAG,GAAqB;YAC5B,SAAS,EAAE,yBAAyB;YACpC,MAAM,EAAE;gBACN,YAAY,EAAE,SAAkB;gBAChC,IAAI,EAAE,OAAO;aACd;SACF,CAAC;QACF,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACnB,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -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;
|
|
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;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,oBAAY,aAAa,GAAG,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tabletcommand-logger",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.4.0",
|
|
4
4
|
"description": "Tablet Command Logging Configuration",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "gulp ts",
|
|
@@ -22,26 +22,26 @@
|
|
|
22
22
|
"lodash": "^4.17.21"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
|
-
"@types/bunyan": "^1.8.
|
|
26
|
-
"@types/chai": "^4.3.
|
|
27
|
-
"@types/debug": "4.1.
|
|
28
|
-
"@types/express": "^4.17.
|
|
29
|
-
"@types/express-serve-static-core": "^4.17.
|
|
30
|
-
"@types/gulp-copy": "0.0.
|
|
31
|
-
"@types/lodash": "^4.14.
|
|
32
|
-
"@types/mocha": "^10.0.
|
|
33
|
-
"@types/node": "^
|
|
34
|
-
"@typescript-eslint/eslint-plugin": "^
|
|
35
|
-
"@typescript-eslint/parser": "^
|
|
36
|
-
"chai": "^4.3.
|
|
25
|
+
"@types/bunyan": "^1.8.11",
|
|
26
|
+
"@types/chai": "^4.3.11",
|
|
27
|
+
"@types/debug": "4.1.12",
|
|
28
|
+
"@types/express": "^4.17.21",
|
|
29
|
+
"@types/express-serve-static-core": "^4.17.42",
|
|
30
|
+
"@types/gulp-copy": "0.0.7",
|
|
31
|
+
"@types/lodash": "^4.14.202",
|
|
32
|
+
"@types/mocha": "^10.0.6",
|
|
33
|
+
"@types/node": "^20.11.14",
|
|
34
|
+
"@typescript-eslint/eslint-plugin": "^6.20.0",
|
|
35
|
+
"@typescript-eslint/parser": "^6.20.0",
|
|
36
|
+
"chai": "^4.3.10",
|
|
37
37
|
"del": "^6.1.1",
|
|
38
|
-
"eslint": "^8.
|
|
39
|
-
"eslint-config-standard": "^17.
|
|
40
|
-
"eslint-plugin-import": "^2.
|
|
38
|
+
"eslint": "^8.56.0",
|
|
39
|
+
"eslint-config-standard": "^17.1.0",
|
|
40
|
+
"eslint-plugin-import": "^2.29.1",
|
|
41
41
|
"eslint-plugin-mocha-only": "0.0.3",
|
|
42
42
|
"eslint-plugin-node": "^11.1.0",
|
|
43
43
|
"eslint-plugin-promise": "^6.1.1",
|
|
44
|
-
"eslint-plugin-security": "^1.
|
|
44
|
+
"eslint-plugin-security": "^2.1.0",
|
|
45
45
|
"eslint-plugin-standard": "^4.1.0",
|
|
46
46
|
"gulp": "^4.0.2",
|
|
47
47
|
"gulp-cli": "^2.3.0",
|
|
@@ -14,6 +14,9 @@ const monitorRequest = expressStatsd();
|
|
|
14
14
|
// See https://github.com/uber/express-statsd
|
|
15
15
|
export default function metrics(filter?: FilterFunction) {
|
|
16
16
|
const debug = debug_module("tabletcommand-logger:middleware/metrics");
|
|
17
|
+
const allowedMethods = [
|
|
18
|
+
"GET", "POST",
|
|
19
|
+
];
|
|
17
20
|
|
|
18
21
|
function defaultFilter(pathIn: string): string {
|
|
19
22
|
const uuidRegex = /[-a-f\d]{36}/i;
|
|
@@ -56,8 +59,16 @@ export default function metrics(filter?: FilterFunction) {
|
|
|
56
59
|
debug(`req.statsdKey: ${req.statsdKey}`);
|
|
57
60
|
}
|
|
58
61
|
|
|
62
|
+
function shouldProcessRequest(req: Request): boolean {
|
|
63
|
+
const method = (req.method || "unknown_method").toUpperCase();
|
|
64
|
+
return allowedMethods.indexOf(method) >= 0;
|
|
65
|
+
}
|
|
66
|
+
|
|
59
67
|
function statsd() {
|
|
60
68
|
return function statsdFunc(req: Request, res: Response, next: NextFunction) {
|
|
69
|
+
if (!shouldProcessRequest(req)) {
|
|
70
|
+
return next();
|
|
71
|
+
}
|
|
61
72
|
const hostname = process.env.NODE_STATSD_PREFIX || os.hostname();
|
|
62
73
|
const env = process.env.NODE_ENV || "production";
|
|
63
74
|
setStatsDKey(req, hostname, env);
|
|
@@ -83,6 +94,9 @@ export function cleanUpParams(req: Partial<Request>) {
|
|
|
83
94
|
// Attempt to replace :params values with their keys
|
|
84
95
|
if (_.isObject(req.params)) {
|
|
85
96
|
_.forEach(req.params ?? {}, (value, key) => {
|
|
97
|
+
if (!_.isString(value) || !_.isString(key)) {
|
|
98
|
+
return;
|
|
99
|
+
}
|
|
86
100
|
const foundIndex = path.lastIndexOf(value.toLowerCase());
|
|
87
101
|
if (foundIndex >= 0) {
|
|
88
102
|
path = path.substring(0, foundIndex) + key + path.substring(foundIndex + value.toLowerCase().length);
|
|
@@ -39,7 +39,7 @@ export default function statusLogger(logger?: bunyan) {
|
|
|
39
39
|
const oldJSON = res.json.bind(res);
|
|
40
40
|
|
|
41
41
|
// Used when using res.json(body);
|
|
42
|
-
res.json = function newJson(body: unknown
|
|
42
|
+
res.json = function newJson(body: unknown): Response {
|
|
43
43
|
if (_.isString(body)) {
|
|
44
44
|
try {
|
|
45
45
|
res.bodyCopy = JSON.parse(body);
|
|
@@ -59,4 +59,16 @@ describe("cleanUpParams", () => {
|
|
|
59
59
|
cleanUpParams(req);
|
|
60
60
|
assert.strictEqual(req.statsdKey, "api.a1.x123.department.departmentid"); // cspell: words departmentid
|
|
61
61
|
});
|
|
62
|
+
|
|
63
|
+
it("cleans up params when values are undefined", () => {
|
|
64
|
+
const req: Partial<Request> = {
|
|
65
|
+
statsdKey: "api.a1.admin.department",
|
|
66
|
+
params: {
|
|
67
|
+
departmentId: undefined as never, // Force value to undefined, when setting param as optional ":departmentId?"
|
|
68
|
+
x123: "admin",
|
|
69
|
+
}
|
|
70
|
+
};
|
|
71
|
+
cleanUpParams(req);
|
|
72
|
+
assert.strictEqual(req.statsdKey, "api.a1.x123.department");
|
|
73
|
+
});
|
|
62
74
|
});
|