https://github.com/carvjs/metrics-process
Telemetry metrics for Node.JS
https://github.com/carvjs/metrics-process
metrics open-telemetry prometheus telemetry
Last synced: 7 months ago
JSON representation
Telemetry metrics for Node.JS
- Host: GitHub
- URL: https://github.com/carvjs/metrics-process
- Owner: carvjs
- License: mit
- Created: 2020-10-21T12:14:31.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-03T08:49:23.000Z (almost 5 years ago)
- Last Synced: 2025-03-17T20:58:58.689Z (7 months ago)
- Topics: metrics, open-telemetry, prometheus, telemetry
- Language: TypeScript
- Homepage:
- Size: 312 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @carv/metrics-process
[Telemetry](https://www.npmjs.com/package/@carv/telemetry) [metrics](https://prometheus.io/) for the Node.JS process.
[](https://github.com/carvjs/metrics-process/blob/main/LICENSE)
[](https://www.npmjs.com/package/@carv/metrics-process)
[](https://nodejs.org/)
[](https://github.com/carvjs/telemetry)
[](https://unpkg.com/browse/@carv/metrics-process/dist/index.d.ts)
[](https://www.kenoxa.com)
## Installation
```sh
npm install @carv/metrics-process
```
## Usage
Register the plugin and if needed pass to it some custom options.
```js
const { Telemetry } = require('@carv/telemetry')
const telemetry = new Telemetry()
// using the defaults
telemetry.use(require('@carv/metrics-process'))
// with custom options
telemetry.use(require('@carv/metrics-process'), { /* ... Options ... */ })
// using only eventLoopDelay metric
telemetry.use(require('@carv/metrics-process').eventLoopDelay)
```
## [API](https://github.com/carvjs/metrics-process/blob/main/docs/README.md)
Each metric is exported as a [@carv/telemetry](https://www.npmjs.com/package/@carv/telemetry) plugin. The [default export](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#metrics) registers all metrics/plugins. The following plugins are available and exported by name:
* [cpuUsage](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#cpuusage): Process CPU time spent in seconds
* [eventLoopDelay](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#eventloopdelay): Approximate event loop delay in seconds
* [eventLoopUtilization](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#eventlooputilization): ELU is similar to CPU utilization, except that it only measures event loop statistics and not CPU usage. It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait)
* [gcDuration](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#gcduration): Garbage collection duration by kind, one of major, minor, incremental or weakcb
* [heapSpace](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#heapspace): Statistics about the V8 heap spaces
* [memoryUsage](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#memoryusage): Memory usage of the Node.js process
* [startTime](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#starttime): Start time of the process since unix epoch in seconds
* [uptime](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#uptime): The number of seconds the current Node.js process has been running
* [version](https://github.com/carvjs/metrics-process/blob/main/docs/README.md#version): Node.js version info
## Contribute
Thanks for being willing to contribute!
**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
We are following the [Conventional Commits](https://www.conventionalcommits.org) convention.
### Develop
- `yarn test`: Run test suite
- `yarn build`: Generate bundles
- `yarn lint`: Lints code
## Sponsors
[](https://www.kenoxa.com) [Kenoxa GmbH](https://www.kenoxa.com)
## License
[MIT](https://github.com/carvjs/metrics-process/blob/main/LICENSE) © [Kenoxa GmbH](https://kenoxa.com)