tabletcommand-logger 2.3.0 → 2.3.2
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/index.js +25 -1
- package/build/index.js.map +1 -1
- package/build/middleware/metrics.js +24 -19
- package/build/middleware/metrics.js.map +1 -1
- package/build/test/middleware-metrics.js +13 -12
- package/build/test/middleware-metrics.js.map +1 -1
- package/definitions/index.d.ts +2 -1
- package/definitions/index.d.ts.map +1 -1
- package/definitions/middleware/metrics.d.ts +1 -1
- package/definitions/middleware/metrics.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +2 -1
- package/src/middleware/metrics.ts +26 -22
- package/src/test/middleware-metrics.ts +14 -13
package/build/index.js
CHANGED
|
@@ -1,4 +1,27 @@
|
|
|
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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
2
25
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
26
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
27
|
};
|
|
@@ -6,7 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
6
29
|
exports.statusLogger = exports.metricsMiddleware = exports.loggerMiddleware = exports.logger = void 0;
|
|
7
30
|
const bunyan_logger_1 = __importDefault(require("./bunyan-logger"));
|
|
8
31
|
const logger_1 = __importDefault(require("./middleware/logger"));
|
|
9
|
-
const metrics_1 =
|
|
32
|
+
const metrics_1 = __importStar(require("./middleware/metrics"));
|
|
10
33
|
const status_logger_1 = __importDefault(require("./middleware/status-logger"));
|
|
11
34
|
exports.logger = bunyan_logger_1.default;
|
|
12
35
|
exports.loggerMiddleware = logger_1.default;
|
|
@@ -16,6 +39,7 @@ exports.default = {
|
|
|
16
39
|
logger: exports.logger,
|
|
17
40
|
loggerMiddleware: exports.loggerMiddleware,
|
|
18
41
|
metricsMiddleware: exports.metricsMiddleware,
|
|
42
|
+
metricsCleanUpParams: metrics_1.cleanUpParams,
|
|
19
43
|
statusLogger: exports.statusLogger,
|
|
20
44
|
};
|
|
21
45
|
//# sourceMappingURL=index.js.map
|
package/build/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,oEAAsC;AACtC,iEAAoD;AACpD,gEAA0E;AAC1E,+EAAuD;AAE1C,QAAA,MAAM,GAAG,uBAAO,CAAC;AACjB,QAAA,gBAAgB,GAAG,gBAAiB,CAAC;AACrC,QAAA,iBAAiB,GAAG,iBAAkB,CAAC;AACvC,QAAA,YAAY,GAAG,uBAAa,CAAC;AAE1C,kBAAe;IACb,MAAM,EAAN,cAAM;IACN,gBAAgB,EAAhB,wBAAgB;IAChB,iBAAiB,EAAjB,yBAAiB;IACjB,oBAAoB,EAAE,uBAAa;IACnC,YAAY,EAAZ,oBAAY;CACb,CAAC"}
|
|
@@ -3,6 +3,7 @@ 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.cleanUpParams = void 0;
|
|
6
7
|
const os_1 = __importDefault(require("os"));
|
|
7
8
|
const url_1 = require("url");
|
|
8
9
|
const lodash_1 = __importDefault(require("lodash"));
|
|
@@ -34,7 +35,10 @@ function metrics(filter) {
|
|
|
34
35
|
function setStatsDKey(req, hostname, env) {
|
|
35
36
|
let method = req.method || "unknown_method";
|
|
36
37
|
method = method.toLowerCase();
|
|
37
|
-
const
|
|
38
|
+
const defaultBase = "http://localhost";
|
|
39
|
+
const urlItem = new url_1.URL(req.url, defaultBase);
|
|
40
|
+
let path = urlItem.pathname.toLowerCase();
|
|
41
|
+
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
38
42
|
let filterFunc = defaultFilter;
|
|
39
43
|
if (lodash_1.default.isFunction(filter)) {
|
|
40
44
|
filterFunc = filter;
|
|
@@ -58,29 +62,30 @@ function metrics(filter) {
|
|
|
58
62
|
return next();
|
|
59
63
|
};
|
|
60
64
|
}
|
|
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
|
-
}
|
|
78
65
|
return {
|
|
79
66
|
defaultFilter,
|
|
80
67
|
setStatsDKey,
|
|
81
68
|
statsd,
|
|
82
|
-
cleanUpParams,
|
|
83
69
|
};
|
|
84
70
|
}
|
|
85
71
|
exports.default = metrics;
|
|
72
|
+
function cleanUpParams(req) {
|
|
73
|
+
var _a;
|
|
74
|
+
if (!lodash_1.default.isString(req.statsdKey)) {
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
let path = req.statsdKey.toLowerCase();
|
|
78
|
+
// Attempt to replace :params values with their keys
|
|
79
|
+
if (lodash_1.default.isObject(req.params)) {
|
|
80
|
+
lodash_1.default.forEach((_a = req.params) !== null && _a !== void 0 ? _a : {}, (value, key) => {
|
|
81
|
+
const foundIndex = path.lastIndexOf(value.toLowerCase());
|
|
82
|
+
if (foundIndex >= 0) {
|
|
83
|
+
path = path.substring(0, foundIndex) + key + path.substring(foundIndex + value.toLowerCase().length);
|
|
84
|
+
}
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
88
|
+
req.statsdKey = path.toLowerCase();
|
|
89
|
+
}
|
|
90
|
+
exports.cleanUpParams = cleanUpParams;
|
|
86
91
|
//# sourceMappingURL=metrics.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/middleware/metrics.ts"],"names":[],"mappings":"
|
|
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,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,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,OAAO;QACL,aAAa;QACb,YAAY;QACZ,MAAM;KACP,CAAC;AACJ,CAAC;AA3DD,0BA2DC;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,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;AAnBD,sCAmBC"}
|
|
@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
const chai_1 = require("chai");
|
|
7
7
|
const metrics_1 = __importDefault(require("../middleware/metrics"));
|
|
8
|
+
const metrics_2 = require("../middleware/metrics");
|
|
8
9
|
const metrics = (0, metrics_1.default)();
|
|
9
10
|
describe("Metrics Middleware", function () {
|
|
10
11
|
context("Default Filter", () => {
|
|
@@ -43,18 +44,18 @@ describe("Metrics Middleware", function () {
|
|
|
43
44
|
chai_1.assert.equal(req.statsdKey, expectedStatsdKey);
|
|
44
45
|
});
|
|
45
46
|
});
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
47
|
+
});
|
|
48
|
+
describe("cleanUpParams", () => {
|
|
49
|
+
it("cleans up params", () => {
|
|
50
|
+
const req = {
|
|
51
|
+
statsdKey: "api.a1.admin.department.abcd",
|
|
52
|
+
params: {
|
|
53
|
+
departmentId: "abcd",
|
|
54
|
+
x123: "admin",
|
|
55
|
+
}
|
|
56
|
+
};
|
|
57
|
+
(0, metrics_2.cleanUpParams)(req);
|
|
58
|
+
chai_1.assert.strictEqual(req.statsdKey, "api.a1.x123.department.departmentid"); // cspell: words departmentid
|
|
58
59
|
});
|
|
59
60
|
});
|
|
60
61
|
//# 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,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;
|
|
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"}
|
package/definitions/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import _logger from "./bunyan-logger";
|
|
2
2
|
import _loggerMiddleware from "./middleware/logger";
|
|
3
|
-
import _metricsMiddleware from "./middleware/metrics";
|
|
3
|
+
import _metricsMiddleware, { cleanUpParams } from "./middleware/metrics";
|
|
4
4
|
import _statusLogger from "./middleware/status-logger";
|
|
5
5
|
export declare const logger: typeof _logger;
|
|
6
6
|
export declare const loggerMiddleware: typeof _loggerMiddleware;
|
|
@@ -10,6 +10,7 @@ declare const _default: {
|
|
|
10
10
|
logger: typeof _logger;
|
|
11
11
|
loggerMiddleware: typeof _loggerMiddleware;
|
|
12
12
|
metricsMiddleware: typeof _metricsMiddleware;
|
|
13
|
+
metricsCleanUpParams: typeof cleanUpParams;
|
|
13
14
|
statusLogger: typeof _statusLogger;
|
|
14
15
|
};
|
|
15
16
|
export default _default;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,iBAAiB,CAAC;AACtC,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,iBAAiB,CAAC;AACtC,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,kBAAkB,EAAE,EAAE,aAAa,EAAG,MAAM,sBAAsB,CAAC;AAC1E,OAAO,aAAa,MAAM,4BAA4B,CAAC;AAEvD,eAAO,MAAM,MAAM,gBAAU,CAAC;AAC9B,eAAO,MAAM,gBAAgB,0BAAoB,CAAC;AAClD,eAAO,MAAM,iBAAiB,2BAAqB,CAAC;AACpD,eAAO,MAAM,YAAY,sBAAgB,CAAC;;;;;;;;AAE1C,wBAME"}
|
|
@@ -4,8 +4,8 @@ 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;
|
|
8
7
|
};
|
|
8
|
+
export declare function cleanUpParams(req: Partial<Request>): void;
|
|
9
9
|
export declare 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,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;wBAuB/B,OAAO,OAAO,QAAQ,QAAQ,YAAY;EAc7E;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,QAmBlD;AAED,oBAAY,aAAa,GAAG,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
import _logger from "./bunyan-logger";
|
|
3
3
|
import _loggerMiddleware from "./middleware/logger";
|
|
4
|
-
import _metricsMiddleware from "./middleware/metrics";
|
|
4
|
+
import _metricsMiddleware, { cleanUpParams, } from "./middleware/metrics";
|
|
5
5
|
import _statusLogger from "./middleware/status-logger";
|
|
6
6
|
|
|
7
7
|
export const logger = _logger;
|
|
@@ -13,5 +13,6 @@ export default {
|
|
|
13
13
|
logger,
|
|
14
14
|
loggerMiddleware,
|
|
15
15
|
metricsMiddleware,
|
|
16
|
+
metricsCleanUpParams: cleanUpParams,
|
|
16
17
|
statusLogger,
|
|
17
18
|
};
|
|
@@ -37,12 +37,15 @@ 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
|
|
40
|
+
const defaultBase = "http://localhost";
|
|
41
|
+
const urlItem = new URL(req.url, defaultBase);
|
|
42
|
+
let path = urlItem.pathname.toLowerCase();
|
|
43
|
+
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
41
44
|
let filterFunc = defaultFilter;
|
|
42
45
|
if (_.isFunction(filter)) {
|
|
43
46
|
filterFunc = filter;
|
|
44
47
|
}
|
|
45
|
-
const filteredPath = filterFunc(path);
|
|
48
|
+
const filteredPath: string = filterFunc(path);
|
|
46
49
|
req.statsdKey = [
|
|
47
50
|
hostname,
|
|
48
51
|
env,
|
|
@@ -63,31 +66,32 @@ export default function metrics(filter?: FilterFunction) {
|
|
|
63
66
|
};
|
|
64
67
|
}
|
|
65
68
|
|
|
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
|
-
|
|
85
69
|
return {
|
|
86
70
|
defaultFilter,
|
|
87
71
|
setStatsDKey,
|
|
88
72
|
statsd,
|
|
89
|
-
cleanUpParams,
|
|
90
73
|
};
|
|
91
74
|
}
|
|
92
75
|
|
|
76
|
+
export function cleanUpParams(req: Partial<Request>) {
|
|
77
|
+
if (!_.isString(req.statsdKey)) {
|
|
78
|
+
return;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
let path = req.statsdKey.toLowerCase();
|
|
82
|
+
|
|
83
|
+
// Attempt to replace :params values with their keys
|
|
84
|
+
if (_.isObject(req.params)) {
|
|
85
|
+
_.forEach(req.params ?? {}, (value, key) => {
|
|
86
|
+
const foundIndex = path.lastIndexOf(value.toLowerCase());
|
|
87
|
+
if (foundIndex >= 0) {
|
|
88
|
+
path = path.substring(0, foundIndex) + key + path.substring(foundIndex + value.toLowerCase().length);
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
path = path.replace(/\//g, " ").trim().replace(/\s/g, ".");
|
|
94
|
+
req.statsdKey = path.toLowerCase();
|
|
95
|
+
}
|
|
96
|
+
|
|
93
97
|
export type MetricsModule = ReturnType<typeof metrics>;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { assert } from "chai";
|
|
2
2
|
import { Request } from "express";
|
|
3
3
|
import MetricsModule from "../middleware/metrics";
|
|
4
|
+
import { cleanUpParams } from "../middleware/metrics";
|
|
4
5
|
const metrics = MetricsModule();
|
|
5
6
|
|
|
6
7
|
describe("Metrics Middleware", function() {
|
|
@@ -44,18 +45,18 @@ describe("Metrics Middleware", function() {
|
|
|
44
45
|
assert.equal(req.statsdKey, expectedStatsdKey);
|
|
45
46
|
});
|
|
46
47
|
});
|
|
48
|
+
});
|
|
47
49
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
});
|
|
50
|
+
describe("cleanUpParams", () => {
|
|
51
|
+
it("cleans up params", () => {
|
|
52
|
+
const req: Partial<Request> = {
|
|
53
|
+
statsdKey: "api.a1.admin.department.abcd",
|
|
54
|
+
params: {
|
|
55
|
+
departmentId: "abcd",
|
|
56
|
+
x123: "admin",
|
|
57
|
+
}
|
|
58
|
+
};
|
|
59
|
+
cleanUpParams(req);
|
|
60
|
+
assert.strictEqual(req.statsdKey, "api.a1.x123.department.departmentid"); // cspell: words departmentid
|
|
60
61
|
});
|
|
61
|
-
});
|
|
62
|
+
});
|