The async_hooks module provides an API to register callbacks tracking the\nlifetime of asynchronous resources created inside a Node.js application.\nIt can be accessed using:
const async_hooks = require('async_hooks');\nAn asynchronous resource represents an object with an associated callback.\nThis callback may be called multiple times, for example, the connection event\nin net.createServer, or just a single time like in fs.open. A resource\ncan also be closed before the callback is called. AsyncHook does not\nexplicitly distinguish between these different cases but will represent them\nas the abstract concept that is a resource.
Following is a simple overview of the public API.
\nconst async_hooks = require('async_hooks');\n\n// Return the ID of the current execution context.\nconst eid = async_hooks.executionAsyncId();\n\n// Return the ID of the handle responsible for triggering the callback of the\n// current execution scope to call.\nconst tid = async_hooks.triggerAsyncId();\n\n// Create a new AsyncHook instance. All of these callbacks are optional.\nconst asyncHook =\n async_hooks.createHook({ init, before, after, destroy, promiseResolve });\n\n// Allow callbacks of this AsyncHook instance to call. This is not an implicit\n// action after running the constructor, and must be explicitly run to begin\n// executing callbacks.\nasyncHook.enable();\n\n// Disable listening for new asynchronous events.\nasyncHook.disable();\n\n//\n// The following are the callbacks that can be passed to createHook().\n//\n\n// init is called during object construction. The resource may not have\n// completed construction when this callback runs, therefore all fields of the\n// resource referenced by "asyncId" may not have been populated.\nfunction init(asyncId, type, triggerAsyncId, resource) { }\n\n// before is called just before the resource's callback is called. It can be\n// called 0-N times for handles (e.g. TCPWrap), and will be called exactly 1\n// time for requests (e.g. FSReqWrap).\nfunction before(asyncId) { }\n\n// after is called just after the resource's callback has finished.\nfunction after(asyncId) { }\n\n// destroy is called when an AsyncWrap instance is destroyed.\nfunction destroy(asyncId) { }\n\n// promiseResolve is called only for promise resources, when the\n// `resolve` function passed to the `Promise` constructor is invoked\n// (either directly or through other means of resolving a promise).\nfunction promiseResolve(asyncId) { }\ncallbacks {Object} The Hook Callbacks to registerinit {Function} The init callback.before {Function} The before callback.after {Function} The after callback.destroy {Function} The destroy callback.{AsyncHook} Instance used for disabling and enabling hooksRegisters functions to be called for different lifetime events of each async\noperation.
\nThe callbacks init()/before()/after()/destroy() are called for the\nrespective asynchronous event during a resource's lifetime.
All callbacks are optional. For example, if only resource cleanup needs to\nbe tracked, then only the destroy callback needs to be passed. The\nspecifics of all functions that can be passed to callbacks is in the\nHook Callbacks section.
const async_hooks = require('async_hooks');\n\nconst asyncHook = async_hooks.createHook({\n init(asyncId, type, triggerAsyncId, resource) { },\n destroy(asyncId) { }\n});\nNote that the callbacks will be inherited via the prototype chain:
\nclass MyAsyncCallbacks {\n init(asyncId, type, triggerAsyncId, resource) { }\n destroy(asyncId) {}\n}\n\nclass MyAddedCallbacks extends MyAsyncCallbacks {\n before(asyncId) { }\n after(asyncId) { }\n}\n\nconst asyncHook = async_hooks.createHook(new MyAddedCallbacks());\nIf any AsyncHook callbacks throw, the application will print the stack trace\nand exit. The exit path does follow that of an uncaught exception, but\nall uncaughtException listeners are removed, thus forcing the process to\nexit. The 'exit' callbacks will still be called unless the application is run\nwith --abort-on-uncaught-exception, in which case a stack trace will be\nprinted and the application exits, leaving a core file.
The reason for this error handling behavior is that these callbacks are running\nat potentially volatile points in an object's lifetime, for example during\nclass construction and destruction. Because of this, it is deemed necessary to\nbring down the process quickly in order to prevent an unintentional abort in the\nfuture. This is subject to change in the future if a comprehensive analysis is\nperformed to ensure an exception can follow the normal control flow without\nunintentional side effects.
\n", "type": "module", "displayName": "Error Handling" }, { "textRaw": "Printing in AsyncHooks callbacks", "name": "printing_in_asynchooks_callbacks", "desc": "Because printing to the console is an asynchronous operation, console.log()\nwill cause the AsyncHooks callbacks to be called. Using console.log() or\nsimilar asynchronous operations inside an AsyncHooks callback function will thus\ncause an infinite recursion. An easily solution to this when debugging is\nto use a synchronous logging operation such as fs.writeSync(1, msg). This\nwill print to stdout because 1 is the file descriptor for stdout and will\nnot invoke AsyncHooks recursively because it is synchronous.
const fs = require('fs');\nconst util = require('util');\n\nfunction debug(...args) {\n // use a function like this one when debugging inside an AsyncHooks callback\n fs.writeSync(1, `${util.format(...args)}\\n`);\n}\nIf an asynchronous operation is needed for logging, it is possible to keep\ntrack of what caused the asynchronous operation using the information\nprovided by AsyncHooks itself. The logging should then be skipped when\nit was the logging itself that caused AsyncHooks callback to call. By\ndoing this the otherwise infinite recursion is broken.
\n", "type": "module", "displayName": "Printing in AsyncHooks callbacks" } ], "type": "module", "displayName": "`async_hooks.createHook(callbacks)`" }, { "textRaw": "`asyncHook.enable()`", "name": "`asynchook.enable()`", "desc": "asyncHook.Enable the callbacks for a given AsyncHook instance. If no callbacks are\nprovided enabling is a noop.
The AsyncHook instance is disabled by default. If the AsyncHook instance\nshould be enabled immediately after creation, the following pattern can be used.
const async_hooks = require('async_hooks');\n\nconst hook = async_hooks.createHook(callbacks).enable();\nasyncHook.Disable the callbacks for a given AsyncHook instance from the global pool of\nAsyncHook callbacks to be executed. Once a hook has been disabled it will not\nbe called again until enabled.
For API consistency disable() also returns the AsyncHook instance.
Key events in the lifetime of asynchronous events have been categorized into\nfour areas: instantiation, before/after the callback is called, and when the\ninstance is destroyed.
\n", "modules": [ { "textRaw": "`init(asyncId, type, triggerAsyncId, resource)`", "name": "`init(asyncid,_type,_triggerasyncid,_resource)`", "desc": "asyncId {number} A unique ID for the async resource.type {string} The type of the async resource.triggerAsyncId {number} The unique ID of the async resource in whose\nexecution context this async resource was created.resource {Object} Reference to the resource representing the async operation,\nneeds to be released during destroy.Called when a class is constructed that has the possibility to emit an\nasynchronous event. This does not mean the instance must call\nbefore/after before destroy is called, only that the possibility\nexists.
This behavior can be observed by doing something like opening a resource then\nclosing it before the resource can be used. The following snippet demonstrates\nthis.
\nrequire('net').createServer().listen(function() { this.close(); });\n// OR\nclearTimeout(setTimeout(() => {}, 10));\nEvery new resource is assigned an ID that is unique within the scope of the\ncurrent process.
\n", "modules": [ { "textRaw": "`type`", "name": "`type`", "desc": "The type is a string identifying the type of resource that caused\ninit to be called. Generally, it will correspond to the name of the\nresource's constructor.
FSEVENTWRAP, FSREQWRAP, GETADDRINFOREQWRAP, GETNAMEINFOREQWRAP, HTTPPARSER,\nJSSTREAM, PIPECONNECTWRAP, PIPEWRAP, PROCESSWRAP, QUERYWRAP, SHUTDOWNWRAP,\nSIGNALWRAP, STATWATCHER, TCPCONNECTWRAP, TCPSERVER, TCPWRAP, TIMERWRAP, TTYWRAP,\nUDPSENDWRAP, UDPWRAP, WRITEWRAP, ZLIB, SSLCONNECTION, PBKDF2REQUEST,\nRANDOMBYTESREQUEST, TLSWRAP, Timeout, Immediate, TickObject\nThere is also the PROMISE resource type, which is used to track Promise\ninstances and asynchronous work scheduled by them.
Users are be able to define their own type when using the public embedder API.
Note: It is possible to have type name collisions. Embedders are encouraged\nto use a unique prefixes, such as the npm package name, to prevent collisions\nwhen listening to the hooks.
\n", "type": "module", "displayName": "`type`" }, { "textRaw": "`triggerId`", "name": "`triggerid`", "desc": "triggerAsyncId is the asyncId of the resource that caused (or "triggered")\nthe new resource to initialize and that caused init to call. This is different\nfrom async_hooks.executionAsyncId() that only shows when a resource was\ncreated, while triggerAsyncId shows why a resource was created.
The following is a simple demonstration of triggerAsyncId:
async_hooks.createHook({\n init(asyncId, type, triggerAsyncId) {\n const eid = async_hooks.executionAsyncId();\n fs.writeSync(\n 1, `${type}(${asyncId}): trigger: ${triggerAsyncId} execution: ${eid}\\n`);\n }\n}).enable();\n\nrequire('net').createServer((conn) => {}).listen(8080);\nOutput when hitting the server with nc localhost 8080:
TCPSERVERWRAP(2): trigger: 1 execution: 1\nTCPWRAP(4): trigger: 2 execution: 0\nThe TCPSERVERWRAP is the server which receives the connections.
The TCPWRAP is the new connection from the client. When a new\nconnection is made the TCPWrap instance is immediately constructed. This\nhappens outside of any JavaScript stack (side note: a executionAsyncId() of 0\nmeans it's being executed from C++, with no JavaScript stack above it).\nWith only that information, it would be impossible to link resources together in\nterms of what caused them to be created, so triggerAsyncId is given the task of\npropagating what resource is responsible for the new resource's existence.
resource is an object that represents the actual async resource that has\nbeen initialized. This can contain useful information that can vary based on\nthe value of type. For instance, for the GETADDRINFOREQWRAP resource type,\nresource provides the hostname used when looking up the IP address for the\nhostname in net.Server.listen(). The API for accessing this information is\ncurrently not considered public, but using the Embedder API, users can provide\nand document their own resource objects. For example, such a resource object\ncould contain the SQL query being executed.
In the case of Promises, the resource object will have promise property\nthat refers to the Promise that is being initialized, and a parentId property\nset to the asyncId of a parent Promise, if there is one, and undefined\notherwise. For example, in the case of b = a.then(handler), a is considered\na parent Promise of b.
Note: In some cases the resource object is reused for performance reasons,\nit is thus not safe to use it as a key in a WeakMap or add properties to it.
The following is an example with additional information about the calls to\ninit between the before and after calls, specifically what the\ncallback to listen() will look like. The output formatting is slightly more\nelaborate to make calling context easier to see.
let indent = 0;\nasync_hooks.createHook({\n init(asyncId, type, triggerAsyncId) {\n const eid = async_hooks.executionAsyncId();\n const indentStr = ' '.repeat(indent);\n fs.writeSync(\n 1,\n `${indentStr}${type}(${asyncId}):` +\n ` trigger: ${triggerAsyncId} execution: ${eid}\\n`);\n },\n before(asyncId) {\n const indentStr = ' '.repeat(indent);\n fs.writeSync(1, `${indentStr}before: ${asyncId}\\n`);\n indent += 2;\n },\n after(asyncId) {\n indent -= 2;\n const indentStr = ' '.repeat(indent);\n fs.writeSync(1, `${indentStr}after: ${asyncId}\\n`);\n },\n destroy(asyncId) {\n const indentStr = ' '.repeat(indent);\n fs.writeSync(1, `${indentStr}destroy: ${asyncId}\\n`);\n },\n}).enable();\n\nrequire('net').createServer(() => {}).listen(8080, () => {\n // Let's wait 10ms before logging the server started.\n setTimeout(() => {\n console.log('>>>', async_hooks.executionAsyncId());\n }, 10);\n});\nOutput from only starting the server:
\nTCPSERVERWRAP(2): trigger: 1 execution: 1\nTickObject(3): trigger: 2 execution: 1\nbefore: 3\n Timeout(4): trigger: 3 execution: 3\n TIMERWRAP(5): trigger: 3 execution: 3\nafter: 3\ndestroy: 3\nbefore: 5\n before: 4\n TTYWRAP(6): trigger: 4 execution: 4\n SIGNALWRAP(7): trigger: 4 execution: 4\n TTYWRAP(8): trigger: 4 execution: 4\n>>> 4\n TickObject(9): trigger: 4 execution: 4\n after: 4\nafter: 5\nbefore: 9\nafter: 9\ndestroy: 4\ndestroy: 9\ndestroy: 5\nNote: As illustrated in the example, executionAsyncId() and execution\neach specify the value of the current execution context; which is delineated by\ncalls to before and after.
Only using execution to graph resource allocation results in the following:
TTYWRAP(6) -> Timeout(4) -> TIMERWRAP(5) -> TickObject(3) -> root(1)\nThe TCPSERVERWRAP is not part of this graph, even though it was the reason for\nconsole.log() being called. This is because binding to a port without a\nhostname is a synchronous operation, but to maintain a completely asynchronous\nAPI the user's callback is placed in a process.nextTick().
The graph only shows when a resource was created, not why, so to track\nthe why use triggerAsyncId.
asyncId {number}When an asynchronous operation is initiated (such as a TCP server receiving a\nnew connection) or completes (such as writing data to disk) a callback is\ncalled to notify the user. The before callback is called just before said\ncallback is executed. asyncId is the unique identifier assigned to the\nresource about to execute the callback.
The before callback will be called 0 to N times. The before callback\nwill typically be called 0 times if the asynchronous operation was cancelled\nor, for example, if no connections are received by a TCP server. Persistent\nasynchronous resources like a TCP server will typically call the before\ncallback multiple times, while other operations like fs.open() will call\nit only once.
asyncId {number}Called immediately after the callback specified in before is completed.
Note: If an uncaught exception occurs during execution of the callback, then\nafter will run after the 'uncaughtException' event is emitted or a\ndomain's handler runs.
asyncId {number}Called after the resource corresponding to asyncId is destroyed. It is also\ncalled asynchronously from the embedder API emitDestroy().
Note: Some resources depend on garbage collection for cleanup, so if a\nreference is made to the resource object passed to init it is possible that\ndestroy will never be called, causing a memory leak in the application. If\nthe resource does not depend on garbage collection, then this will not be an\nissue.
asyncId {number}Called when the resolve function passed to the Promise constructor is\ninvoked (either directly or through other means of resolving a promise).
Note that resolve() does not do any observable synchronous work.
Note: This does not necessarily mean that the Promise is fulfilled or\nrejected at this point, if the Promise was resolved by assuming the state\nof another Promise.
For example:
\nnew Promise((resolve) => resolve(true)).then((a) => {});\ncalls the following callbacks:
\ninit for PROMISE with id 5, trigger id: 1\n promise resolve 5 # corresponds to resolve(true)\ninit for PROMISE with id 6, trigger id: 5 # the Promise returned by then()\n before 6 # the then() callback is entered\n promise resolve 6 # the then() callback resolves the promise by returning\n after 6\nasyncId of the current execution context. Useful to\ntrack when something calls.For example:
\nconst async_hooks = require('async_hooks');\n\nconsole.log(async_hooks.executionAsyncId()); // 1 - bootstrap\nfs.open(path, 'r', (err, fd) => {\n console.log(async_hooks.executionAsyncId()); // 6 - open()\n});\nIt is important to note that the ID returned fom executionAsyncId() is related\nto execution timing, not causality (which is covered by triggerAsyncId()). For\nexample:
const server = net.createServer(function onConnection(conn) {\n // Returns the ID of the server, not of the new connection, because the\n // onConnection callback runs in the execution scope of the server's\n // MakeCallback().\n async_hooks.executionAsyncId();\n\n}).listen(port, function onListening() {\n // Returns the ID of a TickObject (i.e. process.nextTick()) because all\n // callbacks passed to .listen() are wrapped in a nextTick().\n async_hooks.executionAsyncId();\n});\nFor example:
\nconst server = net.createServer((conn) => {\n // The resource that caused (or triggered) this callback to be called\n // was that of the new connection. Thus the return value of triggerAsyncId()\n // is the asyncId of "conn".\n async_hooks.triggerAsyncId();\n\n}).listen(port, () => {\n // Even though all callbacks passed to .listen() are wrapped in a nextTick()\n // the callback itself exists because the call to the server's .listen()\n // was made. So the return value would be the ID of the server.\n async_hooks.triggerAsyncId();\n});\nLibrary developers that handle their own asychronous resources performing tasks\nlike I/O, connection pooling, or managing callback queues may use the AsyncWrap\nJavaScript API so that all the appropriate callbacks are called.
The class AsyncResource was designed to be extended by the embedder's async\nresources. Using this users can easily trigger the lifetime events of their\nown resources.
The init hook will trigger when an AsyncResource is instantiated.
Note: It is important that before/after calls are unwound\nin the same order they are called. Otherwise an unrecoverable exception\nwill occur and the process will abort.
The following is an overview of the AsyncResource API.
const { AsyncResource, executionAsyncId } = require('async_hooks');\n\n// AsyncResource() is meant to be extended. Instantiating a\n// new AsyncResource() also triggers init. If triggerAsyncId is omitted then\n// async_hook.executionAsyncId() is used.\nconst asyncResource = new AsyncResource(\n type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false }\n);\n\n// Call AsyncHooks before callbacks.\nasyncResource.emitBefore();\n\n// Call AsyncHooks after callbacks.\nasyncResource.emitAfter();\n\n// Call AsyncHooks destroy callbacks.\nasyncResource.emitDestroy();\n\n// Return the unique ID assigned to the AsyncResource instance.\nasyncResource.asyncId();\n\n// Return the trigger ID for the AsyncResource instance.\nasyncResource.triggerAsyncId();\ntype {string} The type of async event.options {Object}triggerAsyncId {number} The ID of the execution context that created this\nasync event. Default: executionAsyncId()requireManualDestroy {boolean} Disables automatic emitDestroy when the\nobject is garbage collected. This usually does not need to be set (even if\nemitDestroy is called manually), unless the resource's asyncId is retrieved\nand the sensitive API's emitDestroy is called with it.\nDefault: falseExample usage:
\nclass DBQuery extends AsyncResource {\n constructor(db) {\n super('DBQuery');\n this.db = db;\n }\n\n getInfo(query, callback) {\n this.db.get(query, (err, data) => {\n this.emitBefore();\n callback(err, data);\n this.emitAfter();\n });\n }\n\n close() {\n this.db = null;\n this.emitDestroy();\n }\n}\nCall all before callbacks to notify that a new asynchronous execution context\nis being entered. If nested calls to emitBefore() are made, the stack of\nasyncIds will be tracked and properly unwound.
Call all after callbacks. If nested calls to emitBefore() were made, then\nmake sure the stack is unwound properly. Otherwise an error will be thrown.
If the user's callback throws an exception, emitAfter() will automatically be\ncalled for all asyncIds on the stack if the error is handled by a domain or\n'uncaughtException' handler.
Call all destroy hooks. This should only ever be called once. An error will\nbe thrown if it is called more than once. This must be manually called. If\nthe resource is left to be collected by the GC then the destroy hooks will\nnever be called.
asyncId assigned to the resource.triggerAsyncId that is passed to the AsyncResource\nconstructor.