@emartech/aggregate-metric-logger 2.0.0 → 2.0.3

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 });
@@ -29,11 +29,11 @@ metricLogger.warn('etwas-went-wrong', { customer_id: 11 });
 
 ### Measure values
 
-If you want aggregate measuremts about something you need to simply call the `measure` method
+If you want aggregate measurements about something you need to simply call the `measure` method
 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)
@@ -44,16 +44,16 @@ for each measured tags. (Uses `@emartech/json-logger` behind the scenes for logg
 
 ### Measuring durations
 
-For duration measuremts, there are two convinience methods: `start`, and `stop`;
+For duration measurements, there are two convenient methods: `start`, and `stop`;
 
 You start the measurement with `start`, the counted value for aggregation will be the duration
-between this `start` and the matcing `stop` call;
+between this `start` and the matching `stop` call;
 
 ```js
 function exampleIOHeavyFunction() {
-  const measurementId = metricLogger.start('tag-for-the-measuement');
+  const measurement = metricLogger.start('tag-for-the-measuement');
   const result = db.findItems();
-  metricLogger.stop(measurementId);
+  metricLogger.stop(measurement);
   return result;
 }
 ```
@@ -61,20 +61,20 @@ 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 measurementId = metricLogger.start(
+const measurement = metricLogger.start(
   'tag-for-the-measuement',
   { event_type: 'nyul', account: 3 }
 );
 ```
 
-A separete log entry will be created for each seen value combinations seen in the extra params
-and these extra params will appended to the log entry.
+A separate log entry will be created for each seen value combinations seen in the extra params
+and these extra params will be appended to the log entry.
 
-Be very carefull when using extra params, and only include information you really need.
-If you include too many parameters, you could loose the advantage you gain by aggregating your logs
+Be very careful when using extra params, and only include information you really need.
+If you include too many parameters, you could lose the advantage you gain by aggregating your logs
 with this package.

package/package.json

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