Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clinicjs/node-clinic-doctor
Programmable interface to `clinic doctor`
https://github.com/clinicjs/node-clinic-doctor
Last synced: 2 days ago
JSON representation
Programmable interface to `clinic doctor`
- Host: GitHub
- URL: https://github.com/clinicjs/node-clinic-doctor
- Owner: clinicjs
- License: mit
- Created: 2017-10-12T09:15:39.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-06-27T20:59:26.000Z (over 1 year ago)
- Last Synced: 2025-01-11T19:06:31.639Z (9 days ago)
- Language: JavaScript
- Homepage: https://clinicjs.org
- Size: 15.3 MB
- Stars: 364
- Watchers: 25
- Forks: 50
- Open Issues: 8
-
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 Doctor
[](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] Doctor. 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 `doctor` label.
## Installation
```console
npm i -S @clinic/doctor
```
## Supported node versions
* Node.js 16 and above
## Example
```js
const ClinicDoctor = require('@clinic/doctor')
const doctor = new ClinicDoctor()
doctor.collect(['node', './path-to-script.js'], function (err, filepath) {
if (err) throw err
doctor.visualize(filepath, filepath + '.html', function (err) {
if (err) throw err
});
})
```
You can find examples in
[node-clinic-doctor-examples](https://github.com/clinicjs/node-clinic-doctor-examples)
## Documentation
```js
const ClinicDoctor = require('@clinic/doctor')
const doctor = new ClinicDoctor()
```
### new ClinicDoctor([settings])
* settings [``][]
* sampleInterval [``][] Time between each sample in milliseconds.
**Default**: 10
* detectPort [``][] **Default**: false
* dest [``][] The folder where the collected data is stored. **Default**: '.'
* debug [``][] If set to true, the generated html will not be minified.
**Default**: false
* collectDelay [``][] **Default**: 0
#### `doctor.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.
#### `doctor.visualize(dataFilename, outputFilename, callback)`
Will consume the datafile specified by `dataFilename`, this datafile will be
produced by the sampler using `doctor.collect`.
`doctor.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/doctor.svg?style=flat-square
[npm-url]: https://www.npmjs.org/@clinic/doctor
[npm-downloads]: http://img.shields.io/npm/dm/@clinic/doctor.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/Data_structures#Number_type
[``]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
[actions-status]: https://github.com/clinicjs/node-clinic-doctor/workflows/CI/badge.svg
[actions-url]: https://github.com/clinicjs/node-clinic-doctor/actions