prometheus-plugin-heap-stats
Node.js prometheus client plugin for collecting detailed heap spaces statistics.
Installation
npm i -S prometheus-plugin-heap-stats
Requirements
>=prom-client-4.0.0
npm module (installed as peer dependency). If your project depends on previous version of client this plugin might not work.>=node-6.0.0
because this module heap space stat function introduced in node 6.0.0
Metric list
- Process heap space sizes in bytes
- type: 'Gauge'
- name: 'nodejs_heap_space_size_bytes'
- labels: ['type', 'space']
- type: 'used' | 'total' | 'available'
- space: 'new' | 'old' | 'map' | 'code' | 'large_object'
Usage
Simple
const client = ;const heapPlugin = ; // start metrics collectionheapPluginstart; // log metrics to consoleconsole; // stop metrics collectionheapPlugin; // stop and clear metrics registerheapPlugin;
Override metric defaults
const client = ;const heapPlugin = ;const override = 'metric_name': // provide default metric name to override it's params type: 'Counter' // could be changed, but it's not recommended name: 'my_metric_name' // name could be changed description: 'My custom description' // description could be changed labelValues: // additional labels customLabel: 'hello' // custom labels could be added { return } // if it's a function, it will be called to get label value in runtime ;// start metrics collectionheapPluginstart; // pass override object to init function // log metrics to consoleconsole; // stop metrics collectionheapPlugin; // stop and clear metrics registerheapPlugin;