https://github.com/wallet77/v8-inspector-api
A simple node module to access V8 inspector + some tools to export and read the data.
https://github.com/wallet77/v8-inspector-api
coverage cpu-profiler cpu-profiling inspector memory memory-dump nodejs v8-javascript-engine v8js
Last synced: 6 days ago
JSON representation
A simple node module to access V8 inspector + some tools to export and read the data.
- Host: GitHub
- URL: https://github.com/wallet77/v8-inspector-api
- Owner: wallet77
- License: mit
- Created: 2019-07-05T17:38:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-10T10:38:08.000Z (3 months ago)
- Last Synced: 2025-04-02T03:17:45.832Z (13 days ago)
- Topics: coverage, cpu-profiler, cpu-profiling, inspector, memory, memory-dump, nodejs, v8-javascript-engine, v8js
- Language: JavaScript
- Homepage:
- Size: 1.54 MB
- Stars: 73
- Watchers: 2
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - v8-inspector-api
README
[](https://github.com/wallet77/v8-inspector-api/releases/)
[](https://github.com/wallet77/v8-inspector-api/blob/master/LICENSE)
[](https://github.com/wallet77/v8-inspector-api/actions?query=workflow%3A%22Node.js+CI%22)
[](https://codecov.io/gh/wallet77/v8-inspector-api)
[](https://github.com/wallet77/v8-inspector-api/issues)
[](https://github.com/wallet77/v8-inspector-api/pulls)
[](https://deepscan.io/dashboard#view=project&tid=12061&pid=15020&bid=292505)
[](https://github.com/wallet77/v8-inspector-api)
# Purpose
Simple wrapper around "inspector" module.
Basically it adds :
- promises & async/await syntax
- S3 exporter
# Compatibility
| Version | Supported | Tested |
|:-------------:|:-------------:|:--------------:|
| 20.x | yes | yes |
| 18.x | yes | yes |
| 16.x | yes | yes |
**In order to have all features we recommend to use at least Node.js version 10 or higher.**
# Installation
```console
$ npm install inspector-api --save
```
# Usage
## CPU profiling
```javascript
const Inspector = require('inspector-api')
const inspector = new Inspector()
await inspector.profiler.enable()
await inspector.profiler.start()
// Invoke business logic under measurement here...
// some time later...
await inspector.profiler.stop()
```
## Memory sampling
```javascript
const Inspector = require('inspector-api')
const inspector = new Inspector()
await inspector.heap.enable()
await inspector.heap.startSampling()
// Invoke business logic under measurement here...
// some time later...
await inspector.heap.stopSampling()
```
## Memory snapshot
```javascript
const Inspector = require('inspector-api')
const inspector = new Inspector()
await inspector.heap.takeSnapshot()
```
## Code coverage
```javascript
const Inspector = require('inspector-api')
const inspector = new Inspector()
await inspector.profiler.enable()
await inspector.profiler.startPreciseCoverage({ callCount: true, detailed: true })
const data = await inspector.profiler.takePreciseCoverage()
await inspector.profiler.stopPreciseCoverage()
```
## Use S3 exporter
```javascript
const Inspector = require('inspector-api')
const inspector = new Inspector({
storage: {
type: 's3',
bucket: 'testBucket',
dir: 'inspector'
}
})
await inspector.profiler.enable()
await inspector.profiler.start()
// Invoke business logic under measurement here...
// some time later...
await inspector.profiler.stop()
```
**Warning: it seems that the new AWS SDK leads to unexpected error if you use the takeSnapshot method (you should use memory sampling)**
### Constructor's config
```javascript
new inspector([config])
```
#### config.storage
| Option | description | Default value |
|:-------------:|:------------------------------------------:|:--------------:|
| `type` | Storage type (raw, s3 or fs) | raw |
| `bucket` | S3 bucket's name | none |
| `dir` | Directory where to store the file | none |
If you use fs, the generated data will be store on the disk in your default tmp directory.
You can display it in Node.js with the command `require('os').tmpdir()`
# Test
```console
$ npm test
```
Coverage report can be found in coverage/.