# node-clinic

**Repository Path**: mirrors_davisjam/node-clinic

## Basic Information

- **Project Name**: node-clinic
- **Description**: Clinic diagnoses your Node.js performance issues
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![banner](logo.png)

# node-clinic

[![Greenkeeper badge](https://badges.greenkeeper.io/nearform/node-clinic.svg)](https://greenkeeper.io/)

[![npm version][2]][3] [![build status][4]][5] [![build status][12]][13]
[![downloads][8]][9] [![js-standard-style][10]][11]

## Install

```
npm install -g clinic
```

## Getting started

As a first step, run the <code>clinic doctor</code>:

<code>clinic doctor -- node server.js</code>

Then benchmark your server with <code>wrk</code> or <code>autocannon</code>:

```
wrk http://localhost:3000
autocannon http://localhost:3000
```

If you want to run autocannon or wrk as soon as your server starts listening you can
use the `--on-port` option

``` sh
# $PORT is the port the server is listening on
clinic doctor --on-port 'autocannon http://localhost:$PORT' -- node server.js
```

Finally shut down your server (Ctrl+C). Once the server process has shutdown
<code>clinic doctor</code> will analyse the collected data and detect what type of issue
you are having. Based on the issue type, it will provide a recommendation for
you.

## Supported Node.js versions

Clinic relies heavily on Node.js core instrumentation available in later versions.
Currently the supported Node.js versions are `^9.4.0` and `^8.9.4`.

## Report an issue

If you encounter any issue, feel free to send us an issue report at:

```
https://github.com/nearform/node-clinic/issues
```

When creating an issue, it will be a huge help for us if you upload your
data to the clinic cloud. To do this, use <code>clinic upload</code>:

```
clinic upload 1000.clinic-doctor
```

## More information

For more information use the <code>--help</code> option:

```
clinic doctor --help
clinic upload --help
```

## Flags

```
-h | --help                Display Help
-v | --version             Display Version
```

## License

[Apache 2.0](<https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)>)

[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[1]: https://nodejs.org/api/documentation.html#documentation_stability_index
[2]: https://img.shields.io/npm/v/clinic.svg?style=flat-square
[3]: https://npmjs.org/package/clinic
[4]: https://circleci.com/gh/nearform/node-clinic/tree/master.svg?style=shield&circle-token=898867ce2715cb4b51018bb20c7798c1dd306250
[5]: https://circleci.com/gh/nearform/node-clinic
[6]: https://img.shields.io/codecov/c/github/nearform/node-clinic/master.svg?style=flat-square
[7]: https://codecov.io/github/nearform/node-clinic
[8]: http://img.shields.io/npm/dm/clinic.svg?style=flat-square
[9]: https://www.npmjs.org/package/clinic
[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[11]: https://github.com/feross/standard
[12]: https://ci.appveyor.com/api/projects/status/ex654mc4b3dq3vf4?svg=true
[13]: https://ci.appveyor.com/project/nearForm/node-clinic