Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clinicjs/node-clinic-bubbleprof
Programmable interface to `clinic bubbleprof`
https://github.com/clinicjs/node-clinic-bubbleprof
Last synced: 7 days ago
JSON representation
Programmable interface to `clinic bubbleprof`
- Host: GitHub
- URL: https://github.com/clinicjs/node-clinic-bubbleprof
- Owner: clinicjs
- License: mit
- Created: 2017-10-12T11:18:51.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-06-27T21:21:45.000Z (over 1 year ago)
- Last Synced: 2024-12-22T18:08:44.923Z (14 days ago)
- Language: JavaScript
- Homepage: https://clinicjs.org/
- Size: 1.39 MB
- Stars: 95
- Watchers: 17
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Clinic.js Bubbleprof
[](https://greenkeeper.io/)
[![npm version][npm-version]][npm-url] [![Stability Stable][stability-stable]][stability-docs] [![Github Actions build status][actions-status]][actions-url]
[![Downloads][npm-downloads]][npm-url] [![Code style][lint-standard]][lint-standard-url]
Programmable interface to [Clinic.js][clinic-url] Bubbleprof. Learn more about Clinic.js: https://clinicjs.org/
## Issues
To open an issue, please use the [main repository](https://github.com/clinicjs/node-clinic) with the `bubbleprof` label.
## Installation
```console
npm i -S @clinic/bubbleprof
```
## Supported node versions
* Node.js 16 and above
## Example
```js
const ClinicBubbleprof = require('@clinic/bubbleprof')
const bubbleprof = new ClinicBubbleprof()
bubbleprof.collect(['node', './path-to-script.js'], function (err, filepath) {
if (err) throw err
bubbleprof.visualize(filepath, filepath + '.html', function (err) {
if (err) throw err
})
})
```
To get started with Clinic.js Bubbleprof you might want to take a look at the [examples
repo](https://github.com/clinicjs/node-clinic-bubbleprof-examples).
## Documentation
```js
const ClinicBubbleprof = require('@clinic/bubbleprof')
const bubbleprof = new ClinicBubbleprof()
```
### new ClinicBubbleprof([settings])
* settings [``][]
* detectPort [``][] **Default**: false
* debug [``][] If set to true, the generated html will not be minified.
**Default**: false
* dest [``][] The folder where the collected data is stored.
**Default**: '.'
#### `bubbleprof.collect(args, callback)`
Starts a process by using:
```js
const { spawn } = require('child_process')
spawn(args[0], ['-r', 'sampler.js'].concat(args.slice(1)))
```
The injected sampler will produce a file in the current working directory, with
the process `PID` in its filename. The filepath relative to the current working
directory will be the value in the callback.
stdout, stderr, and stdin will be relayed to the calling process. As will the
`SIGINT` event.
#### `bubbleprof.visualize(dataFilename, outputFilename, callback)`
Will consume the data file specified by `dataFilename`, this data file will be
produced by the sampler using `bubbleprof.collect`.
`bubbleprof.visualize` will then output a standalone HTML file to
`outputFilename`. When completed the callback will be called with no extra
arguments, except a possible error.
## License
[MIT](LICENSE)
[stability-stable]: https://img.shields.io/badge/stability-stable-green.svg?style=flat-square
[stability-docs]: https://nodejs.org/api/documentation.html#documentation_stability_index
[npm-version]: https://img.shields.io/npm/v/@clinic/bubbleprof.svg?style=flat-square
[npm-url]: https://www.npmjs.org/@clinic/bubbleprof
[npm-downloads]: http://img.shields.io/npm/dm/@clinic/bubbleprof.svg?style=flat-square
[lint-standard]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[lint-standard-url]: https://github.com/feross/standard
[clinic-url]: https://github.com/clinicjs/node-clinic
[``]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
[``]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type
[``]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
[actions-status]: https://github.com/clinicjs/node-clinic-bubbleprof/workflows/CI/badge.svg
[actions-url]: https://github.com/clinicjs/node-clinic-bubbleprof/actions