@adalo/metrics 0.1.114 → 0.1.115

package/lib/metricsClient.d.ts

@@ -1,98 +1,17 @@
 /**
  * MetricsClient handles Prometheus metrics collection and push.
  * Supports gauges, counters, default metrics, and custom metrics.
+ * Extends BaseMetricsClient for common functionality.
  */
-export class MetricsClient {
-    /**
-     * @param {Object} config
-     * @param {string} [config.appName] Name of the application
-     * @param {string} [config.dynoId] Dyno/instance ID
-     * @param {string} [config.processType] Process type (web, worker, etc.)
-     * @param {boolean} [config.enabled] Enable metrics collection
-     * @param {boolean} [config.logValues] Log metrics values to console
-     * @param {string} [config.pushgatewayUrl] PushGateway URL
-     * @param {string} [config.pushgatewaySecret] PushGateway secret token
-     * @param {number} [config.intervalSec] Interval in seconds for pushing metrics
-     * @param {boolean} [config.removeOldMetrics] Enable to clear metrics by service name
-     * @param {boolean} [config.scripDefaultMetrics] Enable to scip default metrics creation
-     * @param {function} [config.startupValidation] Add to validate on start push.
-     */
-    constructor(config?: {
-        appName?: string | undefined;
-        dynoId?: string | undefined;
-        processType?: string | undefined;
-        enabled?: boolean | undefined;
-        logValues?: boolean | undefined;
-        pushgatewayUrl?: string | undefined;
-        pushgatewaySecret?: string | undefined;
-        intervalSec?: number | undefined;
-        removeOldMetrics?: boolean | undefined;
-        scripDefaultMetrics?: boolean | undefined;
-        startupValidation?: Function | undefined;
-    });
-    appName: string;
-    dynoId: string;
-    processType: string;
-    enabled: boolean;
-    logValues: boolean;
-    pushgatewayUrl: string;
-    authToken: string;
-    intervalSec: number;
-    startupValidation: Function | undefined;
-    prefixLogs: string;
-    _registry: client.Registry<"text/plain; version=0.0.4; charset=utf-8">;
-    defaultLabels: {
-        app: string;
-        dyno_id: string;
-        process_type: string;
-    };
-    gateway: client.Pushgateway<"text/plain; version=0.0.4; charset=utf-8">;
-    gauges: {};
-    counters: {};
-    countersFunctions: {};
-    /** @type {Object<string, function(): number | Promise<number>>} */
-    gaugeUpdaters: {
-        [x: string]: () => number | Promise<number>;
-    };
+export class MetricsClient extends BaseMetricsClient {
     _lastUsageMicros: number;
     _lastCheckTime: number;
+    _httpRequestBuffer: any[];
     /**
      * Register all built-in default Gauges and Counters.
      * @private
      */
     private _initDefaultMetrics;
-    /**
-     * Create a gauge metric.
-     * @param {Object} options - Gauge configuration
-     * @param {string} options.name - Name of the gauge
-     * @param {string} options.help - Help text describing the gauge
-     * @param {function(): number|Promise<number>} [options.updateFn] - Optional function returning the gauge value
-     * @param {string[]} [options.labelNames] - Optional custom label names
-     * @returns {import('prom-client').Gauge} The created Prometheus gauge
-     */
-    createGauge: ({ name, help, updateFn, labelNames, }: {
-        name: string;
-        help: string;
-        updateFn?: (() => number | Promise<number>) | undefined;
-        labelNames?: string[] | undefined;
-    }) => import('prom-client').Gauge;
-    /**
-     * Create a Prometheus Counter metric.
-     *
-     * @param {Object} params - Counter configuration
-     * @param {string} params.name - Metric name
-     * @param {string} params.help - Metric description
-     * @param {string[]} [params.labelNames] - Optional list of label names. Defaults to this.defaultLabels keys.
-     *
-     * @returns {(labels?: Object, incrementValue?: number) => void}
-     *          A function to increment the counter.
-     *          Usage: (labels?, incrementValue?)
-     */
-    createCounter({ name, help, labelNames }: {
-        name: string;
-        help: string;
-        labelNames?: string[] | undefined;
-    }): (labels?: Object, incrementValue?: number) => void;
     /**
      * Get CPU usage percent (cgroup-aware)
      * @returns {number}
@@ -119,9 +38,9 @@ export class MetricsClient {
      */
     measureLag(): Promise<number>;
     /**
-     * Increment the HTTP requests counter with detailed request information.
+     * Track an HTTP request (adds to buffer for interval collection).
      *
-     * @param {Object} params - The parameters for the request counter.
+     * @param {Object} params - The parameters for the request.
      * @param {string} params.method - HTTP method (GET, POST, etc.).
      * @param {string} params.route - The full requested URL or route.
      * @param {number} params.status_code - HTTP response status code.
@@ -138,92 +57,15 @@ export class MetricsClient {
         duration: number;
     }): void;
     /**
-     * Express middleware to track HTTP requests.
-     * Track the `app_requests_total` and `app_requests_total_duration` metric.
-     */
-    trackHttpRequestMiddleware: (req: any, res: any, next: any) => void;
-    /**
-     * Clear all collected counters
-     */
-    clearAllCounters: () => void;
-    /**
-     * Push all gauges and counters to PushGateway and optionally log.
-     */
-    pushMetrics: () => Promise<void>;
-    _startPush: (interval?: number, customPushMetics?: undefined) => void;
-    /**
-     * Start periodic metrics collection and push.
-     *
-     * This method wraps the internal `_startPush` method.
-     * If a `customPushMetrics` function is provided, it will be executed
-     * at the given interval instead of the default `pushMetrics` behavior.
-     *
-     * @param {number} [interval=this.intervalSec] - Interval in seconds between pushes.
-     * @param {() => void | Promise<void>} [customPushMetrics] - Optional custom push function. If provided, Prometheus push is skipped.
-     */
-    startPush: (interval?: number | undefined, customPushMetics?: undefined) => void;
-    /**
-     * Cleanup metrics and exit process.
-     * @returns {Promise<void>}
-     */
-    cleanup: () => Promise<void>;
-    /**
-     * Remove old/stale dyno/instance metrics from PushGateway.
-     *
-     * Compares existing PushGateway metrics for this job and deletes any instances
-     * that do not match the current dynoId.
-     *
-     * @param {boolean} removeOldMetrics If true, performs cleanup; otherwise does nothing
-     * @returns {Promise<void>}
+     * Collect HTTP metrics from buffer, group by labels, and set gauges.
      * @private
      */
-    private _clearOldWorkers;
-    /**
-     * Delete metrics for this job/instance from PushGateway.
-     *
-     * @param {Object} [params]
-     * @param {string} [params.jobName] Job name (defaults to appName)
-     * @param {Object} [params.groupings] Grouping labels
-     * @param {string} [params.groupings.process_type] Process type label
-     * @param {string} [params.groupings.instance] Instance/dyno ID
-     * @returns {Promise<void>}
-     */
-    gatewayDelete: (params?: {
-        jobName?: string | undefined;
-        groupings?: {
-            process_type?: string | undefined;
-            instance?: string | undefined;
-        } | undefined;
-    } | undefined) => Promise<void>;
-    /**
-     * Push metrics to PushGateway.
-     *
-     * @param {object} [params]
-     * @param {string} [params.jobName]
-     * @param {object} [params.groupings]
-     * @returns {Promise<void>}
-     */
-    gatewayPush: (params?: {
-        jobName?: string | undefined;
-        groupings?: object | undefined;
-    } | undefined) => Promise<void>;
+    private _collectHttpMetrics;
     /**
-     * Merge the default metric labels (`app`, `dyno_id`, `process_type`)
-     * with custom label names.
-     *
-     * @param {string[]} labels Additional label names
-     * @returns {string[]} Combined label names
+     * Express middleware to track HTTP requests.
+     * Track the `http_app_requests_total` and `http_app_requests_total_duration` metric.
      */
-    withDefaultLabels: (labels?: string[]) => string[];
-    getDefaultLabels: (labels?: any[]) => {
-        app: string;
-        dyno_id: string;
-        process_type: string;
-    };
-    _setCleanupHandlers: () => void;
-    get metricsEnabled(): boolean;
-    get metricsLogValues(): boolean;
-    get registry(): client.Registry<"text/plain; version=0.0.4; charset=utf-8">;
+    trackHttpRequestMiddleware: (req: any, res: any, next: any) => void;
 }
-import client = require("prom-client");
+import { BaseMetricsClient } from "./baseMetricsClient";
 //# sourceMappingURL=metricsClient.d.ts.map

package/lib/metricsClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metricsClient.d.ts","sourceRoot":"","sources":["../src/metricsClient.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;IACE;;;;;;;;;;;;;OAaG;IACH;QAZ2B,OAAO;QACP,MAAM;QACN,WAAW;QACV,OAAO;QACP,SAAS;QACV,cAAc;QACd,iBAAiB;QACjB,WAAW;QACV,gBAAgB;QAChB,mBAAmB;QAClB,iBAAiB;OAuD7C;IApDC,gBAA4E;IAC5E,eAAqE;IACrE,oBAG6B;IAC7B,iBAAuE;IACvE,mBAC+D;IAC/D,uBACoE;IACpE,kBAC0E;IAC1E,oBAGI;IACJ,wCAAiD;IAEjD,mBAAyF;IAEzF,uEAAsC;IAGtC;;;;MAIC;IAED,wEAOC;IACD,WAAgB;IAChB,aAAkB;IAClB,sBAA2B;IAE3B,mEAAmE;IACnE;YADkB,MAAM,SAAc,MAAM,GAAG,QAAQ,MAAM,CAAC;MACvC;IACvB,yBAAyB;IACzB,uBAAgC;IASlC;;;OAGG;IACH,4BA4DC;IAED;;;;;;;;OAQG;IACH;QAN2B,IAAI,EAApB,MAAM;QACU,IAAI,EAApB,MAAM;QACuC,QAAQ,UAAzC,MAAM,GAAC,QAAQ,MAAM,CAAC;QACf,UAAU;UAC3B,OAAO,aAAa,EAAE,KAAK,CAuBvC;IAED;;;;;;;;;;;OAWG;IACH;QAR0B,IAAI,EAAnB,MAAM;QACS,IAAI,EAAnB,MAAM;QACY,UAAU;kBAEhB,MAAM,mBAAmB,MAAM,KAAK,IAAI,CAuB9D;IAED;;;OAGG;IACH,0BAFa,MAAM,CA2BlB;IAED;;;OAGG;IACH,oBAFa,MAAM,CAiBlB;IAED;;;OAGG;IACH,2BAFa,MAAM,CAWlB;IAED;;;OAGG;IACH,2BAFa,MAAM,CAgBlB;IAED;;;OAGG;IACH,cAFa,QAAQ,MAAM,CAAC,CAO3B;IAED;;;;;;;;;;OAUG;IACH;QAP0B,MAAM,EAArB,MAAM;QACS,KAAK,EAApB,MAAM;QACS,WAAW,EAA1B,MAAM;QACU,KAAK;QACL,UAAU;QACX,QAAQ,EAAvB,MAAM;aA2BhB;IAED;;;OAGG;IACH,oEA+BC;IAED;;OAEG;IACH,6BAKC;IAED;;OAEG;IACH,iCA+BC;IAED,sEAuBC;IAED;;;;;;;;;OASG;IACH,iFAEC;IAED;;;OAGG;IACH,eAFa,QAAQ,IAAI,CAAC,CAOzB;IAED;;;;;;;;;OASG;IACH,yBA0FC;IAED;;;;;;;;;OASG;IACH;;;;;;sBAFa,QAAQ,IAAI,CAAC,CAUzB;IAED;;;;;;;OAOG;IACH;;;sBAFa,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;OAMG;IACH,6BAHW,MAAM,EAAE,KACN,MAAM,EAAE,CAIpB;IAED;;;;MAEC;IAED,gCAGC;IAID,8BAEC;IAED,gCAEC;IAED,4EAEC;CACF"}
+{"version":3,"file":"metricsClient.d.ts","sourceRoot":"","sources":["../src/metricsClient.js"],"names":[],"mappings":"AAIA;;;;GAIG;AACH;IAiBI,yBAAyB;IACzB,uBAAgC;IAEhC,0BAA4B;IAK9B;;;OAGG;IACH,4BA4DC;IAED;;;OAGG;IACH,0BAFa,MAAM,CA2BlB;IAED;;;OAGG;IACH,oBAFa,MAAM,CAiBlB;IAED;;;OAGG;IACH,2BAFa,MAAM,CAWlB;IAED;;;OAGG;IACH,2BAFa,MAAM,CAgBlB;IAED;;;OAGG;IACH,cAFa,QAAQ,MAAM,CAAC,CAO3B;IAED;;;;;;;;;;OAUG;IACH;QAP0B,MAAM,EAArB,MAAM;QACS,KAAK,EAApB,MAAM;QACS,WAAW,EAA1B,MAAM;QACU,KAAK;QACL,UAAU;QACX,QAAQ,EAAvB,MAAM;aAoBhB;IAED;;;OAGG;IACH,4BA6CC;IAUD;;;OAGG;IACH,oEA+BC;CACF"}