@emartech/aggregate-metric-logger 2.0.1 → 2.0.4

package/README.md

@@ -4,7 +4,7 @@ aggregate metrics in memory and log them every minute
 ## Setup
 
 Set `METRIC_LOGGER_ENABLED` env variable to `true` for aggregate-metric-logger to
-start collecting and logging measuremnts.
+start collecting and logging measurements.
 
 To change the default `aggregate-metric-logger` namespace used for logs, set
 `METRIC_LOGGER_NAMESPACE` to a custom value.
@@ -19,7 +19,7 @@ an extra `count` property to the logs and log them at the end of the minute with
 `@emartech/json-logger`.
 
 ```js
-const metrictLogger = require('aggregate-metric-logger')
+const metricLogger = require('@emartech/aggregate-metric-logger')
 
 metricLogger.warn('etwas-went-wrong', { customer_id: 11 });
 metricLogger.warn('etwas-went-wrong', { customer_id: 11 });
@@ -33,7 +33,7 @@ If you want aggregate measurements about something you need to simply call the `
 for each value:
 
 ```js
-const metrictLogger = require('aggregate-metric-logger')
+const metricLogger = require('@emartech/aggregate-metric-logger')
 
 metricLogger.measure('thing-to-measure', 14)
 metricLogger.measure('thing-to-measure', 20)
@@ -61,10 +61,10 @@ function exampleIOHeavyFunction() {
 ### Group by extra parameters
 
 If you want to group by additional parameters inside a tag, you can pass down these extra
-params in an object to `count` and `start` as the last optional argument:
+params in an object to `measure` and `start` as the last optional argument:
 
 ```js
-metricLogger.count('thing-to-count', 14, { customer_id: 12 });
+metricLogger.measure('thing-to-count', 14, { customer_id: 12 });
 
 const measurement = metricLogger.start(
   'tag-for-the-measuement',

package/package.json

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

package/src/metric-logger.spec.js

@@ -137,9 +137,9 @@ describe('metricLogger', () => {
 
   describe('start/stop', () => {
     it('should log min, max, count and sum when log was called only once', () => {
-      const measurementId = metricLogger.start('utlegeles');
+      const measurement = metricLogger.start('utlegeles');
       clock.tick(50);
-      metricLogger.stop(measurementId);
+      metricLogger.stop(measurement);
 
       clock.tick(60 * 1000);
       expect(Logger.prototype.info).toBeCalledWith('utlegeles', {