Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 2 months 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 (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-03T16:10:58.000Z (4 months ago)
Last Synced: 2024-11-10T01:43:00.765Z (2 months ago)
Topics: coverage, cpu-profiler, cpu-profiling, inspector, memory, memory-dump, nodejs, v8-javascript-engine, v8js
Language: JavaScript
Homepage:
Size: 1.44 MB
Stars: 69
Watchers: 3
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

        [![GitHub release](https://img.shields.io/npm/v/inspector-api.svg)](https://github.com/wallet77/v8-inspector-api/releases/)

[![GitHub license](https://img.shields.io/github/license/wallet77/v8-inspector-api.svg)](https://github.com/wallet77/v8-inspector-api/blob/master/LICENSE)

[![CI pipeline](https://github.com/wallet77/v8-inspector-api/workflows/Node.js%20CI/badge.svg)](https://github.com/wallet77/v8-inspector-api/actions?query=workflow%3A%22Node.js+CI%22)

[![Code coverage](https://codecov.io/gh/wallet77/v8-inspector-api/branch/master/graph/badge.svg)](https://codecov.io/gh/wallet77/v8-inspector-api)

[![Opened issues](https://img.shields.io/github/issues-raw/wallet77/v8-inspector-api)](https://github.com/wallet77/v8-inspector-api/issues)

[![Opened PR](https://img.shields.io/github/issues-pr-raw/wallet77/v8-inspector-api)](https://github.com/wallet77/v8-inspector-api/pulls)

[![DeepScan grade](https://deepscan.io/api/teams/12061/projects/15020/branches/292505/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=12061&pid=15020&bid=292505)

[![Node version](https://img.shields.io/node/v-lts/inspector-api.svg)](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/.