inspector-api

V8 inspector API module

Purpose

Simple wrapper around "inspector" module. Basically it adds :

• promises & async/await syntax
• S3 exporter

Compatibility

/!\ This module use async/await syntax and the inspector module, this is why you must have node 8.0+.

Supported and tested : >= 8.0

Version	Supported	Tested
12.x	yes	yes
10.x	yes	yes
9.x	yes	yes
8.x	yes	yes

**In order to have all features we recommend to use at least Node.js version 10 or higher.

Installation

$ npm install inspector-api --save

Usage

Basic usage

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()

Use S3 exporter

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()

Config

inspector([config])

• storage : an object containing all exporter configuration (for example S3 bucket's name etc)

storage

Option	description	Default value
type	Storage type (raw, s3 or fs)	raw
bucket	S3 bucket's name	0
dir	Directory where to store the file	empty

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

$ npm test

Coverage report can be found in coverage/.