https://github.com/vicanso/performance-nodejs
get nodejs performance, such as: heap statistics, event loop delay
https://github.com/vicanso/performance-nodejs
cpu-usage heap-statistics memory-usage nodejs-performance performance
Last synced: about 1 month ago
JSON representation
get nodejs performance, such as: heap statistics, event loop delay
- Host: GitHub
- URL: https://github.com/vicanso/performance-nodejs
- Owner: vicanso
- License: mit
- Created: 2016-03-23T12:26:49.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-28T14:10:41.000Z (almost 8 years ago)
- Last Synced: 2025-04-02T05:04:54.272Z (about 2 months ago)
- Topics: cpu-usage, heap-statistics, memory-usage, nodejs-performance, performance
- Language: JavaScript
- Homepage:
- Size: 52.7 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
# performance-nodejs
[](https://travis-ci.org/vicanso/performance-nodejs)
[](https://coveralls.io/r/vicanso/performance-nodejs?branch=master)
[](https://www.npmjs.org/package/performance-nodejs)
[](https://github.com/vicanso/performance-nodejs)
Get nodejs performance, such as: heap statistics, event loop delay
## Installation
```
$ npm i performance-nodejs
```
## Examples
View the [./examples](examples) directory for working examples.
## Description
The `performance()` function get node.js performance (include event loop, heap statistics and heap space statistics).
* If node.js support v8.getHeapSpaceStatistics(), the heap space will be return.
```
const timer = performance(fn, interval);
```
* fn: The callback function to execute.
* interval: Check interval, defaulted to 100ms.
* unit: Set the heap format unit, eg: 'B', 'MB', 'GB', '0.0MB' defaulted to 'B'. `0.00MB` means set 2 precision and 'MB' unit.
Returns: A reference to the timer. Useful for clearing the timer.
`cpuUsage` is new in node.js v6.x.
`malloced_memory`, `peak_malloced_memory` and `does_zap_garbage` is new in node.js v7.x
```json
// node.js performance
{
"lag": 0,
"heap": {
"total_heap_size": 6,
"total_heap_size_executable": 4,
"total_physical_size": 6,
"total_available_size": 1423,
"used_heap_size": 4,
"heap_size_limit": 1432,
"malloced_memory": 0,
"peak_malloced_memory": 1,
"does_zap_garbage": 0
},
"heapSpace": {
"new_space": {
"size": 2,
"used_size": 0,
"available_size": 1,
"physical_size": 2
},
"old_space": {
"size": 2,
"used_size": 2,
"available_size": 0,
"physical_size": 2
},
"code_space": {
"size": 2,
"used_size": 1,
"available_size": 0,
"physical_size": 1
},
"map_space": {
"size": 1,
"used_size": 0,
"available_size": 0,
"physical_size": 0
},
"large_object_space": {
"size": 0,
"used_size": 0,
"available_size": 1422,
"physical_size": 0
}
},
"cpuUsage": {
"user": 1344,
"system": 197,
"usedPercent": 0,
"userUsedPercent": 0,
"systemUsedPercent": 0,
"total": 477549
},
"memoryUsage": {
"rss": 23,
"heapTotal": 6,
"heapUsed": 4,
"external": 0
}
}
```
```
performance((data) => {
console.info(JSON.stringify(data));
}, 'MB', 100);
```
### camelCase
Convert the result to camelCase
```js
const performance = require('performance-nodejs');
performance.camelCase = true;
performance((data) => {
// {"lag":4,"heap":{"totalHeapSize":6,"totalHeapSizeExecutable":4,"totalPhysicalSize":5 ...
console.info(JSON.stringify(data));
}, 'MB', 100);
```
### flatten
Flatten the result
```js
const performance = require('performance-nodejs');
performance.camelCase = true;
performance.flatten = true;
performance((data) => {
// {"lag":1,"heapTotalHeapSize":34639872,"heapTotalHeapSizeExecutable":5767168,"heapTotalPhysicalSize": ...
console.info(JSON.stringify(data));
}, 'MB', 100);
```
# License
MIT