metricsHelper

Importing this module automatically starts collecting default Node.js metrics (event loop, GC, heap, etc.) via prom-client.collectDefaultMetrics().

Example

import { Prometheus, APIRequestDuration, HTTPRequestDuration, EventCounter } from '@mimik/metrics-helper';
// or
import metricsHelper from '@mimik/metrics-helper';

• metricsHelper
  • ~register
  • ~APIRequestDuration
  • ~HTTPRequestDuration
  • ~EventCounter
  • sync
    • ~Prometheus()

metricsHelper~register

Register to accumulate all the results

Kind: inner constant of metricsHelper

metricsHelper~APIRequestDuration

Histogram metrics for API calls. The buckets are [5, 10, 20, 60, 150, 400, 1000] in ms.

Kind: inner constant of metricsHelper

metricsHelper~HTTPRequestDuration

Histogram metrics for HTTP requests. The buckets are [50, 150, 300, 600, 1200, 2000, 2800, 3600] in ms.

Kind: inner constant of metricsHelper

metricsHelper~EventCounter

Counter for the events sent to the topic associated with the process.

Kind: inner constant of metricsHelper

metricsHelper~Prometheus()

The prom-client module. Use to create custom metrics (e.g. new Prometheus.Gauge(...)).

Kind: inner method of metricsHelper
Category: sync