Feat/prom client (#9)

* feat: update telemetry library

* docs: add new telemetry docs

* feat: rename grouped with label

* Update README.md

Co-authored-by: Simone Sanfratello <[email protected]>

Co-authored-by: Simone Sanfratello <[email protected]>

Author: codeflyer

README.md

@@ -37,52 +37,70 @@ const configFile = path.join(dirname(import.meta.url), '../metrics.yml')
 const telemetry = new Telemetry({ configFile })
 telemetry.increaseCount('bitswap-total-connections', 2)
 
-const result = telemetry.export()
+const result = await telemetry.export()
 console.log(result)
+telemetry.resetCount()
 ```
 
 #### Telemetry instance methods
-* clear: Clear the metrics
-* createMetric(category, description, metric, type): Create a new metric
-  * category: String - The given name of the category
-  * description: String - The category description
-  * metric: METRIC_COUNT | METRIC_DURATIONS | METRIC_GROUPED_COUNT - The metric defined
-  * type: null | TYPE_GAUGE - The type of the metric. If not passed the value is defined based on the `metric` attribute. 
 * export: Export the metrics in `prometheus` format
   ```
-    # HELP counter_grouped_count_total COUNTER (grouped-count)
-    # TYPE counter_grouped_count_total counter
-    counter_grouped_count_total{id="123"} 1 now
-    counter_grouped_count_total{id="456"} 2 now
+    # HELP counter_label_count_total COUNTER (label-count)
+    # TYPE counter_label_count_total counter
+    counter_label_count_total{id="123"} 1 now
+    counter_label_count_total{id="456"} 2 now
     ```
+* resetAll(): Reset all metrics
+* resetCounters(): Reset count and labelCount metrics
+* async export(): Export values  in Prometheus format 
 * increaseCount(category, amount = 1): Increase the count for a category
   * category: String - The given name of the category
+* increaseLabelCount(category, labels: Array, amount = 1): Increase the count for a key in a category
+  * category: String - The given name of the category
+  * labels: Array<String> - The labels of the metric (eg. ['GET', 404])
   * amount: Number (Default 1) - The amount to add to the metric
-* decreaseCount(category, amount = 1): Decrease the count for a category
+* increaseGauge(category, amount = 1): Increase the gauge for a category
   * category: String - The given name of the category
-  * amount: Number (Default 1) - The amount to remove from the metric
-* increaseCountWithKey(category, key, amount = 1): Increase the count for a key in a category
+  * amount: Number (Default 1) - The amount to add to the metric
+* decreaseGauge(category, amount = 1): Increase the gauge for a category
   * category: String - The given name of the category
-  * key: String - The key of the metric
   * amount: Number (Default 1) - The amount to add to the metric
-* decreaseCountWithKey(category, key, amount = 1): Decrease the count for a key in a category
+* setGauge(category, value): Set the gauge for a category
   * category: String - The given name of the category
-  * key: String - The key of the metric
-  * amount: Number (Default 1) - The amount to remove from the metric
+  * value: Number - The value to set the metric
 * trackDuration(category, promise): Track the duration of an async call
   * category: String - The given name of the category
   * promise: Promise - The function to be tracked
 
-#### Metrics and types constants
+#### Configuration
 
-The constants below are exported
-
-* METRIC_COUNT
-* METRIC_DURATIONS
-* METRIC_GROUPED_COUNT
-* TYPE_COUNTER
-* TYPE_HISTOGRAM
-* TYPE_GAUGE
+Eg. of `metrics.yml`
+```yaml
+---
+component: bitswap-peer
+metrics:
+  count:
+    s3-request-count:
+      description: AWS S3 requests
+    dynamo-request-count:
+      description: AWS DynamoDB requests
+  labelCount:
+    bitswap-request-per-connections-label-count:
+      description: BitSwap Request Per Connnection
+      labels:
+        - method
+        - status
+  durations:
+    bitswap-connections-duration-durations:
+      description: BitSwap Connnection Duration
+  gauge:
+    bitswap-event-loop-utilization:
+      description: BitSwap Event Loop Utilization
+    bitswap-total-connections:
+      description: BitSwap Total Connections
+version: 0.1.0
+buildDate: "20220307.1423"
+```
 
 ### Utils
 #### dirname

package.json

@@ -1,6 +1,6 @@
 {
   "name": "e-ipfs-core-lib",
-  "version": "0.3.0",
+  "version": "0.4.0-beta-01",
   "description": "E-IPFS core library",
   "license": "(Apache-2.0 AND MIT)",
   "homepage": "https://github.com/elastic-ipfs/core-lib",
@@ -17,12 +17,12 @@
   "dependencies": {
     "@aws-sdk/util-dynamodb": "^3.218.0",
     "bl": "^6.0.0",
-    "hdr-histogram-js": "^3.0.0",
     "js-yaml": "^4.1.0",
     "libp2p": "^0.40.0",
     "pino": "^8.7.0",
     "pino-pretty": "^9.1.1",
     "piscina": "^3.2.0",
+    "prom-client": "^14.1.0",
     "protobufjs": "^7.1.2",
     "sodium-native": "^3.4.1",
     "undici": "^5.13.0",