@hkube/metrics 1.0.41 → 1.0.43

package/lib/counter.js

@@ -24,6 +24,16 @@ class CounterMeasure {
     remove() {
         client.register.removeSingleMetric(this._name + COUNTER_POSTFIX);
     }
+    removeEntriesByLabel(labelName, labelValue) {
+        const keysToDelete = [];
+        const hashKeys = Object.keys(this._requestCounter.hashMap);
+        hashKeys.forEach((key) => {
+            if (this._requestCounter.hashMap[key].labels[labelName] === labelValue) {
+                keysToDelete.push(key);
+            }
+        });
+        keysToDelete.forEach(key => delete this._requestCounter.hashMap[key]);
+    }
 }
 
 module.exports = CounterMeasure;

package/lib/gauge.js

@@ -36,6 +36,16 @@ class GaugeMeasure {
     remove() {
         client.register.removeSingleMetric(this._name + GAUGE_POSTFIX);
     }
+    removeEntriesByLabel(labelName, labelValue) {
+        const keysToDelete = [];
+        const hashKeys = Object.keys(this._requestGauge.hashMap);
+        hashKeys.forEach((key) => {
+            if (this._requestGauge.hashMap[key].labels[labelName] === labelValue) {
+                keysToDelete.push(key);
+            }
+        });
+        keysToDelete.forEach(key => delete this._requestGauge.hashMap[key]);
+    }
 }
 
 module.exports = GaugeMeasure;

package/lib/metrics.js

@@ -1,14 +1,15 @@
-const optional = require('optional');
-const djsv = require('djsv');
 const { initSchema } = require('./schema');
 const client = require('prom-client');
+const validator = require('./validator');
 const TimeMeasure = require('./timeMeasure');
 const Summary = require('./summary');
 const CounterMeasure = require('./counter');
 const GaugeMeasure = require('./gauge');
 const { addTimeMeasureSchema, addCounterMeasureSchema, addTimeMeasureSummarySchema } = require('./schema');
 const router = require('./router');
-const RestServer = optional('@hkube/rest-server');
+const RestServer = require('@hkube/rest-server');
+const promUtils = require('prom-client/lib/util.js');
+
 const {
     beforeRoutesMiddlewares,
     afterRoutesMiddlewares,
@@ -16,6 +17,7 @@ const {
     resetMeasureForMiddleware
 } = require('./middleware');
 
+
 class Metrics {
     constructor() {
         this._metrics = new Map();
@@ -23,19 +25,12 @@ class Metrics {
     }
 
     async init(options) {
-        this._prefix = (options && options.prefix) || ''
+        this._prefix = (options && options.prefix) || '';
         client.register.clear();
         this._metrics.clear();
         resetMeasureForMiddleware(this);
-        options = options || {};
-        const validator = djsv(initSchema);
-        const validatadOptions = validator(options);
-        if (validatadOptions.valid) {
-            this._options = validatadOptions.instance;
-        }
-        else {
-            throw new Error(validatadOptions.error);
-        }
+        this._options = options || {};
+        validator.validate(initSchema, this._options);
 
         if (this._options.collectDefault) {
             const { collectDefaultMetrics } = client;
@@ -49,9 +44,11 @@ class Metrics {
             });
         }
     }
+
     getRouter() {
         return { route: this._options.server.path, router: router(this) };
     }
+
     getMiddleware() {
         createMeasureForMiddleware(this);
         return {
@@ -59,6 +56,7 @@ class Metrics {
             afterRoutesMiddlewares: [afterRoutesMiddlewares([this._options.server.path])]
         };
     }
+
     metrics() {
         return client.register.metrics();
     }
@@ -77,15 +75,8 @@ class Metrics {
      */
     addTimeMeasure(options) {
         options = options || {};
-        const validator = djsv(addTimeMeasureSchema);
-        const validatadOptions = validator(options);
-        if (validatadOptions.valid) {
-            options = validatadOptions.instance;
-        }
-        else {
-            throw new Error(validatadOptions.error);
-        }
-        options.name = this.prefix + (options.name || '');
+        validator.validate(addTimeMeasureSchema, options);
+        options.name = this.prefix + options.name;
         if (this._metrics.has(options.name)) {
             throw new Error(`the measure ${options.name} is already registered`);
         }
@@ -93,6 +84,7 @@ class Metrics {
         this._metrics.set(options.name, measure);
         return measure;
     }
+
     /**
     * 
     * @param {Object} options 
@@ -104,15 +96,8 @@ class Metrics {
     */
     addSummary(options) {
         options = options || {};
-        const validator = djsv(addTimeMeasureSummarySchema);
-        const validatadOptions = validator(options);
-        if (validatadOptions.valid) {
-            options = validatadOptions.instance;
-        }
-        else {
-            throw new Error(validatadOptions.error);
-        }
-        options.name = this.prefix + (options.name || '');
+        validator.validate(addTimeMeasureSummarySchema, options);
+        options.name = this.prefix + options.name;
         if (this._metrics.has(options.name)) {
             throw new Error(`the summary ${options.name} is already registered`);
         }
@@ -130,15 +115,8 @@ class Metrics {
      */
     addCounterMeasure(options) {
         options = options || {};
-        const validator = djsv(addCounterMeasureSchema);
-        const validatadOptions = validator(options);
-        if (validatadOptions.valid) {
-            options = validatadOptions.instance;
-        }
-        else {
-            throw new Error(validatadOptions.error);
-        }
-        options.name = this.prefix + (options.name || '');
+        validator.validate(addCounterMeasureSchema, options);
+        options.name = this.prefix + options.name;
         if (this._metrics.has(options.name)) {
             throw new Error(`the measure ${options.name} is already registered`);
         }
@@ -146,6 +124,7 @@ class Metrics {
         this._metrics.set(options.name, measure);
         return measure;
     }
+
     /**
      * 
      * @param {Object} options 
@@ -156,15 +135,8 @@ class Metrics {
      */
     addGaugeMeasure(options) {
         options = options || {};
-        const validator = djsv(addCounterMeasureSchema);
-        const validatadOptions = validator(options);
-        if (validatadOptions.valid) {
-            options = validatadOptions.instance;
-        }
-        else {
-            throw new Error(validatadOptions.error);
-        }
-        options.name = this.prefix + (options.name || '');
+        validator.validate(addCounterMeasureSchema, options);
+        options.name = this.prefix + options.name;
         if (this._metrics.has(options.name)) {
             throw new Error(`the measure ${options.name} is already registered`);
         }
@@ -172,7 +144,7 @@ class Metrics {
         this._metrics.set(options.name, measure);
         return measure;
     }
-    
+
     /**
      * get metric by name
      * @param name metric name, without prefix
@@ -196,6 +168,23 @@ class Metrics {
             this._metrics.delete(this.prefix + name);
         }
     }
+
+    /**
+     * remove all entries in the specified metrics, that are assosiated with the specified jobId
+     * @param {*} options
+     * @param {string} options.labelName
+     * @param {string} options.labelValue
+     * @param {string[]} options.metricsToRemove array of metric names to remove
+     */
+    removeMeasureEntries(options) {
+        const { labelName, labelValue, metricsToRemove } = options;
+        metricsToRemove.forEach((metricName) => {
+            const measureInstance = this.get(metricName);
+            if (measureInstance) {
+                measureInstance.removeEntriesByLabel(labelName, labelValue);
+            }
+        });
+    }   
 }
 
 module.exports = new Metrics();

package/lib/router.js

@@ -1,5 +1,5 @@
-const optional = require('optional');
-const express = optional('express');
+const express = require('express');
+
 const metricsRoute = (metrics) => {
     const router = express.Router();
     router.get('/', (req, res, next) => {

package/lib/schema.js

@@ -26,7 +26,8 @@ const addCounterMeasureSchema = {
     type: 'object',
     properties: {
         name: {
-            type: 'string'
+            type: 'string',
+            minLength: 1
         },
         description: {
             type: 'string'
@@ -46,7 +47,8 @@ const addTimeMeasureSchema = {
     type: 'object',
     properties: {
         name: {
-            type: 'string'
+            type: 'string',
+            minLength: 1
         },
         description: {
             type: 'string'
@@ -74,7 +76,8 @@ const addTimeMeasureSummarySchema = {
     type: 'object',
     properties: {
         name: {
-            type: 'string'
+            type: 'string',
+            minLength: 1
         },
         description: {
             type: 'string'

package/lib/timeMeasure.js

@@ -1,6 +1,6 @@
 const client = require('prom-client');
 const uuid = require('uuid/v4');
-const HISTORGRAM_POSTFIX = '_histogram';
+const HISTOGRAM_POSTFIX = '_histogram';
 const COUNTER_POSTFIX = '_counter';
 class TimeMeasure {
     /**
@@ -9,13 +9,13 @@ class TimeMeasure {
      * @param {string} options.name The name of the measure. Must be unique
      * @param {string} options.description The description of the measure. If not specified, the name is used
      * @param {string[]} [options.labels] array of label names
-     * @param {number[]} [options.buckets] array of historgram buckets. in not defined, the defualt is used
+     * @param {number[]} [options.buckets] array of histogram buckets. in not defined, the default is used
      */
     constructor(options) {
         this._name = options.name;
         this._startedMeasures = new Map();
         this._histogram = new client.Histogram({
-            name: options.name + HISTORGRAM_POSTFIX,
+            name: options.name + HISTOGRAM_POSTFIX,
             help: options.description || options.name,
             labelNames: options.labels,
             buckets: options.buckets
@@ -72,7 +72,7 @@ class TimeMeasure {
     }
 
     remove() {
-        client.register.removeSingleMetric(this._name + HISTORGRAM_POSTFIX);
+        client.register.removeSingleMetric(this._name + HISTOGRAM_POSTFIX);
         client.register.removeSingleMetric(this._name + COUNTER_POSTFIX);
     }
 }

package/lib/tracer.js

@@ -1,6 +1,6 @@
 const { initTracer } = require('jaeger-client');
 const opentracing = require('opentracing');
-const djsv = require('djsv');
+const validator = require('./validator');
 const uuid = require('uuid/v4');
 const { tracerSchema, startSpanSchema, parentRelationships } = require('./schema');
 
@@ -12,27 +12,13 @@ class Tracer {
         options = options || {};
         const tracerConfig = options.tracerConfig || {};
         const tracerOptions = options.tracerOptions || {};
-        const validator = djsv(tracerSchema);
-        const validatadOptions = validator(tracerConfig);
-        if (validatadOptions.valid) {
-            this._options = validatadOptions.instance;
-        }
-        else {
-            throw new Error(validatadOptions.error);
-        }
+        validator.validate(tracerSchema, tracerConfig);
         this._tracer = initTracer(tracerConfig, tracerOptions);
     }
 
     startSpan(options) {
         options = options || {};
-        const validator = djsv(startSpanSchema);
-        const validatadOptions = validator(options);
-        if (validatadOptions.valid) {
-            options = validatadOptions.instance;
-        }
-        else {
-            throw new Error(validatadOptions.error);
-        }
+        validator.validate(startSpanSchema, options);
         const id = options.id || uuid();
         const spanOptions = {};
         let parentContext;

package/lib/validator.js

@@ -0,0 +1,16 @@
+const Ajv = require('ajv');
+const validator = new Ajv({ useDefaults: true });
+
+class Validator {
+    validate(schema, options) {
+        const valid = validator.validate(schema, options);
+
+        if (!valid) {
+            const { errors } = validator;
+            const error = validator.errorsText(errors);
+            throw new Error(error);
+        }
+    }
+}
+
+module.exports = new Validator();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hkube/metrics",
-  "version": "1.0.41",
+  "version": "1.0.43",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -9,18 +9,18 @@
     "build": "npm publish"
   },
   "keywords": [],
-  "author": "",
+  "author": "Hkube",
   "license": "ISC",
   "dependencies": {
-    "djsv": "^3.0.3",
+    "@hkube/rest-server": "^1.0.16",
+    "ajv": "^6.12.0",
+    "express": "^4.16.0",
     "jaeger-client": "^3.7.0",
     "opentracing": "^0.14.1",
-    "optional": "^0.1.4",
     "prom-client": "^10.2.2",
     "uuid": "^3.1.0"
   },
   "devDependencies": {
-    "@hkube/rest-server": "^1.0.4",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "coveralls": "^3.0.0",
@@ -32,9 +32,5 @@
     "istanbul": "^1.1.0-alpha.1",
     "mocha": "^4.0.1",
     "node-mocks-http": "^1.6.6"
-  },
-  "peerDependencies": {
-    "@hkube/rest-server": "^1.0.3",
-    "express": "^4.16.0"
   }
 }

package/test/counterTest.js

@@ -1,4 +1,4 @@
-const {metrics} = require('../index');
+const { metrics } = require('../index');
 const chai = require('chai');
 const { expect } = chai;
 const chaiAsPromised = require('chai-as-promised');
@@ -111,10 +111,10 @@ describe('Counter Measure', () => {
             name: 'm1',
             labels: ['l1', 'l2']
         });
-        measure.inc({labelValues: { l1: 'l1Val' }});
-        measure.inc({labelValues: { l1: 'l1Val' }});
+        measure.inc({ labelValues: { l1: 'l1Val' } });
+        measure.inc({ labelValues: { l1: 'l1Val' } });
         expect(client.register.metrics()).to.include('m1_counter{l1="l1Val"} 2');
-        measure.inc({labelValues: { l1: 'l1Val2' }});
+        measure.inc({ labelValues: { l1: 'l1Val2' } });
         expect(client.register.metrics()).to.include('m1_counter{l1="l1Val2"} 1');
     });
 });

package/test/test.js

@@ -31,6 +31,10 @@ describe('Init metrics', () => {
         await metrics.init();
         expect(() => metrics.addTimeMeasure({})).to.throw("data should have required property 'name'");
     });
+    it('Should throw with empty name', async () => {
+        await metrics.init();
+        expect(() => metrics.addTimeMeasure({name: ''})).to.throw('data.name should NOT be shorter than 1 characters');
+    });
     it('Should throw if no options', async () => {
         await metrics.init();
         expect(() => metrics.addTimeMeasure()).to.throw("data should have required property 'name'");