prometheus-gc-stats

prometheus-gc-stats

Report Garbage Collection stats using Prometheus

Usage

This module has a peer dependency on prom-client. Currently, version 3-5 are supported.

This module follows the same API as the core default metrics. To start collection GC stats, invoke the exported function to create the metrics, then invoke the returned function to start the collecting.

gc-stats

The module doing the GC stats collecing is gc-stats. This module requires native dependencies. If the stats don't show up, make sure to check npm's install log for failures.

Metrics exposed

This module exposes 3 metrics:

1. nodejs_gc_runs_total: Counts the number of time GC is invoked
2. nodejs_gc_pause_total_nanoseconds: Time spent in GC in nanoseconds
   1. There's an option that can be passed to the function, { seconds: true } which make this be reported in seconds instead
3. nodejs_gc_reclaimed_total_bytes: The number of bytes GC has freed

Credits

Thanks to @tcolgate for the original implementation.