https://github.com/pmuellr/no-pro

Node Profiling bits
https://github.com/pmuellr/no-pro

Last synced: about 1 month ago
JSON representation

Node Profiling bits

• Host: GitHub
• URL: https://github.com/pmuellr/no-pro
• Owner: pmuellr
• License: mit
• Created: 2019-02-27T06:33:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-08T03:33:18.000Z (about 5 years ago)
• Last Synced: 2024-04-24T01:21:44.283Z (9 months ago)
• Language: JavaScript
• Homepage: https://pmuellr.github.io/no-pro/
• Size: 2.26 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
no-pro runtime - node.js profiling tools

================================================================================



no-pro provides CPU profiling tools for Node.js.

This repository is a mono-repo, with the following embedded packages:

- [runtime](packages/runtime/README.md)

  This package is the core runtime function to generate profile data, to be

  added as instrumentationn to your application.

- [express-middleware](packages/express-middleware/README.md)

  This package provides express-compatible middleware to profile requests

  sent with a keyed header.

- [profile-viewer](packages/profile-viewer/README.md)

  This package provides a web app to view profiles.

development

================================================================================

## organization

This repository contains a number of independent packages rooted in the

`packages` directory - like a [lerna repo](https://lernajs.io/), but currently

not actually a lerna repo.  These packages are referred to below as

"embedded packages".

The root directory contains a `package.json` which largely just includes

`devDependencies` used by the embedded packages.  Generally, the embedded

packages do not contain **any** `devDependencies`.

The downside of this approach is that `devDependencies` executables are not

directly available, when running in an embedded package's root directory.

To counter this down-side, there are some command-line tools available in the

`tools` directory, intended to be run from the root directory of the repository,

to perform actions on the embedded packages.

For more info, see the [`tools/README.md`](tools/README.md) file.

## work flow

Running `npm install` on the root directory will do an `npm install` in each

embedded package, via an npm `postinstall` script.

Typical development flow when updating a single embedded package:

- `tools/watch-one.js ` - run the watch command for an

  embedded project, which watches for changes, runs tests, etc.

- when you're done, `npm run test` to run tests for all embedded packages

On occaison, run `npm run ncu` and `tools/version-info.js` to keep an eye on

dependencies.

license

================================================================================

This package is licensed under the MIT license.  See the [LICENSE.md][] file

for more information.

contributing

================================================================================

Awesome!  We're happy that you want to contribute.

Please read the [CONTRIBUTING.md][] file for more information.

[LICENSE.md]: LICENSE.md

[CONTRIBUTING.md]: CONTRIBUTING.md

[CHANGELOG.md]: CHANGELOG.md