@conduitplatform/grpc-sdk 0.14.6 → 0.15.0-rc.0

package/dist/metrics/clientMiddleware.js

@@ -0,0 +1,265 @@
+"use strict";
+// Forked from nice-grpc-prometheus
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var __asyncDelegator = (this && this.__asyncDelegator) || function (o) {
+    var i, p;
+    return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
+    function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === "return" } : f ? f(v) : v; } : f; }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientMiddleware = void 0;
+var abort_controller_x_1 = require("abort-controller-x");
+var nice_grpc_common_1 = require("nice-grpc-common");
+var prom_client_1 = require("prom-client");
+var registry = new prom_client_1.Registry();
+var typeLabel = 'grpc_type';
+var serviceLabel = 'grpc_service';
+var methodLabel = 'grpc_method';
+var pathLabel = 'grpc_path';
+var codeLabel = 'grpc_code';
+/**
+ * 1ms, 4ms, 16ms, ..., ~1 hour in seconds
+ */
+var latencySecondsBuckets = (0, prom_client_1.exponentialBuckets)(0.001, 4, 12);
+function getLabels(method) {
+    var _a;
+    var callType = method.requestStream
+        ? method.responseStream
+            ? 'bidi_stream'
+            : 'client_stream'
+        : method.responseStream
+            ? 'server_stream'
+            : 'unary';
+    var path = method.path;
+    var _b = __read(path.split('/').slice(1), 2), serviceName = _b[0], methodName = _b[1];
+    return _a = {},
+        _a[typeLabel] = callType,
+        _a[serviceLabel] = serviceName,
+        _a[methodLabel] = methodName,
+        _a[pathLabel] = path,
+        _a;
+}
+function incrementStreamMessagesCounter(iterable, counter) {
+    return __asyncGenerator(this, arguments, function incrementStreamMessagesCounter_1() {
+        var iterable_1, iterable_1_1, item, e_1_1;
+        var e_1, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 7, 8, 13]);
+                    iterable_1 = __asyncValues(iterable);
+                    _b.label = 1;
+                case 1: return [4 /*yield*/, __await(iterable_1.next())];
+                case 2:
+                    if (!(iterable_1_1 = _b.sent(), !iterable_1_1.done)) return [3 /*break*/, 6];
+                    item = iterable_1_1.value;
+                    counter.inc();
+                    return [4 /*yield*/, __await(item)];
+                case 3: return [4 /*yield*/, _b.sent()];
+                case 4:
+                    _b.sent();
+                    _b.label = 5;
+                case 5: return [3 /*break*/, 1];
+                case 6: return [3 /*break*/, 13];
+                case 7:
+                    e_1_1 = _b.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 13];
+                case 8:
+                    _b.trys.push([8, , 11, 12]);
+                    if (!(iterable_1_1 && !iterable_1_1.done && (_a = iterable_1.return))) return [3 /*break*/, 10];
+                    return [4 /*yield*/, __await(_a.call(iterable_1))];
+                case 9:
+                    _b.sent();
+                    _b.label = 10;
+                case 10: return [3 /*break*/, 12];
+                case 11:
+                    if (e_1) throw e_1.error;
+                    return [7 /*endfinally*/];
+                case 12: return [7 /*endfinally*/];
+                case 13: return [2 /*return*/];
+            }
+        });
+    });
+}
+var clientStartedMetric = new prom_client_1.Counter({
+    registers: [registry],
+    name: 'conduit_grpc_client_started_total',
+    help: 'Total number of RPCs started on the client.',
+    labelNames: [typeLabel, serviceLabel, methodLabel, pathLabel],
+});
+var clientHandledMetric = new prom_client_1.Counter({
+    registers: [registry],
+    name: 'conduit_grpc_client_handled_total',
+    help: 'Total number of RPCs completed on the client, regardless of success or failure.',
+    labelNames: [typeLabel, serviceLabel, methodLabel, pathLabel, codeLabel],
+});
+var clientStreamMsgReceivedMetric = new prom_client_1.Counter({
+    registers: [registry],
+    name: 'conduit_grpc_client_msg_received_total',
+    help: 'Total number of RPC stream messages received by the client.',
+    labelNames: [typeLabel, serviceLabel, methodLabel, pathLabel],
+});
+var clientStreamMsgSentMetric = new prom_client_1.Counter({
+    registers: [registry],
+    name: 'conduit_grpc_client_msg_sent_total',
+    help: 'Total number of gRPC stream messages sent by the client.',
+    labelNames: [typeLabel, serviceLabel, methodLabel, pathLabel],
+});
+var clientHandlingSecondsMetric = new prom_client_1.Histogram({
+    registers: [registry],
+    name: 'grpc_client_handling_seconds',
+    help: 'Histogram of response latency (seconds) of the gRPC until it is finished by the application.',
+    labelNames: [typeLabel, serviceLabel, methodLabel, pathLabel, codeLabel],
+    buckets: latencySecondsBuckets,
+});
+function clientMiddleware() {
+    return function prometheusClientMiddlewareGenerator(call, options) {
+        return __asyncGenerator(this, arguments, function prometheusClientMiddlewareGenerator_1() {
+            var labels, stopTimer, settled, status, request, response, err_1;
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        labels = getLabels(call.method);
+                        clientStartedMetric.inc(labels);
+                        stopTimer = clientHandlingSecondsMetric.startTimer(labels);
+                        settled = false;
+                        status = nice_grpc_common_1.Status.OK;
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 10, 11, 12]);
+                        request = void 0;
+                        if (!call.requestStream) {
+                            request = call.request;
+                        }
+                        else {
+                            request = incrementStreamMessagesCounter(call.request, clientStreamMsgSentMetric.labels(labels));
+                        }
+                        if (!!call.responseStream) return [3 /*break*/, 5];
+                        return [5 /*yield**/, __values(__asyncDelegator(__asyncValues(call.next(request, options))))];
+                    case 2: return [4 /*yield*/, __await.apply(void 0, [_c.sent()])];
+                    case 3:
+                        response = _c.sent();
+                        settled = true;
+                        return [4 /*yield*/, __await(response)];
+                    case 4: return [2 /*return*/, _c.sent()];
+                    case 5: return [5 /*yield**/, __values(__asyncDelegator(__asyncValues(incrementStreamMessagesCounter(call.next(request, options), clientStreamMsgReceivedMetric.labels(labels)))))];
+                    case 6: return [4 /*yield*/, __await.apply(void 0, [_c.sent()])];
+                    case 7:
+                        _c.sent();
+                        settled = true;
+                        return [4 /*yield*/, __await(void 0)];
+                    case 8: return [2 /*return*/, _c.sent()];
+                    case 9: return [3 /*break*/, 12];
+                    case 10:
+                        err_1 = _c.sent();
+                        settled = true;
+                        if (err_1 instanceof nice_grpc_common_1.ClientError) {
+                            status = err_1.code;
+                        }
+                        else if ((0, abort_controller_x_1.isAbortError)(err_1)) {
+                            status = nice_grpc_common_1.Status.CANCELLED;
+                        }
+                        else {
+                            status = nice_grpc_common_1.Status.UNKNOWN;
+                        }
+                        throw err_1;
+                    case 11:
+                        if (!settled) {
+                            status = nice_grpc_common_1.Status.CANCELLED;
+                        }
+                        stopTimer((_a = {}, _a[codeLabel] = nice_grpc_common_1.Status[status], _a));
+                        clientHandledMetric.inc(__assign(__assign({}, labels), (_b = {}, _b[codeLabel] = nice_grpc_common_1.Status[status], _b)));
+                        return [7 /*endfinally*/];
+                    case 12: return [2 /*return*/];
+                }
+            });
+        });
+    };
+}
+exports.clientMiddleware = clientMiddleware;
+//# sourceMappingURL=clientMiddleware.js.map

package/dist/metrics/clientMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientMiddleware.js","sourceRoot":"","sources":["../../src/metrics/clientMiddleware.ts"],"names":[],"mappings":";AAAA,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEnC,yDAAkD;AAClD,qDAO0B;AAC1B,2CAA+E;AAE/E,IAAM,QAAQ,GAAG,IAAI,sBAAQ,EAAE,CAAC;AAEhC,IAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,IAAM,YAAY,GAAG,cAAc,CAAC;AACpC,IAAM,WAAW,GAAG,aAAa,CAAC;AAClC,IAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,IAAM,SAAS,GAAG,WAAW,CAAC;AAC9B;;GAEG;AACH,IAAM,qBAAqB,GAAG,IAAA,gCAAkB,EAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAE/D,SAAS,SAAS,CAAC,MAAwB;;IACzC,IAAM,QAAQ,GAAG,MAAM,CAAC,aAAa;QACnC,CAAC,CAAC,MAAM,CAAC,cAAc;YACrB,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,eAAe;QACnB,CAAC,CAAC,MAAM,CAAC,cAAc;YACvB,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,OAAO,CAAC;IACJ,IAAA,IAAI,GAAK,MAAM,KAAX,CAAY;IAClB,IAAA,KAAA,OAA4B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,EAAnD,WAAW,QAAA,EAAE,UAAU,QAA4B,CAAC;IAC3D;QACE,GAAC,SAAS,IAAG,QAAQ;QACrB,GAAC,YAAY,IAAG,WAAW;QAC3B,GAAC,WAAW,IAAG,UAAU;QACzB,GAAC,SAAS,IAAG,IAAI;WACjB;AACJ,CAAC;AAED,SAAgB,8BAA8B,CAC5C,QAA0B,EAC1B,OAAyB;;;;;;;;oBAEA,aAAA,cAAA,QAAQ,CAAA;;;;;oBAAhB,IAAI,qBAAA,CAAA;oBACnB,OAAO,CAAC,GAAG,EAAE,CAAC;iDACR,IAAI;wBAAV,gCAAU;;oBAAV,SAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;CAEd;AAED,IAAM,mBAAmB,GAAG,IAAI,qBAAO,CAAC;IACtC,SAAS,EAAE,CAAC,QAAQ,CAAC;IACrB,IAAI,EAAE,mCAAmC;IACzC,IAAI,EAAE,6CAA6C;IACnD,UAAU,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,CAAC;CAC9D,CAAC,CAAC;AAEH,IAAM,mBAAmB,GAAG,IAAI,qBAAO,CAAC;IACtC,SAAS,EAAE,CAAC,QAAQ,CAAC;IACrB,IAAI,EAAE,mCAAmC;IACzC,IAAI,EAAE,iFAAiF;IACvF,UAAU,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,CAAC;CACzE,CAAC,CAAC;AAEH,IAAM,6BAA6B,GAAG,IAAI,qBAAO,CAAC;IAChD,SAAS,EAAE,CAAC,QAAQ,CAAC;IACrB,IAAI,EAAE,wCAAwC;IAC9C,IAAI,EAAE,6DAA6D;IACnE,UAAU,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,CAAC;CAC9D,CAAC,CAAC;AAEH,IAAM,yBAAyB,GAAG,IAAI,qBAAO,CAAC;IAC5C,SAAS,EAAE,CAAC,QAAQ,CAAC;IACrB,IAAI,EAAE,oCAAoC;IAC1C,IAAI,EAAE,0DAA0D;IAChE,UAAU,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,CAAC;CAC9D,CAAC,CAAC;AAEH,IAAM,2BAA2B,GAAG,IAAI,uBAAS,CAAC;IAChD,SAAS,EAAE,CAAC,QAAQ,CAAC;IACrB,IAAI,EAAE,8BAA8B;IACpC,IAAI,EAAE,8FAA8F;IACpG,UAAU,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,CAAC;IACxE,OAAO,EAAE,qBAAqB;CAC/B,CAAC,CAAC;AAEH,SAAgB,gBAAgB;IAC9B,OAAO,SAAgB,mCAAmC,CACxD,IAA6C,EAC7C,OAAoB;;;;;;;wBAEd,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBACtC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;wBAC1B,SAAS,GAAG,2BAA2B,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;wBAC7D,OAAO,GAAG,KAAK,CAAC;wBAChB,MAAM,GAAW,yBAAM,CAAC,EAAE,CAAC;;;;wBAEzB,OAAO,SAAA,CAAC;wBACZ,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;4BACvB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;yBACxB;6BAAM;4BACL,OAAO,GAAG,8BAA8B,CACtC,IAAI,CAAC,OAAO,EACZ,yBAAyB,CAAC,MAAM,CAAC,MAAM,CAAC,CACzC,CAAC;yBACH;6BACG,CAAC,IAAI,CAAC,cAAc,EAApB,wBAAoB;wBACL,sBAAA,SAAO,iBAAA,cAAA,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA,CAAA,CAAA,EAAA;4BAAlC,4CAAA,SAAkC,IAAA;;wBAA7C,QAAQ,GAAG,SAAkC;wBACnD,OAAO,GAAG,IAAI,CAAC;qDACR,QAAQ;4BAAf,iCAAgB;4BAEhB,sBAAA,SAAO,iBAAA,cAAA,8BAA8B,CACnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,EAC3B,6BAA6B,CAAC,MAAM,CAAC,MAAM,CAAC,CAC7C,CAAA,CAAA,CAAA,EAAA;4BAHD,4CAAA,SAGC,IAAA;;wBAHD,SAGC,CAAC;wBACF,OAAO,GAAG,IAAI,CAAC;;4BACf,iCAAO;;;;wBAGT,OAAO,GAAG,IAAI,CAAC;wBACf,IAAI,KAAG,YAAY,8BAAW,EAAE;4BAC9B,MAAM,GAAG,KAAG,CAAC,IAAI,CAAC;yBACnB;6BAAM,IAAI,IAAA,iCAAY,EAAC,KAAG,CAAC,EAAE;4BAC5B,MAAM,GAAG,yBAAM,CAAC,SAAS,CAAC;yBAC3B;6BAAM;4BACL,MAAM,GAAG,yBAAM,CAAC,OAAO,CAAC;yBACzB;wBACD,MAAM,KAAG,CAAC;;wBAEV,IAAI,CAAC,OAAO,EAAE;4BACZ,MAAM,GAAG,yBAAM,CAAC,SAAS,CAAC;yBAC3B;wBACD,SAAS,WAAG,GAAC,SAAS,IAAG,yBAAM,CAAC,MAAM,CAAC,MAAG,CAAC;wBAC3C,mBAAmB,CAAC,GAAG,uBAClB,MAAM,gBACR,SAAS,IAAG,yBAAM,CAAC,MAAM,CAAC,OAC3B,CAAC;;;;;;KAEN,CAAC;AACJ,CAAC;AArDD,4CAqDC"}

package/dist/metrics/config/defaults.d.ts

@@ -0,0 +1,61 @@
+import { MetricType } from '../../types';
+declare const _default: {
+    internalGrpcRequests: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+        };
+    };
+    clientGrpcRequests: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+        };
+    };
+    adminGrpcRequests: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+        };
+    };
+    clientGrpcErrors: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+        };
+    };
+    adminGrpcErrors: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+        };
+    };
+    moduleHealthState: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+        };
+    };
+    grpcRequestLatency: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+        };
+    };
+    grpcResponseStatuses: {
+        type: MetricType;
+        config: {
+            name: string;
+            help: string;
+            labelNames: string[];
+        };
+    };
+};
+export default _default;

package/dist/metrics/config/defaults.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var types_1 = require("../../types");
+exports.default = {
+    internalGrpcRequests: {
+        type: types_1.MetricType.Counter,
+        config: {
+            name: 'internal_grpc_requests_total',
+            help: "Tracks the total number of Conduit's internal gRPC requests",
+        },
+    },
+    clientGrpcRequests: {
+        type: types_1.MetricType.Counter,
+        config: {
+            name: 'client_grpc_requests_total',
+            help: 'Tracks the total number of the client gRPC requests',
+        },
+    },
+    adminGrpcRequests: {
+        type: types_1.MetricType.Counter,
+        config: {
+            name: 'admin_grpc_requests_total',
+            help: 'Tracks the total number of the admin gRPC requests',
+        },
+    },
+    clientGrpcErrors: {
+        type: types_1.MetricType.Counter,
+        config: {
+            name: 'client_grpc_errors_total',
+            help: 'Tracks the total number of client grpc errors',
+        },
+    },
+    adminGrpcErrors: {
+        type: types_1.MetricType.Counter,
+        config: {
+            name: 'admin_grpc_errors_total',
+            help: 'Tracks the total number of admin grpc errors',
+        },
+    },
+    moduleHealthState: {
+        type: types_1.MetricType.Gauge,
+        config: {
+            name: 'module_health_state',
+            help: 'Tracks the health state of the module',
+        },
+    },
+    grpcRequestLatency: {
+        type: types_1.MetricType.Gauge,
+        config: {
+            name: 'grpc_request_latency_seconds',
+            help: 'Tracks the latency of grpc requests in seconds',
+        },
+    },
+    grpcResponseStatuses: {
+        type: types_1.MetricType.Counter,
+        config: {
+            name: 'grpc_response_statuses_total',
+            help: 'Tracks the total number of grpc response codes',
+            labelNames: ['success'],
+        },
+    },
+};
+//# sourceMappingURL=defaults.js.map

package/dist/metrics/config/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../../src/metrics/config/defaults.ts"],"names":[],"mappings":";;AAAA,qCAAyC;AAEzC,kBAAe;IACb,oBAAoB,EAAE;QACpB,IAAI,EAAE,kBAAU,CAAC,OAAO;QACxB,MAAM,EAAE;YACN,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,6DAA6D;SACpE;KACF;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,kBAAU,CAAC,OAAO;QACxB,MAAM,EAAE;YACN,IAAI,EAAE,4BAA4B;YAClC,IAAI,EAAE,qDAAqD;SAC5D;KACF;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,kBAAU,CAAC,OAAO;QACxB,MAAM,EAAE;YACN,IAAI,EAAE,2BAA2B;YACjC,IAAI,EAAE,oDAAoD;SAC3D;KACF;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,kBAAU,CAAC,OAAO;QACxB,MAAM,EAAE;YACN,IAAI,EAAE,0BAA0B;YAChC,IAAI,EAAE,+CAA+C;SACtD;KACF;IACD,eAAe,EAAE;QACf,IAAI,EAAE,kBAAU,CAAC,OAAO;QACxB,MAAM,EAAE;YACN,IAAI,EAAE,yBAAyB;YAC/B,IAAI,EAAE,8CAA8C;SACrD;KACF;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,kBAAU,CAAC,KAAK;QACtB,MAAM,EAAE;YACN,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,uCAAuC;SAC9C;KACF;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,kBAAU,CAAC,KAAK;QACtB,MAAM,EAAE;YACN,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,gDAAgD;SACvD;KACF;IACD,oBAAoB,EAAE;QACpB,IAAI,EAAE,kBAAU,CAAC,OAAO;QACxB,MAAM,EAAE;YACN,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,gDAAgD;YACtD,UAAU,EAAE,CAAC,SAAS,CAAC;SACxB;KACF;CACF,CAAC"}

package/dist/metrics/index.d.ts

@@ -0,0 +1,26 @@
+import * as client from 'prom-client';
+import { CounterConfiguration, GaugeConfiguration, HistogramConfiguration, LabelValues, SummaryConfiguration } from 'prom-client';
+import { MetricConfiguration, MetricType } from '../types';
+export declare class ConduitMetrics {
+    private readonly moduleName;
+    private readonly instance;
+    private readonly Registry;
+    private _httpServer;
+    constructor(moduleName: string, instance: string);
+    initializeDefaultMetrics(): void;
+    registerMetric(type: MetricType, config: MetricConfiguration): void;
+    setDefaultLabels(labels: {
+        [key: string]: string;
+    }): void;
+    collectDefaultMetrics(): void;
+    createCounter(config: CounterConfiguration<any>): client.Counter<any>;
+    createSummary(config: SummaryConfiguration<any>): client.Summary<any>;
+    createHistogram(config: HistogramConfiguration<any>): client.Histogram<any>;
+    createGauge(config: GaugeConfiguration<any>): client.Gauge<any>;
+    getMetric(name: string): client.Metric<string> | undefined;
+    increment(metric: string, increment?: number, labels?: LabelValues<any>): void;
+    decrement(metric: string, decrement?: number, labels?: LabelValues<any>): void;
+    set(metric: string, value: number, labels?: LabelValues<any>): void;
+    observe(metric: string, value: number, labels?: LabelValues<any>): void;
+    private addPrefix;
+}

package/dist/metrics/index.js

@@ -0,0 +1,176 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConduitMetrics = void 0;
+var client = __importStar(require("prom-client"));
+var MetricsServer_1 = require("./MetricsServer");
+var defaults_1 = __importDefault(require("./config/defaults"));
+var prom_client_1 = require("prom-client");
+var types_1 = require("../types");
+var ConduitMetrics = /** @class */ (function () {
+    function ConduitMetrics(moduleName, instance) {
+        this.moduleName = moduleName;
+        this.instance = instance;
+        var globalRegistry = new client.Registry();
+        this.Registry = client.Registry.merge([globalRegistry, new prom_client_1.Registry()]);
+        this._httpServer = new MetricsServer_1.MetricsServer(moduleName, instance, this.Registry);
+        this._httpServer.initialize();
+        this.collectDefaultMetrics();
+    }
+    ConduitMetrics.prototype.initializeDefaultMetrics = function () {
+        var e_1, _a;
+        try {
+            for (var _b = __values(Object.values(defaults_1.default)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var metric = _c.value;
+                this.registerMetric(metric.type, metric.config);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    };
+    ConduitMetrics.prototype.registerMetric = function (type, config) {
+        if (this.getMetric(config.name))
+            return;
+        var metricConfig = JSON.parse(JSON.stringify(config));
+        metricConfig.name = this.addPrefix(config.name);
+        switch (type) {
+            case types_1.MetricType.Counter:
+                this.createCounter(metricConfig);
+                break;
+            case types_1.MetricType.Gauge:
+                this.createGauge(metricConfig);
+                break;
+            case types_1.MetricType.Histogram:
+                this.createHistogram(metricConfig);
+                break;
+            case types_1.MetricType.Summary:
+                this.createSummary(metricConfig);
+                break;
+        }
+    };
+    ConduitMetrics.prototype.setDefaultLabels = function (labels) {
+        this.Registry.setDefaultLabels(labels);
+    };
+    ConduitMetrics.prototype.collectDefaultMetrics = function () {
+        var collectDefaultMetrics = client.collectDefaultMetrics;
+        collectDefaultMetrics({
+            labels: {
+                module: this.moduleName,
+                instance: this.instance,
+            },
+        });
+    };
+    ConduitMetrics.prototype.createCounter = function (config) {
+        return new client.Counter(__assign(__assign({}, config), { registers: [this.Registry] }));
+    };
+    ConduitMetrics.prototype.createSummary = function (config) {
+        return new client.Summary(__assign(__assign({}, config), { registers: [this.Registry] }));
+    };
+    ConduitMetrics.prototype.createHistogram = function (config) {
+        return new client.Histogram(__assign(__assign({}, config), { registers: [this.Registry] }));
+    };
+    ConduitMetrics.prototype.createGauge = function (config) {
+        return new client.Gauge(__assign(__assign({}, config), { registers: [this.Registry] }));
+    };
+    ConduitMetrics.prototype.getMetric = function (name) {
+        return this.Registry.getSingleMetric(this.addPrefix(name));
+    };
+    ConduitMetrics.prototype.increment = function (metric, increment, labels) {
+        if (increment === void 0) { increment = 1; }
+        var metricInstance = this.Registry.getSingleMetric(this.addPrefix(metric));
+        if (!(metricInstance instanceof client.Counter) &&
+            !(metricInstance instanceof client.Gauge)) {
+            throw new Error("Metric ".concat(metric, " is not an incrementable metric"));
+        }
+        return labels
+            ? metricInstance.labels(__assign({}, labels)).inc(increment)
+            : metricInstance.inc(increment);
+    };
+    ConduitMetrics.prototype.decrement = function (metric, decrement, labels) {
+        if (decrement === void 0) { decrement = 1; }
+        var metricInstance = this.Registry.getSingleMetric(this.addPrefix(metric));
+        if (!(metricInstance instanceof client.Gauge)) {
+            throw new Error("Metric ".concat(metric, " is not a decrementable metric"));
+        }
+        return labels
+            ? metricInstance.labels(__assign({}, labels)).dec(decrement)
+            : metricInstance.dec(decrement);
+    };
+    ConduitMetrics.prototype.set = function (metric, value, labels) {
+        var metricInstance = this.Registry.getSingleMetric(this.addPrefix(metric));
+        if (!(metricInstance instanceof client.Gauge)) {
+            throw new Error("Metric ".concat(metric, " is not a Gauge"));
+        }
+        return labels
+            ? metricInstance.labels(__assign({}, labels)).set(value)
+            : metricInstance.set(value);
+    };
+    ConduitMetrics.prototype.observe = function (metric, value, labels) {
+        var metricInstance = this.Registry.getSingleMetric(this.addPrefix(metric));
+        if (!(metricInstance instanceof client.Histogram) &&
+            !(metricInstance instanceof client.Summary)) {
+            throw new Error("Metric ".concat(metric, " is not a Histogram"));
+        }
+        return labels
+            ? metricInstance.labels(__assign({}, labels)).observe(value)
+            : metricInstance.observe(value);
+    };
+    ConduitMetrics.prototype.addPrefix = function (metric) {
+        return "conduit_".concat(metric);
+    };
+    return ConduitMetrics;
+}());
+exports.ConduitMetrics = ConduitMetrics;
+//# sourceMappingURL=index.js.map

package/dist/metrics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/metrics/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAsC;AAQtC,iDAAgD;AAChD,+DAA+C;AAC/C,2CAAuC;AACvC,kCAA2D;AAE3D;IAME,wBAAY,UAAkB,EAAE,QAAgB;QAC9C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAM,cAAc,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE,IAAI,sBAAQ,EAAE,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,WAAW,GAAG,IAAI,6BAAa,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC9B,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;IAED,iDAAwB,GAAxB;;;YACE,KAAqB,IAAA,KAAA,SAAA,MAAM,CAAC,MAAM,CAAC,kBAAc,CAAC,CAAA,gBAAA,4BAAE;gBAA/C,IAAM,MAAM,WAAA;gBACf,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;aACjD;;;;;;;;;IACH,CAAC;IAED,uCAAc,GAAd,UAAe,IAAgB,EAAE,MAA2B;QAC1D,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO;QACxC,IAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACxD,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAChD,QAAQ,IAAI,EAAE;YACZ,KAAK,kBAAU,CAAC,OAAO;gBACrB,IAAI,CAAC,aAAa,CAAC,YAAyC,CAAC,CAAC;gBAC9D,MAAM;YACR,KAAK,kBAAU,CAAC,KAAK;gBACnB,IAAI,CAAC,WAAW,CAAC,YAAuC,CAAC,CAAC;gBAC1D,MAAM;YACR,KAAK,kBAAU,CAAC,SAAS;gBACvB,IAAI,CAAC,eAAe,CAAC,YAA2C,CAAC,CAAC;gBAClE,MAAM;YACR,KAAK,kBAAU,CAAC,OAAO;gBACrB,IAAI,CAAC,aAAa,CAAC,YAAyC,CAAC,CAAC;gBAC9D,MAAM;SACT;IACH,CAAC;IAED,yCAAgB,GAAhB,UAAiB,MAAiC;QAChD,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,8CAAqB,GAArB;QACE,IAAM,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;QAC3D,qBAAqB,CAAC;YACpB,MAAM,EAAE;gBACN,MAAM,EAAE,IAAI,CAAC,UAAU;gBACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB;SACF,CAAC,CAAC;IACL,CAAC;IAED,sCAAa,GAAb,UAAc,MAAiC;QAC7C,OAAO,IAAI,MAAM,CAAC,OAAO,uBAAM,MAAM,KAAE,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAG,CAAC;IACvE,CAAC;IAED,sCAAa,GAAb,UAAc,MAAiC;QAC7C,OAAO,IAAI,MAAM,CAAC,OAAO,uBAAM,MAAM,KAAE,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAG,CAAC;IACvE,CAAC;IAED,wCAAe,GAAf,UAAgB,MAAmC;QACjD,OAAO,IAAI,MAAM,CAAC,SAAS,uBAAM,MAAM,KAAE,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAG,CAAC;IACzE,CAAC;IAED,oCAAW,GAAX,UAAY,MAA+B;QACzC,OAAO,IAAI,MAAM,CAAC,KAAK,uBAAM,MAAM,KAAE,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAG,CAAC;IACrE,CAAC;IAED,kCAAS,GAAT,UAAU,IAAY;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,kCAAS,GAAT,UAAU,MAAc,EAAE,SAAqB,EAAE,MAAyB;QAAhD,0BAAA,EAAA,aAAqB;QAC7C,IAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7E,IACE,CAAC,CAAC,cAAc,YAAY,MAAM,CAAC,OAAO,CAAC;YAC3C,CAAC,CAAC,cAAc,YAAY,MAAM,CAAC,KAAK,CAAC,EACzC;YACA,MAAM,IAAI,KAAK,CAAC,iBAAU,MAAM,oCAAiC,CAAC,CAAC;SACpE;QACD,OAAO,MAAM;YACX,CAAC,CAAC,cAAc,CAAC,MAAM,cAAM,MAAM,EAAG,CAAC,GAAG,CAAC,SAAS,CAAC;YACrD,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAED,kCAAS,GAAT,UAAU,MAAc,EAAE,SAAqB,EAAE,MAAyB;QAAhD,0BAAA,EAAA,aAAqB;QAC7C,IAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,CAAC,cAAc,YAAY,MAAM,CAAC,KAAK,CAAC,EAAE;YAC7C,MAAM,IAAI,KAAK,CAAC,iBAAU,MAAM,mCAAgC,CAAC,CAAC;SACnE;QACD,OAAO,MAAM;YACX,CAAC,CAAC,cAAc,CAAC,MAAM,cAAM,MAAM,EAAG,CAAC,GAAG,CAAC,SAAS,CAAC;YACrD,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAED,4BAAG,GAAH,UAAI,MAAc,EAAE,KAAa,EAAE,MAAyB;QAC1D,IAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,CAAC,cAAc,YAAY,MAAM,CAAC,KAAK,CAAC,EAAE;YAC7C,MAAM,IAAI,KAAK,CAAC,iBAAU,MAAM,oBAAiB,CAAC,CAAC;SACpD;QACD,OAAO,MAAM;YACX,CAAC,CAAC,cAAc,CAAC,MAAM,cAAM,MAAM,EAAG,CAAC,GAAG,CAAC,KAAK,CAAC;YACjD,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,gCAAO,GAAP,UAAQ,MAAc,EAAE,KAAa,EAAE,MAAyB;QAC9D,IAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7E,IACE,CAAC,CAAC,cAAc,YAAY,MAAM,CAAC,SAAS,CAAC;YAC7C,CAAC,CAAC,cAAc,YAAY,MAAM,CAAC,OAAO,CAAC,EAC3C;YACA,MAAM,IAAI,KAAK,CAAC,iBAAU,MAAM,wBAAqB,CAAC,CAAC;SACxD;QACD,OAAO,MAAM;YACX,CAAC,CAAC,cAAc,CAAC,MAAM,cAAM,MAAM,EAAG,CAAC,OAAO,CAAC,KAAK,CAAC;YACrD,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAEO,kCAAS,GAAjB,UAAkB,MAAc;QAC9B,OAAO,kBAAW,MAAM,CAAE,CAAC;IAC7B,CAAC;IACH,qBAAC;AAAD,CAAC,AA7HD,IA6HC;AA7HY,wCAAc"}

package/dist/modules/admin/index.d.ts

@@ -1,13 +1,7 @@
 import { ConduitModule } from '../../classes/ConduitModule';
-import { GrpcServer } from '../../classes';
-import { AdminDefinition } from '../../protoUtils/core';
-import { Indexable } from '../../interfaces';
-import { ParsedRouterRequest } from '../../types';
+import { AdminDefinition, RegisterAdminRouteRequest_PathDefinition } from '../../protoUtils/core';
 export declare class Admin extends ConduitModule<typeof AdminDefinition> {
-    private readonly moduleName;
+    readonly moduleName: string;
     constructor(moduleName: string, url: string, grpcToken?: string);
-    registerAdminAsync(server: GrpcServer, paths: Indexable[], functions: {
-        [name: string]: (call: ParsedRouterRequest, callback?: Indexable) => Promise<any>;
-    }): Promise<any>;
-    register(paths: Indexable[], protoFile?: string, serverUrl?: string): Promise<any>;
+    register(paths: RegisterAdminRouteRequest_PathDefinition[], protoFile: string, serverUrl?: string): Promise<any>;
 }