https://github.com/mattinsler/longjohn
Long stack traces for node.js inspired by https://github.com/tlrobinson/long-stack-traces
https://github.com/mattinsler/longjohn
Last synced: 6 months ago
JSON representation
Long stack traces for node.js inspired by https://github.com/tlrobinson/long-stack-traces
- Host: GitHub
- URL: https://github.com/mattinsler/longjohn
- Owner: mattinsler
- License: mit
- Created: 2012-07-02T08:46:41.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2019-12-13T17:17:48.000Z (almost 6 years ago)
- Last Synced: 2025-05-05T08:41:20.233Z (7 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 61.5 KB
- Stars: 841
- Watchers: 11
- Forks: 38
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
- awesome-nodejs-precise - longjohn - square)]() | Long stack traces with configurable call trace length. | (Packages / Debugging / Profiling)
- awesome-nodejs-cn - longjohn - Long stack traces with configurable call trace length. (包 / Debugging / Profiling)
README
# longjohn
Long stack traces for [node.js](http://nodejs.org/) with configurable call trace length
## Inspiration
I wrote this while trying to add [long-stack-traces](https://github.com/tlrobinson/long-stack-traces) to my server and realizing that there were issues with support of [EventEmitter::removeListener](http://nodejs.org/api/events.html#events_emitter_removelistener_event_listener). The node HTTP Server will begin to leak callbacks and any of your own code that relies on removing listeners would not work as anticipated.
So what to do... I stole the code and rewrote it. I've added support for removeListener along with the ability to cut off the number of async calls the library will trace. I hope you like it!
Please thank [tlrobinson](https://github.com/tlrobinson) for the initial implementation!
## Production Use
Longjohn collects a large amount of data in order to provide useful stack traces. While it is very helpful in
development and testing environments, it is not recommended to use longjohn in production. The data collection puts
a lot of strain on V8's garbage collector and can greatly slow down heavily-loaded applications.
## Installation
Just npm install it!
```bash
$ npm install longjohn
```
## Usage
To use longjohn, require it in your code (probably in some initialization code). That's all!
```javascript
if (process.env.NODE_ENV !== 'production'){
require('longjohn');
}
// ... your code
```
## Options
#### Limit traced async calls
```javascript
longjohn.async_trace_limit = 5; // defaults to 10
longjohn.async_trace_limit = -1; // unlimited
```
#### Change callback frame text
```javascript
longjohn.empty_frame = 'ASYNC CALLBACK'; // defaults to '---------------------------------------------'
```
## Use with Source Maps
As of version 0.2.9 longjonn supports source maps. Just compile your code down to
javascript with source map support and run like normal.
For coffee-script, this would look like:
```bash
$ coffee --map --compile script.coffee
```