@emartech/aggregate-metric-logger 3.2.0 → 3.3.1

package/.github/workflows/build.yml

@@ -0,0 +1,73 @@
+name: Aggregate Metric Logger Build
+
+on: push
+
+env:
+  NPM_TOKEN: ${{ secrets.NPM_PUBLISHER_TOKEN }}
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}
+  SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+jobs:
+  test:
+    name: Tests 🚦
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Use correct Node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+      - name: Cache node_modules
+        id: cache_node_modules
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: node_modules-${{ hashFiles('**/package-lock.json') }}
+      - name: Install dependencies
+        if: ${{ steps.cache_node_modules.outputs.cache-hit != 'true' }}
+        continue-on-error: true
+        run: |
+          npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
+          npm i
+      - name: Run tests
+        run: npm test
+      - name: Slack notification
+        uses: 8398a7/action-slack@a189acbf0b7ea434558662ae25a0de71df69a435
+        if: ${{ failure() }}
+        with:
+          status: ${{ job.status }}
+          fields: repo,message,author,job,ref
+          job_name: Test 🚦
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+  deploy:
+    name: Deploy 🚢
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Use correct Node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+      - name: Cache node_modules
+        id: cache_node_modules
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: node_modules-${{ hashFiles('**/package-lock.json') }}
+      - name: Release package
+        if: github.ref_name == 'master'
+        run: CI=true npm run semantic-release
+      - name: Slack notification
+        uses: 8398a7/action-slack@a189acbf0b7ea434558662ae25a0de71df69a435
+        with:
+          status: ${{ job.status }}
+          fields: repo,message,author,job,ref
+          job_name: Deploy 🚢
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+        if: always()

package/README.md

@@ -34,7 +34,7 @@ const metricLogger = require('@emartech/aggregate-metric-logger')
 metricLogger.warn('etwas-went-wrong', { customer_id: 11 });
 metricLogger.warn('etwas-went-wrong', { customer_id: 11 });
 
-// will aggrete these to a single warning log
+// will aggregate these to a single warning log
 ```
 
 ### Measure values

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emartech/aggregate-metric-logger",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "aggregate metrics in memory for logging",
   "main": "src/index.js",
   "scripts": {

package/src/gcp-metric-collector/gcp-metric-collector.js

@@ -16,6 +16,16 @@ exports.count = (metricName, labels = {}, value = 1) =>
 exports.measure = (metricName, labels = {}, value = 1) =>
   addToMetric(metricName, labels, 'distribution', value);
 
+exports.start = (metricName, labels = {}) => ({ metricName, labels, start: Date.now() });
+
+exports.stop = measurement =>
+  addToMetric(
+    measurement.metricName,
+    measurement.labels,
+    'distribution',
+    Date.now() - measurement.start
+  );
+
 const addToMetric = (metricName, labels = {}, type, value) => {
   if (process.env.METRIC_LOGGER_ENABLED !== 'true') return;
 

package/src/gcp-metric-collector/gcp-metric-collector.spec.js

@@ -239,4 +239,45 @@ describe('gcpMetricCollector', () => {
       expect(getPublishedMetrics()).toEqual([]);
     });
   });
+
+  describe('start', () => {
+    it('should return a measurement object with the given tag, params and start time', () => {
+      const fakeCurrentTimestamp = 2323434543;
+      jest.useFakeTimers().setSystemTime(new Date(fakeCurrentTimestamp));
+
+      const measurement = gcpMetricCollector.start('pulyka', { foo: 'bar' });
+
+      expect(measurement).toEqual({
+        metricName: 'pulyka',
+        labels: { foo: 'bar' },
+        start: fakeCurrentTimestamp
+      });
+    });
+  });
+
+  describe('stop', () => {
+    it('should send in time since start as a distribution measurement', () => {
+      jest.useFakeTimers().setSystemTime(new Date(20000));
+      stubCreateTimeSeries();
+
+      const measurement = gcpMetricCollector.start('elephant', { size: 23 });
+      jest.advanceTimersByTime(45);
+
+      gcpMetricCollector.stop(measurement);
+
+      jest.advanceTimersByTime(60 * 1000 + 1);
+      expect(getPublishedMetrics()).toMatchObject([
+        [
+          {
+            value: {
+              distributionValue: {
+                count: 1,
+                mean: 45
+              }
+            }
+          }
+        ]
+      ]);
+    });
+  });
 });

package/src/gcp-time-series-publisher/gcp-time-series-publisher.js

@@ -1,11 +1,11 @@
 'use strict';
 
-const { createLogger } = require('@emartech/json-logger');
+const logger = require('@emartech/json-logger').createLogger('aggregate-metric-logger');
 const monitoring = require('@google-cloud/monitoring');
 const { chunk } = require('lodash');
 const ms = require('ms');
+const { setTimeout } = require('timers/promises');
 
-const logger = createLogger('aggregate-metric-logger');
 const MAX_TIME_SERIES_COUNT = 200;
 
 exports.publishTimeSeries = async timeSeries => {
@@ -24,13 +24,11 @@ const createTimeSeries = async (client, timeSeries) => {
   try {
     await client.createTimeSeries({ name, timeSeries });
   } catch (error) {
-    await sleep(ms('10 sec'));
+    await setTimeout(ms('10 sec'));
     await client.createTimeSeries({ name, timeSeries });
   }
 };
 
-const sleep = async sleepTime => new Promise(resolve => setTimeout(resolve, sleepTime));
-
 let monitoringClientInstance = null;
 const getMonitoringClient = () => {
   if (!monitoringClientInstance) {

package/src/index.js

@@ -21,9 +21,10 @@ exposedFactoryInstanceHybrid.error = exposedInstance.error;
 exposedFactoryInstanceHybrid.fatal = exposedInstance.fatal;
 exposedFactoryInstanceHybrid.start = exposedInstance.start;
 exposedFactoryInstanceHybrid.stop = exposedInstance.stop;
-exposedFactoryInstanceHybrid.cancel = exposedInstance.cancel;
 
 exposedFactoryInstanceHybrid.count = gcpMetricCollector.count;
 exposedFactoryInstanceHybrid.measureGcp = gcpMetricCollector.measure;
+exposedFactoryInstanceHybrid.startGcp = gcpMetricCollector.start;
+exposedFactoryInstanceHybrid.stopGcp = gcpMetricCollector.stop;
 
 module.exports = exposedFactoryInstanceHybrid;