https://github.com/iopipe/performance-node
Performance for Node.js
https://github.com/iopipe/performance-node
javascript nodejs performance performance-analysis performance-metrics
Last synced: 5 months ago
JSON representation
Performance for Node.js
- Host: GitHub
- URL: https://github.com/iopipe/performance-node
- Owner: iopipe
- License: apache-2.0
- Created: 2017-07-26T17:01:57.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-20T15:03:41.000Z (almost 7 years ago)
- Last Synced: 2024-12-14T14:08:42.133Z (6 months ago)
- Topics: javascript, nodejs, performance, performance-analysis, performance-metrics
- Language: JavaScript
- Size: 118 KB
- Stars: 17
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Performance for Node.js
[](https://circleci.com/gh/iopipe/performance-node/tree/master)
[](https://github.com/prettier/prettier)
[](https://github.com/semantic-release/semantic-release)
A superset of the [User Timing API](https://developer.mozilla.org/en-US/docs/Web/API/User_Timing_API) (`window.performance`) for Node.js
Uses `process.hrtime` to capture marks + measures to gain deeper visibility into the timings that you define in your application.
0 Dependencies!
## Requirements
- Node >= `4.3.2`
- NPM >= `2.14.12`
## Install
With [yarn](https://yarnpkg.com) (recommended) in project directory:
`yarn add performance-node`
With npm in project directory:
`npm install performance-node`
Then, run your application:
```js
const Perf = require('performance-node');
const timeline = new Perf();
timeline.mark('foo-start');
// delay(10)
timeline.mark('foo-end');
timeline.measure('foo-measure', 'foo-start', 'foo-end');
const myMeasure = timeline.getEntriesByName('foo-measure')[0];
// {name: 'foo-measure', startTime: 1.2, duration: 10.5, entryType: 'measure'}
```
## Methods
```js
const Perf = require('performance-node');
const timeline = new Perf();
// set marks
timeline.mark('foo-start');
timeline.mark('foo-end');
// create a measurement
timeline.measure('foo-measure', 'foo-start', 'foo-end');
// get all timeline entries (marks + measures)
timeline.getEntries();
// get all entries with the same name
timeline.getEntriesByName('foo-start');
// get all entries with the same type
timeline.getEntriesByType('measure');
// clear marks
timeline.clearMarks();
// clear measures
timeline.clearMeasures();
// clear all entries
timeline.clear();
// get a point in time in milliseconds
timeline.now();
```
## Config
#### `offset` (number: optional)
By default, the `startTime` of each mark is calculated by subracting the construction time from `process.hrtime`. If you would rather the startTime map as closely as possible to `process.hrtime` values, set `offset: 0`. You can also supply any number as a custom offset.
```js
const Perf = require('performance-node');
const timeline = new Perf({ offset: 0 });
timeline.mark('foo-start');
// delay(10)
timeline.mark('foo-end');
timeline.measure('foo-measure', 'foo-start', 'foo-end');
const myMeasure = timeline.getEntriesByName('foo-measure')[0];
// {name: 'foo-measure', startTime: 227851.91, duration: 10.5, entryType: 'measure'}
```
#### `timestamp` (bool: optional = false)
Add a `timestamp` (unix epoch) value for each mark based on `Date.now()`.
```js
const Perf = require('performance-node');
const timeline = new Perf({ timestamp: true });
timeline.mark('foo-start');
const myMeasure = timeline.getEntriesByName('foo-start')[0];
// {name: 'foo-start', startTime: 1.2, duration: 0, entryType: 'mark', timestamp: 1501189303951}
```
## Contributing
- This project uses [Prettier](https://github.com/prettier/prettier). Please execute `npm run eslint -- --fix` to auto-format the code before submitting pull requests.