E-ipfs-core-lib NPM

e-ipfs-core-lib

A library that collect utils and shared code for e-ipfs ecosystem.

Quickstart

npm i e-ipfs-core-lib

Api

Telemetry

Create a telemetry manager that provide a prometheus valid file format

Create metrics yaml configuration file:

---
component: bitswap-peer
metrics:
  count:
    bitswap-total-connections: BitSwap Total Connections
    s3-request: AWS S3 requests
    dynamo-request: AWS DynamoDB requests
version: 0.1.0
buildDate: "20220307.1423"

import path from 'path'
import { Telemetry, dirname } from 'e-ipfs-core-lib'

const configFile = path.join(dirname(import.meta.url), '../metrics.yml')
const telemetry = new Telemetry({ configFile })
telemetry.increaseCount('bitswap-total-connections', 2)

const result = await telemetry.export()
console.log(result)
telemetry.resetDurations()
telemetry.resetCounters()

Options

configFile: path to yml config file, see Configuration file format

Telemetry instance methods

export: Export the metrics in prometheus format

  # 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

get(name): Get a single metric
getGaugeValue(name): Get the value of the gauge metric
getHistogramValue(name): Get the value (sum) of the histogram metric
resetAll(): Reset all metrics
resetCounters(): Reset count and labelCount metrics
resetDurations(): Reset durations metrics
resetGauges(): Reset gauges 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 - The labels of the metric (eg. 'GET', 404)
- amount: Number (Default 1) - The amount to add to the metric
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 add to the metric
decreaseGauge(category, amount = 1): Increase the gauge for a category
- category: String - The given name of the category
- amount: Number (Default 1) - The amount to add to the metric
setGauge(category, value): Set the gauge for a category
- category: String - The given name of the category
- 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

Configuration file format

Eg. of metrics.yml, to be passed to configFile

---
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

  process:
    elu: 
      name: bitswap-elu
      description: Bitswap Event Loop Utilization
      interval: 500

version: 0.1.0
buildDate: "20220307.1423"