# node-process-metrics-prometheus

> retrieve Node.js process metrics in exposition format

Latest version **0.1.0** (published 2018-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-process-metrics-prometheus
pnpm add node-process-metrics-prometheus
yarn add node-process-metrics-prometheus
bun add node-process-metrics-prometheus
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-04-25 |
| First published | 2018-04-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 2 |
| Unpacked size | 9.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Colin J. Ihrig |
| Maintainers | cjihrig |
| Keywords | metrics, prometheus, exposition |

## Links

- npm: https://www.npmjs.com/package/node-process-metrics-prometheus
- Repository: https://github.com/cjihrig/node-process-metrics-prometheus
- Issues: https://github.com/cjihrig/node-process-metrics-prometheus/issues
- npm.io page: https://npm.io/package/node-process-metrics-prometheus

## Dependencies (2)

- [prom-dress](https://npm.io/package/prom-dress.md) 0.0.x
- [node-process-metrics](https://npm.io/package/node-process-metrics.md) 0.1.x

## Recent versions

- 0.1.0 (latest) — 2018-04-25
- 0.0.1 — 2018-04-25

## README

# node-process-metrics-prometheus

[![Current Version](https://img.shields.io/npm/v/node-process-metrics-prometheus.svg)](https://www.npmjs.org/package/node-process-metrics-prometheus)
[![Build Status via Travis CI](https://travis-ci.org/cjihrig/node-process-metrics-prometheus.svg?branch=master)](https://travis-ci.org/cjihrig/node-process-metrics-prometheus)
![Dependencies](http://img.shields.io/david/cjihrig/node-process-metrics-prometheus.svg)
[![belly-button-style](https://img.shields.io/badge/eslint-bellybutton-4B32C3.svg)](https://github.com/cjihrig/belly-button)

Get process, system, memory, CPU, and event loop metrics from a Node.js process in Prometheus text-based exposition format. Can be used synchronously, or as an event emitter.

## Basic Usage

```javascript
'use strict';
const NodeProcessMetrics = require('node-process-metrics');
const NodeProcessMetricsPrometheus = require('node-process-metrics-prometheus');

// Use synchronously
const pm = new NodeProcessMetricsPrometheus();
console.log(pm.metrics());

// Use as an event emitter
const pm = new NodeProcessMetricsPrometheus({
  metrics: new NodeProcessMetrics({ period: 1000 })
});

pm.on('metrics', (metrics) => {
  console.log(metrics);
});
```

## API

`node-process-metrics` exports a single constructor with the following API.

### `NodeProcessEmitter([options])`

  - Arguments
    - `options` (object) - An optional configuration supporting the following options:
      - `metrics` (number) - An instance of `NodeProcessMetrics`. Optional. If not provided, a new instance is constructed.
      - `registries` (array) - An array of `CollectorRegistry` instances. Optional. Defaults to `[PromDress.defaultRegistry]`.

### `'metrics'` Event

The `'metrics'` event has one accompanying argument - a Prometheus exposition string.

---
_Source: https://npm.io/package/node-process-metrics-prometheus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
