@oino-ts/common 0.20.2 → 0.21.0

package/dist/cjs/OINOBenchmark.js

@@ -13,6 +13,8 @@ exports.OINOMemoryBenchmark = exports.OINOBenchmark = void 0;
 class OINOBenchmark {
     static _instance;
     static _enabled = {};
+    static _healthBenchmarks = [];
+    static _healthLateRatio = 0;
     /**
      * Create a new OINOBenchmark instance.
      *
@@ -39,6 +41,44 @@ class OINOBenchmark {
     static getInstance() {
         return OINOBenchmark._instance;
     }
+    /**
+     * Add benchmark to be used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static addHealthBenchmark(module, method) {
+        const name = module + "." + method;
+        if (!OINOBenchmark._healthBenchmarks.includes(name)) {
+            OINOBenchmark._healthBenchmarks.push(name);
+        }
+    }
+    /**
+     * Remove benchmark from being used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static removeHealthBenchmark(module, method) {
+        const name = module + "." + method;
+        const index = OINOBenchmark._healthBenchmarks.indexOf(name);
+        if (index !== -1) {
+            OINOBenchmark._healthBenchmarks.splice(index, 1);
+        }
+    }
+    /**
+     * Set late ratio threshold for health monitoring. If a request takes this many times longer than the average duration, it is considered late and a health failure.
+     * @param lateRatio of health benchmarks, e.g. 2.0 means requests that take 2 times longer than the average
+     */
+    static setHealthLateRatio(lateRatio) {
+        OINOBenchmark._healthLateRatio = lateRatio;
+    }
+    /**
+     * Get service health based on the configured health benchmark.
+     *
+     * @returns service health as 0-1
+     */
+    static getHealth() {
+        return OINOBenchmark._instance ? OINOBenchmark._instance._getHealth() : 1;
+    }
     /**
      * Reset benchmark data (but not what is enabled).
      *
@@ -71,9 +111,10 @@ class OINOBenchmark {
      *
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    static endMetric(module, method) {
-        OINOBenchmark._instance?._endMetric(module, method);
+    static endMetric(module, method, success = true) {
+        OINOBenchmark._instance?._endMetric(module, method, success);
     }
     /**
      * Get given benchmark data.
@@ -98,11 +139,11 @@ class OINOBenchmark {
      * @param module of the metric
      * @param method of the metric
      * @param value of the metric
-     *
+     * @param success indicates if the metric was successful
      */
-    static trackMetric(module, method, value) {
+    static trackMetric(module, method, value, success = true) {
         if (OINOBenchmark._enabled[module]) {
-            OINOBenchmark._instance?._trackMetric(module, method, value);
+            OINOBenchmark._instance?._trackMetric(module, method, value, success);
         }
     }
     /**
@@ -137,6 +178,8 @@ class OINOMemoryBenchmark extends OINOBenchmark {
     _benchmarkCount = {};
     _benchmarkData = {};
     _benchmarkStart = {};
+    _healthBenchmarks = 0;
+    _healthFailures = 0;
     _exceptions = [];
     /**
      * Reset benchmark data (but not what is enabled).
@@ -145,6 +188,8 @@ class OINOMemoryBenchmark extends OINOBenchmark {
     _reset() {
         this._benchmarkData = {};
         this._benchmarkCount = {};
+        this._healthBenchmarks = 0;
+        this._healthFailures = 0;
     }
     /**
      * Start benchmark timing.
@@ -163,14 +208,15 @@ class OINOMemoryBenchmark extends OINOBenchmark {
      *
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    _endMetric(module, method) {
+    _endMetric(module, method, success = true) {
         const name = module + "." + method;
         let result = 0;
         if (OINOBenchmark._enabled[module] && (this._benchmarkStart[name] > 0)) { // if benchmark is started, end it
             const duration = performance.now() - this._benchmarkStart[name];
             this._benchmarkStart[name] = 0;
-            this._trackMetric(module, method, duration);
+            this._trackMetric(module, method, duration, success);
         }
         return;
     }
@@ -201,7 +247,7 @@ class OINOMemoryBenchmark extends OINOBenchmark {
         }
         return result;
     }
-    _trackMetric(module, method, value) {
+    _trackMetric(module, method, value, success = true) {
         const name = module + "." + method;
         if (this._benchmarkCount[name] == undefined) {
             this._benchmarkCount[name] = 1;
@@ -211,6 +257,19 @@ class OINOMemoryBenchmark extends OINOBenchmark {
             this._benchmarkCount[name] += 1;
             this._benchmarkData[name] += value;
         }
+        if (OINOBenchmark._healthBenchmarks.includes(name)) {
+            // console.log(`Health benchmark ${name}: value=${value.toFixed(2)}ms, average=${(this._benchmarkData[name] / this._benchmarkCount[name]).toFixed(2)}ms, late=${late_ratio>=OINOBenchmark._healthLateRatio}, success=${success}`)
+            this._healthBenchmarks += 1;
+            if (!success) {
+                this._healthFailures += 1;
+            }
+            else if (OINOBenchmark._healthLateRatio > 0) {
+                const late_ratio = value / (this._benchmarkData[name] / this._benchmarkCount[name]);
+                if ((late_ratio > OINOBenchmark._healthLateRatio)) {
+                    this._healthFailures += 1;
+                }
+            }
+        }
     }
     _trackException(module, method, name, message, stack) {
         const exception = { module, method, name, message, stack, timestamp: Date.now() };
@@ -219,5 +278,13 @@ class OINOMemoryBenchmark extends OINOBenchmark {
     _getExceptions() {
         return this._exceptions;
     }
+    _getHealth() {
+        if ((OINOBenchmark._healthBenchmarks.length == 0) || (this._healthBenchmarks == 0)) {
+            return 1.0;
+        }
+        else {
+            return (this._healthBenchmarks - this._healthFailures) / this._healthBenchmarks;
+        }
+    }
 }
 exports.OINOMemoryBenchmark = OINOMemoryBenchmark;

package/dist/esm/OINOBenchmark.js

@@ -10,6 +10,8 @@
 export class OINOBenchmark {
     static _instance;
     static _enabled = {};
+    static _healthBenchmarks = [];
+    static _healthLateRatio = 0;
     /**
      * Create a new OINOBenchmark instance.
      *
@@ -36,6 +38,44 @@ export class OINOBenchmark {
     static getInstance() {
         return OINOBenchmark._instance;
     }
+    /**
+     * Add benchmark to be used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static addHealthBenchmark(module, method) {
+        const name = module + "." + method;
+        if (!OINOBenchmark._healthBenchmarks.includes(name)) {
+            OINOBenchmark._healthBenchmarks.push(name);
+        }
+    }
+    /**
+     * Remove benchmark from being used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static removeHealthBenchmark(module, method) {
+        const name = module + "." + method;
+        const index = OINOBenchmark._healthBenchmarks.indexOf(name);
+        if (index !== -1) {
+            OINOBenchmark._healthBenchmarks.splice(index, 1);
+        }
+    }
+    /**
+     * Set late ratio threshold for health monitoring. If a request takes this many times longer than the average duration, it is considered late and a health failure.
+     * @param lateRatio of health benchmarks, e.g. 2.0 means requests that take 2 times longer than the average
+     */
+    static setHealthLateRatio(lateRatio) {
+        OINOBenchmark._healthLateRatio = lateRatio;
+    }
+    /**
+     * Get service health based on the configured health benchmark.
+     *
+     * @returns service health as 0-1
+     */
+    static getHealth() {
+        return OINOBenchmark._instance ? OINOBenchmark._instance._getHealth() : 1;
+    }
     /**
      * Reset benchmark data (but not what is enabled).
      *
@@ -68,9 +108,10 @@ export class OINOBenchmark {
      *
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    static endMetric(module, method) {
-        OINOBenchmark._instance?._endMetric(module, method);
+    static endMetric(module, method, success = true) {
+        OINOBenchmark._instance?._endMetric(module, method, success);
     }
     /**
      * Get given benchmark data.
@@ -95,11 +136,11 @@ export class OINOBenchmark {
      * @param module of the metric
      * @param method of the metric
      * @param value of the metric
-     *
+     * @param success indicates if the metric was successful
      */
-    static trackMetric(module, method, value) {
+    static trackMetric(module, method, value, success = true) {
         if (OINOBenchmark._enabled[module]) {
-            OINOBenchmark._instance?._trackMetric(module, method, value);
+            OINOBenchmark._instance?._trackMetric(module, method, value, success);
         }
     }
     /**
@@ -133,6 +174,8 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
     _benchmarkCount = {};
     _benchmarkData = {};
     _benchmarkStart = {};
+    _healthBenchmarks = 0;
+    _healthFailures = 0;
     _exceptions = [];
     /**
      * Reset benchmark data (but not what is enabled).
@@ -141,6 +184,8 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
     _reset() {
         this._benchmarkData = {};
         this._benchmarkCount = {};
+        this._healthBenchmarks = 0;
+        this._healthFailures = 0;
     }
     /**
      * Start benchmark timing.
@@ -159,14 +204,15 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
      *
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    _endMetric(module, method) {
+    _endMetric(module, method, success = true) {
         const name = module + "." + method;
         let result = 0;
         if (OINOBenchmark._enabled[module] && (this._benchmarkStart[name] > 0)) { // if benchmark is started, end it
             const duration = performance.now() - this._benchmarkStart[name];
             this._benchmarkStart[name] = 0;
-            this._trackMetric(module, method, duration);
+            this._trackMetric(module, method, duration, success);
         }
         return;
     }
@@ -197,7 +243,7 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
         }
         return result;
     }
-    _trackMetric(module, method, value) {
+    _trackMetric(module, method, value, success = true) {
         const name = module + "." + method;
         if (this._benchmarkCount[name] == undefined) {
             this._benchmarkCount[name] = 1;
@@ -207,6 +253,19 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
             this._benchmarkCount[name] += 1;
             this._benchmarkData[name] += value;
         }
+        if (OINOBenchmark._healthBenchmarks.includes(name)) {
+            // console.log(`Health benchmark ${name}: value=${value.toFixed(2)}ms, average=${(this._benchmarkData[name] / this._benchmarkCount[name]).toFixed(2)}ms, late=${late_ratio>=OINOBenchmark._healthLateRatio}, success=${success}`)
+            this._healthBenchmarks += 1;
+            if (!success) {
+                this._healthFailures += 1;
+            }
+            else if (OINOBenchmark._healthLateRatio > 0) {
+                const late_ratio = value / (this._benchmarkData[name] / this._benchmarkCount[name]);
+                if ((late_ratio > OINOBenchmark._healthLateRatio)) {
+                    this._healthFailures += 1;
+                }
+            }
+        }
     }
     _trackException(module, method, name, message, stack) {
         const exception = { module, method, name, message, stack, timestamp: Date.now() };
@@ -215,4 +274,12 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
     _getExceptions() {
         return this._exceptions;
     }
+    _getHealth() {
+        if ((OINOBenchmark._healthBenchmarks.length == 0) || (this._healthBenchmarks == 0)) {
+            return 1.0;
+        }
+        else {
+            return (this._healthBenchmarks - this._healthFailures) / this._healthBenchmarks;
+        }
+    }
 }

package/dist/types/OINOBenchmark.d.ts

@@ -5,6 +5,8 @@
 export declare abstract class OINOBenchmark {
     protected static _instance: OINOBenchmark;
     protected static _enabled: Record<string, boolean>;
+    protected static _healthBenchmarks: string[];
+    protected static _healthLateRatio: number;
     /**
      * Create a new OINOBenchmark instance.
      *
@@ -23,6 +25,30 @@ export declare abstract class OINOBenchmark {
      *
      */
     static getInstance(): OINOBenchmark;
+    /**
+     * Add benchmark to be used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static addHealthBenchmark(module: string, method: string): void;
+    /**
+     * Remove benchmark from being used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static removeHealthBenchmark(module: string, method: string): void;
+    /**
+     * Set late ratio threshold for health monitoring. If a request takes this many times longer than the average duration, it is considered late and a health failure.
+     * @param lateRatio of health benchmarks, e.g. 2.0 means requests that take 2 times longer than the average
+     */
+    static setHealthLateRatio(lateRatio: number): void;
+    /**
+     * Get service health based on the configured health benchmark.
+     *
+     * @returns service health as 0-1
+     */
+    static getHealth(): number;
+    protected abstract _getHealth(): number;
     protected abstract _reset(): void;
     /**
      * Reset benchmark data (but not what is enabled).
@@ -43,14 +69,15 @@ export declare abstract class OINOBenchmark {
      * @param method of the benchmark
      */
     static startMetric(module: string, method: string): void;
-    protected abstract _endMetric(module: string, method: string): void;
+    protected abstract _endMetric(module: string, method: string, success: boolean): void;
     /**
      * Complete benchmark timing
      *
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    static endMetric(module: string, method: string): void;
+    static endMetric(module: string, method: string, success?: boolean): void;
     protected abstract _getMetric(module: string, method: string): number;
     /**
      * Get given benchmark data.
@@ -66,16 +93,16 @@ export declare abstract class OINOBenchmark {
      *
      */
     static getMetrics(): Record<string, number>;
-    protected abstract _trackMetric(module: string, method: string, value: number): void;
+    protected abstract _trackMetric(module: string, method: string, value: number, success: boolean): void;
     /**
      * Track a metric value
      *
      * @param module of the metric
      * @param method of the metric
      * @param value of the metric
-     *
+     * @param success indicates if the metric was successful
      */
-    static trackMetric(module: string, method: string, value: number): void;
+    static trackMetric(module: string, method: string, value: number, success?: boolean): void;
     protected abstract _trackException(module: string, method: string, name: string, message: string, stack: string): void;
     /**
      * Track an exception
@@ -103,6 +130,8 @@ export declare class OINOMemoryBenchmark extends OINOBenchmark {
     protected _benchmarkCount: Record<string, number>;
     protected _benchmarkData: Record<string, number>;
     protected _benchmarkStart: Record<string, number>;
+    protected _healthBenchmarks: number;
+    protected _healthFailures: number;
     protected _exceptions: any[];
     /**
      * Reset benchmark data (but not what is enabled).
@@ -121,8 +150,9 @@ export declare class OINOMemoryBenchmark extends OINOBenchmark {
      *
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    protected _endMetric(module: string, method: string): void;
+    protected _endMetric(module: string, method: string, success?: boolean): void;
     /**
      * Get given benchmark data.
      *
@@ -136,7 +166,8 @@ export declare class OINOMemoryBenchmark extends OINOBenchmark {
      *
      */
     protected _getMetrics(): Record<string, number>;
-    protected _trackMetric(module: string, method: string, value: number): void;
+    protected _trackMetric(module: string, method: string, value: number, success?: boolean): void;
     protected _trackException(module: string, method: string, name: string, message: string, stack: string): void;
     protected _getExceptions(): any[];
+    protected _getHealth(): number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/common",
-  "version": "0.20.2",
+  "version": "0.21.0",
   "description": "OINO TS package for common classes.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -19,7 +19,7 @@
   "dependencies": {
   },
   "devDependencies": {
-    "@oino-ts/types": "0.20.2",
+    "@oino-ts/types": "0.21.0",
     "@types/node": "^22.0.0",
     "typescript": "~5.9.0"
   },

package/src/OINOBenchmark.ts

@@ -12,6 +12,8 @@ export abstract class OINOBenchmark {
 
     protected static _instance:OINOBenchmark
     protected static _enabled:Record<string, boolean> = {}
+    protected static _healthBenchmarks: string[] = []
+    protected static _healthLateRatio: number = 0
 
     /**
      * Create a new OINOBenchmark instance.
@@ -42,6 +44,50 @@ export abstract class OINOBenchmark {
         return OINOBenchmark._instance
     }
 
+    /**
+     * Add benchmark to be used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static addHealthBenchmark(module: string, method: string): void {
+        const name = module + "." + method
+        if (!OINOBenchmark._healthBenchmarks.includes(name)) {
+            OINOBenchmark._healthBenchmarks.push(name)
+        }
+    }
+
+    /**
+     * Remove benchmark from being used for service health monitoring.
+     * @param module of the benchmark
+     * @param method of the benchmark
+     */
+    static removeHealthBenchmark(module: string, method: string): void {
+        const name = module + "." + method
+        const index = OINOBenchmark._healthBenchmarks.indexOf(name)
+        if (index !== -1) {
+            OINOBenchmark._healthBenchmarks.splice(index, 1)
+        }
+    }
+
+    /**
+     * Set late ratio threshold for health monitoring. If a request takes this many times longer than the average duration, it is considered late and a health failure.
+     * @param lateRatio of health benchmarks, e.g. 2.0 means requests that take 2 times longer than the average 
+     */
+    static setHealthLateRatio(lateRatio: number): void {
+        OINOBenchmark._healthLateRatio = lateRatio
+    }
+
+    /**
+     * Get service health based on the configured health benchmark.
+     * 
+     * @returns service health as 0-1
+     */
+    static getHealth(): number {
+        return OINOBenchmark._instance? OINOBenchmark._instance._getHealth() : 1
+    }
+
+    protected abstract _getHealth(): number
+
     protected abstract _reset():void
     /**
      * Reset benchmark data (but not what is enabled).
@@ -74,15 +120,16 @@ export abstract class OINOBenchmark {
         OINOBenchmark._instance?._startMetric(module, method)
     }
 
-    protected abstract _endMetric(module:string, method:string):void
+    protected abstract _endMetric(module:string, method:string, success:boolean):void
     /**
      * Complete benchmark timing
      * 
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    static endMetric(module:string, method:string):void {
-        OINOBenchmark._instance?._endMetric(module, method)
+    static endMetric(module:string, method:string, success:boolean = true):void {
+        OINOBenchmark._instance?._endMetric(module, method, success)
     }
 
     protected abstract _getMetric(module:string, method:string):number
@@ -106,18 +153,18 @@ export abstract class OINOBenchmark {
         return OINOBenchmark._instance?._getMetrics()
     }
 
-    protected abstract _trackMetric(module:string, method:string, value:number):void
+    protected abstract _trackMetric(module:string, method:string, value:number, success:boolean):void
     /**
      * Track a metric value
      * 
      * @param module of the metric
      * @param method of the metric
      * @param value of the metric
-     * 
+     * @param success indicates if the metric was successful
      */
-    static trackMetric(module:string, method:string, value:number):void {
+    static trackMetric(module:string, method:string, value:number, success:boolean = true):void {
         if (OINOBenchmark._enabled[module]) {
-            OINOBenchmark._instance?._trackMetric(module, method, value)
+            OINOBenchmark._instance?._trackMetric(module, method, value, success)
         }
     }
 
@@ -157,6 +204,8 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
     protected _benchmarkCount:Record<string, number> = {}
     protected _benchmarkData:Record<string, number> = {}
     protected _benchmarkStart:Record<string, number> = {}
+    protected _healthBenchmarks: number = 0
+    protected _healthFailures: number = 0
 
     protected _exceptions:any[] = []
 
@@ -167,6 +216,8 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
     protected _reset():void {
         this._benchmarkData = {}
         this._benchmarkCount = {}
+        this._healthBenchmarks = 0
+        this._healthFailures = 0
     }
 
     /**
@@ -187,14 +238,15 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
      * 
      * @param module of the benchmark
      * @param method of the benchmark
+     * @param success indicates if the benchmark was successful
      */
-    protected _endMetric(module:string, method:string):void {
+    protected _endMetric(module:string, method:string, success:boolean = true):void {
         const name:string = module + "." + method
         let result:number = 0
         if (OINOBenchmark._enabled[module] && (this._benchmarkStart[name] > 0)) { // if benchmark is started, end it
             const duration = performance.now() - this._benchmarkStart[name]
             this._benchmarkStart[name] = 0 
-            this._trackMetric(module, method, duration)
+            this._trackMetric(module, method, duration, success)
         }
         return
     }
@@ -228,7 +280,7 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
         return result
     }
 
-    protected _trackMetric(module:string, method:string, value:number):void {
+    protected _trackMetric(module:string, method:string, value:number, success:boolean = true):void {
         const name:string = module + "." + method
         if (this._benchmarkCount[name] == undefined) {
             this._benchmarkCount[name] = 1
@@ -237,6 +289,19 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
             this._benchmarkCount[name] += 1
             this._benchmarkData[name] += value
         }
+        if (OINOBenchmark._healthBenchmarks.includes(name)) {
+            // console.log(`Health benchmark ${name}: value=${value.toFixed(2)}ms, average=${(this._benchmarkData[name] / this._benchmarkCount[name]).toFixed(2)}ms, late=${late_ratio>=OINOBenchmark._healthLateRatio}, success=${success}`)
+            this._healthBenchmarks += 1
+            if (!success) {
+                this._healthFailures += 1
+
+            } else if (OINOBenchmark._healthLateRatio > 0) {
+                const late_ratio = value / (this._benchmarkData[name] / this._benchmarkCount[name])
+                if ((late_ratio > OINOBenchmark._healthLateRatio)) {
+                    this._healthFailures += 1
+                }
+            }
+        }
     }
 
     protected _trackException(module:string, method:string, name:string, message:string, stack:string):void {
@@ -247,4 +312,13 @@ export class OINOMemoryBenchmark extends OINOBenchmark {
     protected _getExceptions():any[] {
         return this._exceptions
     }
+
+    protected _getHealth(): number {
+        if ((OINOBenchmark._healthBenchmarks.length == 0) || (this._healthBenchmarks == 0))     {
+            return 1.0
+
+        } else {
+            return (this._healthBenchmarks - this._healthFailures) / this._healthBenchmarks
+        }
+    }
 }