@emartech/aggregate-metric-logger 1.0.1 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emartech/aggregate-metric-logger",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "aggregate metrics in memory for logging",
   "main": "src/index.js",
   "scripts": {
@@ -32,8 +32,7 @@
     "@emartech/json-logger": "^3.1.0",
     "date-fns": "^2.3.0",
     "json-stable-stringify": "^1.0.1",
-    "lodash": "^4.17.15",
-    "uuid": "8.3.2"
+    "lodash": "^4.17.15"
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "9.1.1",

package/src/metric-logger.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const { v4: uuid } = require('uuid');
 const loggerFactory = require('@emartech/json-logger');
 const { getSeconds, startOfMinute, addSeconds } = require('date-fns');
 const { omit, pick, fromPairs, toPairs } = require('lodash');
@@ -9,22 +8,16 @@ const util = require('util');
 
 module.exports = ({
   enabled = true,
-  namespace = 'aggregate-metric-logger',
-  inProgressMeasurementWarningLimit = 10000
+  namespace = 'aggregate-metric-logger'
 } = {}) => {
   const logger = loggerFactory(namespace);
 
   const thresholdsByTag = {};
-  let measurements = {};
   let metrics = {};
   let initialized = false;
 
   const flush = () => {
     logMetrics();
-    const inProgressMeasurementCount = Object.keys(measurements).length;
-    if (inProgressMeasurementCount > inProgressMeasurementWarningLimit) {
-      logger.warn('too-many-in-progress-metric-log-measurements', { count: inProgressMeasurementCount });
-    }
     metrics = {};
     setupNextFlush();
   };
@@ -124,22 +117,13 @@ module.exports = ({
       addMeasurement({ method: 'fatal', tag, params, value: 1, countOnly: true });
     },
     start(tag, params = {}) {
-      const id = uuid();
-      measurements[id] = { tag, params, start: Date.now() };
-      return id;
+      return { tag, params, start: Date.now() };
     },
-    stop(measurementId) {
-      const measurement = measurements[measurementId];
-      if (!measurement) return;
-
+    stop(measurement) {
       addMeasurement({
         ...pick(measurement, ['tag', 'params']),
         value: Date.now() - measurement.start
       });
-      delete measurements[measurementId];
-    },
-    cancel(measurementId) {
-      delete measurements[measurementId];
     }
   };
 };

package/src/metric-logger.spec.js

@@ -15,7 +15,7 @@ beforeEach(() => {
 afterEach(() => clock.uninstall());
 
 describe('metricLogger', () => {
-  describe('measure', () => {
+  describe('#measure', () => {
     it('should log a single measurement at the next flush period', () => {
       metricLogger.measure('elfogyasztot-tap', 4);
 
@@ -124,6 +124,17 @@ describe('metricLogger', () => {
     });
   });
 
+  describe('#start', () => {
+    it('should return a measurement object with the given tag, params and start time', () => {
+      const fakeCurrentTimestamp = 2323434543;
+      clock.setSystemTime(fakeCurrentTimestamp);
+
+      const measurement = metricLogger.start('test-tag', { foo: 'bar' });
+
+      expect(measurement).toEqual({ tag: 'test-tag', params: { foo: 'bar' }, start: fakeCurrentTimestamp });
+    });
+  });
+
   describe('start/stop', () => {
     it('should log min, max, count and sum when log was called only once', () => {
       const measurementId = metricLogger.start('utlegeles');
@@ -142,12 +153,12 @@ describe('metricLogger', () => {
     });
 
     it('should aggregate metrics for two measurements and log after a timeout', () => {
-      const measurement1Id = metricLogger.start('utlegeles');
-      const measurement2Id = metricLogger.start('utlegeles');
+      const measurement1 = metricLogger.start('utlegeles');
+      const measurement2 = metricLogger.start('utlegeles');
       clock.tick(50);
-      metricLogger.stop(measurement1Id);
+      metricLogger.stop(measurement1);
       clock.tick(20);
-      metricLogger.stop(measurement2Id);
+      metricLogger.stop(measurement2);
 
       clock.tick(60 * 1000);
       expect(Logger.prototype.info).toBeCalledWith('utlegeles', {
@@ -160,24 +171,9 @@ describe('metricLogger', () => {
       });
     });
 
-    it('should not count a measurment if it is cancelled with cancel', () => {
-      const measurement1Id = metricLogger.start('utlegeles');
-      const measurement2Id = metricLogger.start('utlegeles');
-      clock.tick(50);
-      metricLogger.stop(measurement1Id);
-      clock.tick(20);
-      metricLogger.cancel(measurement2Id);
-      metricLogger.stop(measurement2Id);
-
-      clock.tick(60 * 1000);
-      expect(Logger.prototype.info).toBeCalledWith('utlegeles', expect.objectContaining({
-        count: 1
-      }));
-    });
-
     it('should flush results at the closes minute:30', () => {
-      const measurementId = metricLogger.start('utlegeles');
-      metricLogger.stop(measurementId);
+      const measurement = metricLogger.start('utlegeles');
+      metricLogger.stop(measurement);
 
       clock.tick(29 * 1000 + 999);
       expect(Logger.prototype.info).not.toBeCalled();
@@ -187,8 +183,8 @@ describe('metricLogger', () => {
 
     it('should flush at next minute:30 if we are after 30 in current minute', () => {
       clock.tick(45 * 1000);
-      const measurementId = metricLogger.start('utlegeles');
-      metricLogger.stop(measurementId);
+      const measurement = metricLogger.start('utlegeles');
+      metricLogger.stop(measurement);
 
       clock.tick(44 * 1000);
       expect(Logger.prototype.info).not.toBeCalled();
@@ -253,18 +249,6 @@ describe('metricLogger', () => {
         is_metric: true
       });
     });
-
-    it('should log warning if there are too many measurements in progress', () => {
-      jest.spyOn(Logger.prototype, 'warn');
-      const metricLogger = metricLoggerFactory({ inProgressMeasurementWarningLimit: 1 });
-
-      metricLogger.measure('kacsa');
-      metricLogger.start('nyavogas');
-      metricLogger.start('nyavogas');
-      clock.tick(60 * 1000);
-
-      expect(Logger.prototype.warn).toBeCalledWith('too-many-in-progress-metric-log-measurements', { count: 2 });
-    });
   });
 
   describe('simple count one log methods', () => {