https://github.com/oslabs-beta/infernode
Process tracing and flame graph visualization tool for Node.js development
https://github.com/oslabs-beta/infernode
developer-tools dtrace flamegraph javascript nodejs open-source performance-analysis performance-tuning typescript
Last synced: 5 months ago
JSON representation
Process tracing and flame graph visualization tool for Node.js development
- Host: GitHub
- URL: https://github.com/oslabs-beta/infernode
- Owner: oslabs-beta
- License: mit
- Created: 2022-08-12T19:16:27.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-01-10T03:25:12.000Z (about 2 years ago)
- Last Synced: 2025-09-11T05:37:34.921Z (6 months ago)
- Topics: developer-tools, dtrace, flamegraph, javascript, nodejs, open-source, performance-analysis, performance-tuning, typescript
- Language: TypeScript
- Homepage:
- Size: 35 MB
- Stars: 46
- Watchers: 3
- Forks: 1
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# infernode
A process tracing and flame graph tool for node.js development
[INFERNOde Website](https://www.infernode.dev)
[Documentation and Features](https://www.infernode.dev/Documentation/doc2.html)
[Contact the developers](mailto:team@infernode.dev)
## Usage
0. Ensure that your user account has sufficient permissions to perform process tracing on your system.
On Mac:
```
echo "$(whoami) ALL=(ALL) NOPASSWD: /usr/sbin/dtrace" | sudo tee -a /etc/sudoers
```
On Linux:
```
echo "kernel.perf_event_paranoid=-1" | sudo tee -a /etc/sysctl.conf > /dev/null
sysctl -p
```
1. `npm install --save-dev infernode` in your Node.JS NPM project
1. `npx infernode` to launch INFERNOde
1. Navigate to the **Capture** page
1. Provide the path to your app's entrypoint, relative to the top level directory of your project (e.g. `src/index.js`)
1. Set a time limit for your capture and hit start
1. If necessary, interact with your app to trigger the functionality you want to trace
1. Check out the new flame graph in the sidebar
## Interface
View and Manage Existing Graphs
## Architecture
[Diagrams](docs/arch-diagrams.md)
### Key Dependencies
#### Backend
- TypeScript
- Node.js
- Express.js
- SQLite3
- Pino
- Formidable
#### Frontend
- TypeScript
- React
- React-Router
- React-Bootstrap
- Axios
#### CI/CD
- Github Actions
- Jest
- Supertest
- Semantic-Release
- Stylelint
- ESLint
- Webpack
## Developing
1. Clone this repository
1. `npm install` in the repo directory
1. `npm run dev` to run the server with on-save recompile/reload
### Additional project scripts
All scripts are accessible via `npm run `, some key scripts are:
- `resetdb`: Clean out infernode's datastore for a fresh start
- `clean`: Remove all contents of the `./dist/` directory
- `copy-assets`: Copy static assets from `./src/` to `./dist/`
- `lint`: Run linter (ESLint) against the relevant client and server source code
- `build`: Performs `npm run prebuild`, `npm run tsc`, and `npm run webpack` sequentially, will halt if any `prebuild` steps have non-zero exit codes
- `test`: Performs a fresh `build` and then executes all test suites
- `start`: Starts the `node` server in production mode, access via
- `dev`: Starts the `node` and `webpack-dev-server` servers in development mode, both dynamically recompiling/bundling/restarting on source code changes, access via
### Express.js Global Error Handler
- Invoked via `next( errObject: InfernodeError )`.
- Takes an `InfernodeError` type object with the following mandatory properties:
- `message: string`: A technical error message not necessarily intended for end users
- The `InfernodeError` object can optionally include:
- `userMessage: string`: A non-technical error message intended for (public) end users or API consumers
- `httpStatus: number`: A more specific HTTP status code to use for the response
- `controller: string`: The Express middleware controller/function/method/operation that caused the error
- Logs the entire error object + the request method and path to the server's console.
- The response status will be set to 500 by default if an `errObject.httpStatus` code is not provided.
- In development mode, entire error object, request method, and request path will be sent in the HTTP response body as JSON.
- In production mode, only the errObject.userMessage will be sent in the HTTP response body as JSON.
## Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for standards and process related to contributing to this project.
