@spinajs/metrics 2.0.150 → 2.0.152

package/lib/mjs/index.js

@@ -4,33 +4,68 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { BasePath, BaseController, Get, Response } from '@spinajs/http';
+import { Injectable, Bootstrapper, DI } from '@spinajs/di';
 import * as client from 'prom-client';
-class PrometheusResponse extends Response {
+import { default as promHttpBundle } from 'express-prom-bundle';
+import { Configuration } from '@spinajs/configuration';
+export const gauge = client.Gauge;
+export const histogram = client.Histogram;
+export const summary = client.Summary;
+export const counter = client.Counter;
+let MetricsBootstrapper = class MetricsBootstrapper extends Bootstrapper {
+    bootstrap() {
+        client.collectDefaultMetrics({
+            labels: { NODE_APP_INSTANCE: process.env.NODE_APP_INSTANCE },
+        });
+        DI.on('di.resolved.HttpServer', (_, server) => {
+            const cfg = _.get(Configuration);
+            const promCfg = cfg.get('metrics.http');
+            server.use(promHttpBundle({
+                ...promCfg,
+                // disable default autoregister
+                // we do this by controller with proper auth handling
+                autoregister: false,
+            }));
+        });
+    }
+};
+MetricsBootstrapper = __decorate([
+    Injectable(Bootstrapper)
+], MetricsBootstrapper);
+export { MetricsBootstrapper };
+/**
+ * Simple wrapper class for handling prom metrics
+ */
+export class Metrics {
     constructor() {
-        super(null);
+        this._histograms = new Map();
+        this._gauges = new Map();
+        this._counters = new Map();
+        this._summaries = new Map();
     }
-    async execute(_req, res) {
-        res.contentType(client.register.contentType);
-        res.end(client.register.metrics());
+    histogram(name, configuration) {
+        if (!this._histograms.has(name)) {
+            this._histograms.set(name, new client.Histogram(configuration));
+        }
+        return this._histograms.get(name);
     }
-}
-let Metrics = class Metrics extends BaseController {
-    async getMetrics() {
-        return new PrometheusResponse();
+    gauge(name, configuration) {
+        if (!this._gauges.has(name)) {
+            this._gauges.set(name, new client.Gauge(configuration));
+        }
+        return this._gauges.get(name);
     }
-};
-__decorate([
-    Get(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
-    __metadata("design:returntype", Promise)
-], Metrics.prototype, "getMetrics", null);
-Metrics = __decorate([
-    BasePath('metrics')
-], Metrics);
-export { Metrics };
+    counter(name, configuration) {
+        if (!this._counters.has(name)) {
+            this._counters.set(name, new client.Gauge(configuration));
+        }
+        return this._counters.get(name);
+    }
+    summary(name, configuration) {
+        if (!this._summaries.has(name)) {
+            this._summaries.set(name, new client.Summary(configuration));
+        }
+        return this._summaries.get(name);
+    }
+}
 //# sourceMappingURL=index.js.map

package/lib/mjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAGtC,MAAM,kBAAmB,SAAQ,QAAQ;IACvC;QACE,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,IAAqB,EAAE,GAAqB;QAC/D,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC7C,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACrC,CAAC;CACF;AAGM,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,cAAc;IAE5B,AAAN,KAAK,CAAC,UAAU;QACrB,OAAO,IAAI,kBAAkB,EAAE,CAAC;IAClC,CAAC;CACF,CAAA;AAHc;IADZ,GAAG,EAAE;;;;yCAGL;AAJU,OAAO;IADnB,QAAQ,CAAC,SAAS,CAAC;GACP,OAAO,CAKnB;SALY,OAAO"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,EAAc,MAAM,aAAa,CAAC;AAEvE,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;AAClC,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;AAC1C,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;AACtC,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;AAE/B,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,YAAY;IAC5C,SAAS;QACd,MAAM,CAAC,qBAAqB,CAAC;YAC3B,MAAM,EAAE,EAAE,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;SAC7D,CAAC,CAAC;QAEH,EAAE,CAAC,EAAE,CAAC,wBAAwB,EAAE,CAAC,CAAa,EAAE,MAAkB,EAAE,EAAE;YACpE,MAAM,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACjC,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAM,cAAc,CAAC,CAAC;YAE7C,MAAM,CAAC,GAAG,CACR,cAAc,CAAC;gBACb,GAAG,OAAO;gBAEV,+BAA+B;gBAC/B,qDAAqD;gBACrD,YAAY,EAAE,KAAK;aACpB,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AArBY,mBAAmB;IAD/B,UAAU,CAAC,YAAY,CAAC;GACZ,mBAAmB,CAqB/B;SArBY,mBAAmB;AAuBhC;;GAEG;AACH,MAAM,OAAO,OAAO;IAMlB;QACE,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAA4B,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAwB,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAA0B,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAA0B,CAAC;IACtD,CAAC;IAEM,SAAS,CAAmB,IAAY,EAAE,aAA+C;QAC9F,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;SACjE;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK,CAAmB,IAAY,EAAE,aAA2C;QACtF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC3B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;SACzD;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,OAAO,CAAmB,IAAY,EAAE,aAA6C;QAC1F,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC7B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;SAC3D;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAEM,OAAO,CAAmB,IAAY,EAAE,aAA6C;QAC1F,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC9B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;SAC9D;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;CACF"}

package/lib/mjs/policies/DefaultMetricsPolicy.d.ts

@@ -0,0 +1,11 @@
+import { BasePolicy, IController, IRoute, Request } from '@spinajs/http';
+import { Log } from '@spinajs/log';
+export declare class DefaultMetricsPolicy extends BasePolicy {
+    protected Log: Log;
+    protected Token: string;
+    protected HEADER_TOKEN_FIELD: string;
+    protected isDev: boolean;
+    isEnabled(_action: IRoute, _instance: IController): boolean;
+    execute(req: Request): Promise<void>;
+}
+//# sourceMappingURL=DefaultMetricsPolicy.d.ts.map

package/lib/mjs/policies/DefaultMetricsPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultMetricsPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/DefaultMetricsPolicy.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAEzE,OAAO,EAAE,GAAG,EAAU,MAAM,cAAc,CAAC;AAG3C,qBACa,oBAAqB,SAAQ,UAAU;IAElD,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAGnB,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IAExB,SAAS,CAAC,kBAAkB,SAAqB;IAGjD,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC;IAGlB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,GAAG,OAAO;IAIrD,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBlD"}

package/lib/mjs/policies/DefaultMetricsPolicy.js

@@ -0,0 +1,54 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Config } from '@spinajs/configuration';
+import { BasePolicy } from '@spinajs/http';
+import { Forbidden } from '@spinajs/exceptions';
+import { Log, Logger } from '@spinajs/log';
+import { Injectable } from '@spinajs/di';
+let DefaultMetricsPolicy = class DefaultMetricsPolicy extends BasePolicy {
+    constructor() {
+        super(...arguments);
+        this.HEADER_TOKEN_FIELD = 'x-metrics-token';
+    }
+    isEnabled(_action, _instance) {
+        return true;
+    }
+    async execute(req) {
+        if (this.isDev) {
+            return;
+        }
+        const token = req.headers[this.HEADER_TOKEN_FIELD];
+        if (!token) {
+            this.Log.warn(`No token is set for restricted area, header field: ${this.HEADER_TOKEN_FIELD}, policy: DefaultMetricsPolicy, ip: ${req.storage.realIp}`);
+            throw new Forbidden('access token is not set');
+        }
+        if (token !== this.Token) {
+            this.Log.warn(`Invalid access token received, token: ${token}, header field: ${this.HEADER_TOKEN_FIELD}, policy: DefaultMetricsPolicy, ip: ${req.storage.realIp}`);
+            throw new Forbidden('invalid access token');
+        }
+    }
+};
+__decorate([
+    Logger('Security'),
+    __metadata("design:type", Log)
+], DefaultMetricsPolicy.prototype, "Log", void 0);
+__decorate([
+    Config('metrics.auth.token'),
+    __metadata("design:type", String)
+], DefaultMetricsPolicy.prototype, "Token", void 0);
+__decorate([
+    Config('configuration.isDevelopment'),
+    __metadata("design:type", Boolean)
+], DefaultMetricsPolicy.prototype, "isDev", void 0);
+DefaultMetricsPolicy = __decorate([
+    Injectable(BasePolicy)
+], DefaultMetricsPolicy);
+export { DefaultMetricsPolicy };
+//# sourceMappingURL=DefaultMetricsPolicy.js.map

package/lib/mjs/policies/DefaultMetricsPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultMetricsPolicy.js","sourceRoot":"","sources":["../../../src/policies/DefaultMetricsPolicy.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAgC,MAAM,eAAe,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGlC,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,UAAU;IAA7C;;QAOK,uBAAkB,GAAG,iBAAiB,CAAC;IA0BnD,CAAC;IApBQ,SAAS,CAAC,OAAe,EAAE,SAAsB;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,GAAY;QAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO;SACR;QAED,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sDAAsD,IAAI,CAAC,kBAAkB,uCAAuC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YACxJ,MAAM,IAAI,SAAS,CAAC,yBAAyB,CAAC,CAAC;SAChD;QAED,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE;YACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yCAAyC,KAAK,mBAAmB,IAAI,CAAC,kBAAkB,uCAAuC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YACnK,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,CAAC;SAC7C;IACH,CAAC;CACF,CAAA;AAhCC;IAAC,MAAM,CAAC,UAAU,CAAC;8BACJ,GAAG;iDAAC;AAEnB;IAAC,MAAM,CAAC,oBAAoB,CAAC;;mDACL;AAIxB;IAAC,MAAM,CAAC,6BAA6B,CAAC;;mDACb;AAVd,oBAAoB;IADhC,UAAU,CAAC,UAAU,CAAC;GACV,oBAAoB,CAiChC;SAjCY,oBAAoB"}