ah-stack-capturer

Captures async hook stack traces for specific resource types and events.

const capturer = StackCapturer.forAllEvents()
capturer.shouldCapture('init') // => true
const stack = capturer.captureStack()
const processed = capturer.processStack()

Installation

npm install ah-stack-capturer

API

StackCapturer

Creates StackCapturere instance. Either shouldCapture OR events with optional types need to be supplied.

Parameters

• $0 Object configures when a stack should be captured
  • $0.events Set<string>? defines on which async hooks events (init|before|after|destroy) a stack should be captured (optional, default null)
  • $0.types Set<string>? defines for which async hook types a stack should be captured (optional, default null)
  • $0.shouldCapture function? function ((event, type, activity) if supplied overrides the shouldCapture method entirely (optional, default null)

stackCapturer.shouldCaptureStack

Returns true|false indicating if a stack should be captured according to the options passed in the @constructor.

Parameters

• event String the async hook event (init|before|after|destroy)
• type String the type of async resource that triggered the event

Returns Boolean true or false indicating if a stack should be captured

stackCapturer.captureStack

Captures the current stack.

Returns String the current stack

stackCapturer.processStack

Processes the supplied stack by splitting the string into lines and removing those that are part of the async hook execution itself.

This allows the user to focus only on the relevant stack.

Parameters

• stack String the captured stack

Returns Array<String> the processed stack

StackCapturer.forAllEvents

Creates a StackCapturer that captures ALL events for the supplied types.

Parameters

• types Set<String>? types passed to the StackCapturer constructor

StackCapturer.turnedOff

Creates a StackCapturer that captures nothing.

License

MIT