Diagnostics Channel

فهرست فصل‌ها دانلود آرشیوناشر

Node.js Docs · نسخهٔ 221ffa5df301 · MIT و مجوزهای همراه مخزن

# Diagnostics Channel

<!-- YAML added:

  • v15.1.0
  • v14.17.0

changes:

  • version:
  • v19.2.0
  • v18.13.0

pr-url: https://github.com/nodejs/node/pull/45290 description: diagnostics_channel is now Stable. -->

<!--introduced_in=v15.1.0-->

توجه: Stability: 2 - Stable

<!-- source_link=lib/diagnostics_channel.js -->

The node:diagnostics_channel module provides an API to create named channels to report arbitrary message data for diagnostics purposes.

It can be accessed using:

mjs
cjs
const diagnostics_channel = require('node:diagnostics_channel');

It is intended that a module writer wanting to report diagnostics messages will create one or many top-level channels to report messages through. Channels may also be acquired at runtime but it is not encouraged due to the additional overhead of doing so. Channels may be exported for convenience, but as long as the name is known it can be acquired anywhere.

If you intend for your module to produce diagnostics data for others to consume it is recommended that you include documentation of what named channels are used along with the shape of the message data. Channel names should generally include the module name to avoid collisions with data from other modules.

Public API

Overview

Following is a simple overview of the public API.

mjs

// Get a reusable channel object
const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

// Subscribe to the channel
diagnostics_channel.subscribe('my-channel', onMessage);

// Check if the channel has an active subscriber
if (channel.hasSubscribers) {
  // Publish data to the channel
  channel.publish({
    some: 'data',
  });
}

// Unsubscribe from the channel
diagnostics_channel.unsubscribe('my-channel', onMessage);
cjs
const diagnostics_channel = require('node:diagnostics_channel');

// Get a reusable channel object
const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

// Subscribe to the channel
diagnostics_channel.subscribe('my-channel', onMessage);

// Check if the channel has an active subscriber
if (channel.hasSubscribers) {
  // Publish data to the channel
  channel.publish({
    some: 'data',
  });
}

// Unsubscribe from the channel
diagnostics_channel.unsubscribe('my-channel', onMessage);

diagnostics_channel.hasSubscribers(name)

<!-- YAML added:

  • v15.1.0
  • v14.17.0

-->

  • name {string|symbol} The channel name
  • Returns: {boolean} If there are active subscribers

Check if there are active subscribers to the named channel. This is helpful if the message you want to send might be expensive to prepare.

This API is optional but helpful when trying to publish messages from very performance-sensitive code.

mjs

if (diagnostics_channel.hasSubscribers('my-channel')) {
  // There are subscribers, prepare and publish message
}
cjs
const diagnostics_channel = require('node:diagnostics_channel');

if (diagnostics_channel.hasSubscribers('my-channel')) {
  // There are subscribers, prepare and publish message
}

diagnostics_channel.channel(name)

<!-- YAML added:

  • v15.1.0
  • v14.17.0

-->

  • name {string|symbol} The channel name
  • Returns: {Channel} The named channel object

This is the primary entry-point for anyone wanting to publish to a named channel. It produces a channel object which is optimized to reduce overhead at publish time as much as possible.

mjs

const channel = diagnostics_channel.channel('my-channel');
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

diagnostics_channel.subscribe(name, onMessage)

<!-- YAML added:

  • v18.7.0
  • v16.17.0

-->

  • name {string|symbol} The channel name
  • onMessage {Function} The handler to receive channel messages
  • message {any} The message data
  • name {string|symbol} The name of the channel

Register a message handler to subscribe to this channel. This message handler will be run synchronously whenever a message is published to the channel. Any errors thrown in the message handler will trigger an ['uncaughtException'][].

mjs

diagnostics_channel.subscribe('my-channel', (message, name) => {
  // Received data
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

diagnostics_channel.subscribe('my-channel', (message, name) => {
  // Received data
});

diagnostics_channel.unsubscribe(name, onMessage)

<!-- YAML added:

  • v18.7.0
  • v16.17.0

-->

  • name {string|symbol} The channel name
  • onMessage {Function} The previous subscribed handler to remove
  • Returns: {boolean} true if the handler was found, false otherwise.

Remove a message handler previously registered to this channel with [diagnostics_channel.subscribe(name, onMessage)][].

mjs

function onMessage(message, name) {
  // Received data
}

diagnostics_channel.subscribe('my-channel', onMessage);

diagnostics_channel.unsubscribe('my-channel', onMessage);
cjs
const diagnostics_channel = require('node:diagnostics_channel');

function onMessage(message, name) {
  // Received data
}

diagnostics_channel.subscribe('my-channel', onMessage);

diagnostics_channel.unsubscribe('my-channel', onMessage);

diagnostics_channel.tracingChannel(nameOrChannels)

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

توجه: Stability: 1 - Experimental

  • nameOrChannels {string|TracingChannel} Channel name or

object containing all the [TracingChannel Channels][]

  • Returns: {TracingChannel} Collection of channels to trace with

Creates a [TracingChannel][] wrapper for the given [TracingChannel Channels][]. If a name is given, the corresponding tracing channels will be created in the form of tracing:${name}:${eventType} where eventType corresponds to the types of [TracingChannel Channels][].

mjs

const channelsByName = diagnostics_channel.tracingChannel('my-channel');

// or...

const channelsByCollection = diagnostics_channel.tracingChannel({
  start: diagnostics_channel.channel('tracing:my-channel:start'),
  end: diagnostics_channel.channel('tracing:my-channel:end'),
  asyncStart: diagnostics_channel.channel('tracing:my-channel:asyncStart'),
  asyncEnd: diagnostics_channel.channel('tracing:my-channel:asyncEnd'),
  error: diagnostics_channel.channel('tracing:my-channel:error'),
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channelsByName = diagnostics_channel.tracingChannel('my-channel');

// or...

const channelsByCollection = diagnostics_channel.tracingChannel({
  start: diagnostics_channel.channel('tracing:my-channel:start'),
  end: diagnostics_channel.channel('tracing:my-channel:end'),
  asyncStart: diagnostics_channel.channel('tracing:my-channel:asyncStart'),
  asyncEnd: diagnostics_channel.channel('tracing:my-channel:asyncEnd'),
  error: diagnostics_channel.channel('tracing:my-channel:error'),
});

Class: Channel

<!-- YAML added:

  • v15.1.0
  • v14.17.0

-->

The class Channel represents an individual named channel within the data pipeline. It is used to track subscribers and to publish messages when there are subscribers present. It exists as a separate object to avoid channel lookups at publish time, enabling very fast publish speeds and allowing for heavy use while incurring very minimal cost. Channels are created with [diagnostics_channel.channel(name)][], constructing a channel directly with new Channel(name) is not supported.

channel.hasSubscribers

<!-- YAML added:

  • v15.1.0
  • v14.17.0

-->

  • Returns: {boolean} If there are active subscribers

Check if there are active subscribers to this channel. This is helpful if the message you want to send might be expensive to prepare.

This API is optional but helpful when trying to publish messages from very performance-sensitive code.

mjs

const channel = diagnostics_channel.channel('my-channel');

if (channel.hasSubscribers) {
  // There are subscribers, prepare and publish message
}
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

if (channel.hasSubscribers) {
  // There are subscribers, prepare and publish message
}

channel.publish(message)

<!-- YAML added:

  • v15.1.0
  • v14.17.0

-->

  • message {any} The message to send to the channel subscribers

Publish a message to any subscribers to the channel. This will trigger message handlers synchronously so they will execute within the same context.

mjs

const channel = diagnostics_channel.channel('my-channel');

channel.publish({
  some: 'message',
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

channel.publish({
  some: 'message',
});

channel.subscribe(onMessage)

<!-- YAML added:

  • v15.1.0
  • v14.17.0

changes:

  • version: v24.8.0

pr-url: https://github.com/nodejs/node/pull/59758 description: Deprecation revoked.

  • version:
  • v18.7.0
  • v16.17.0

pr-url: https://github.com/nodejs/node/pull/44943 description: Documentation-only deprecation. -->

  • onMessage {Function} The handler to receive channel messages
  • message {any} The message data
  • name {string|symbol} The name of the channel

Register a message handler to subscribe to this channel. This message handler will be run synchronously whenever a message is published to the channel. Any errors thrown in the message handler will trigger an ['uncaughtException'][].

mjs

const channel = diagnostics_channel.channel('my-channel');

channel.subscribe((message, name) => {
  // Received data
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

channel.subscribe((message, name) => {
  // Received data
});

channel.unsubscribe(onMessage)

<!-- YAML added:

  • v15.1.0
  • v14.17.0

changes:

  • version: v24.8.0

pr-url: https://github.com/nodejs/node/pull/59758 description: Deprecation revoked.

  • version:
  • v18.7.0
  • v16.17.0

pr-url: https://github.com/nodejs/node/pull/44943 description: Documentation-only deprecation.

  • version:
  • v17.1.0
  • v16.14.0
  • v14.19.0

pr-url: https://github.com/nodejs/node/pull/40433 description: Added return value. Added to channels without subscribers. -->

  • onMessage {Function} The previous subscribed handler to remove
  • Returns: {boolean} true if the handler was found, false otherwise.

Remove a message handler previously registered to this channel with [channel.subscribe(onMessage)][].

mjs

const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

channel.subscribe(onMessage);

channel.unsubscribe(onMessage);
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

channel.subscribe(onMessage);

channel.unsubscribe(onMessage);

channel.bindStore(store[, transform])

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

توجه: Stability: 1 - Experimental

  • store {AsyncLocalStorage} The store to which to bind the context data
  • transform {Function} Transform context data before setting the store context

When [channel.runStores(context, ...)][] is called, the given context data will be applied to any store bound to the channel. If the store has already been bound the previous transform function will be replaced with the new one. The transform function may be omitted to set the given context data as the context directly.

mjs


const store = new AsyncLocalStorage();

const channel = diagnostics_channel.channel('my-channel');

channel.bindStore(store, (data) => {
  return { data };
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');
const { AsyncLocalStorage } = require('node:async_hooks');

const store = new AsyncLocalStorage();

const channel = diagnostics_channel.channel('my-channel');

channel.bindStore(store, (data) => {
  return { data };
});

channel.unbindStore(store)

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

توجه: Stability: 1 - Experimental

  • store {AsyncLocalStorage} The store to unbind from the channel.
  • Returns: {boolean} true if the store was found, false otherwise.

Remove a message handler previously registered to this channel with [channel.bindStore(store)][].

mjs


const store = new AsyncLocalStorage();

const channel = diagnostics_channel.channel('my-channel');

channel.bindStore(store);
channel.unbindStore(store);
cjs
const diagnostics_channel = require('node:diagnostics_channel');
const { AsyncLocalStorage } = require('node:async_hooks');

const store = new AsyncLocalStorage();

const channel = diagnostics_channel.channel('my-channel');

channel.bindStore(store);
channel.unbindStore(store);

channel.runStores(context, fn[, thisArg[, ...args]])

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

توجه: Stability: 1 - Experimental

  • context {any} Message to send to subscribers and bind to stores
  • fn {Function} Handler to run within the entered storage context
  • thisArg {any} The receiver to be used for the function call.
  • ...args {any} Optional arguments to pass to the function.

Applies the given data to any AsyncLocalStorage instances bound to the channel for the duration of the given function, then publishes to the channel within the scope of that data is applied to the stores.

If a transform function was given to [channel.bindStore(store)][] it will be applied to transform the message data before it becomes the context value for the store. The prior storage context is accessible from within the transform function in cases where context linking is required.

The context applied to the store should be accessible in any async code which continues from execution which began during the given function, however there are some situations in which [context loss][] may occur.

mjs


const store = new AsyncLocalStorage();

const channel = diagnostics_channel.channel('my-channel');

channel.bindStore(store, (message) => {
  const parent = store.getStore();
  return new Span(message, parent);
});
channel.runStores({ some: 'message' }, () => {
  store.getStore(); // Span({ some: 'message' })
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');
const { AsyncLocalStorage } = require('node:async_hooks');

const store = new AsyncLocalStorage();

const channel = diagnostics_channel.channel('my-channel');

channel.bindStore(store, (message) => {
  const parent = store.getStore();
  return new Span(message, parent);
});
channel.runStores({ some: 'message' }, () => {
  store.getStore(); // Span({ some: 'message' })
});

Class: TracingChannel

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

توجه: Stability: 1 - Experimental

The class TracingChannel is a collection of [TracingChannel Channels][] which together express a single traceable action. It is used to formalize and simplify the process of producing events for tracing application flow. [diagnostics_channel.tracingChannel()][] is used to construct a TracingChannel. As with Channel it is recommended to create and reuse a single TracingChannel at the top-level of the file rather than creating them dynamically.

tracingChannel.subscribe(subscribers)

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

  • subscribers {Object} Set of [TracingChannel Channels][] subscribers
  • start {Function} The [start event][] subscriber
  • end {Function} The [end event][] subscriber
  • asyncStart {Function} The [asyncStart event][] subscriber
  • asyncEnd {Function} The [asyncEnd event][] subscriber
  • error {Function} The [error event][] subscriber

Helper to subscribe a collection of functions to the corresponding channels. This is the same as calling [channel.subscribe(onMessage)][] on each channel individually.

mjs

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.subscribe({
  start(message) {
    // Handle start message
  },
  end(message) {
    // Handle end message
  },
  asyncStart(message) {
    // Handle asyncStart message
  },
  asyncEnd(message) {
    // Handle asyncEnd message
  },
  error(message) {
    // Handle error message
  },
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.subscribe({
  start(message) {
    // Handle start message
  },
  end(message) {
    // Handle end message
  },
  asyncStart(message) {
    // Handle asyncStart message
  },
  asyncEnd(message) {
    // Handle asyncEnd message
  },
  error(message) {
    // Handle error message
  },
});

tracingChannel.unsubscribe(subscribers)

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

  • subscribers {Object} Set of [TracingChannel Channels][] subscribers
  • start {Function} The [start event][] subscriber
  • end {Function} The [end event][] subscriber
  • asyncStart {Function} The [asyncStart event][] subscriber
  • asyncEnd {Function} The [asyncEnd event][] subscriber
  • error {Function} The [error event][] subscriber
  • Returns: {boolean} true if all handlers were successfully unsubscribed,

and false otherwise.

Helper to unsubscribe a collection of functions from the corresponding channels. This is the same as calling [channel.unsubscribe(onMessage)][] on each channel individually.

mjs

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.unsubscribe({
  start(message) {
    // Handle start message
  },
  end(message) {
    // Handle end message
  },
  asyncStart(message) {
    // Handle asyncStart message
  },
  asyncEnd(message) {
    // Handle asyncEnd message
  },
  error(message) {
    // Handle error message
  },
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.unsubscribe({
  start(message) {
    // Handle start message
  },
  end(message) {
    // Handle end message
  },
  asyncStart(message) {
    // Handle asyncStart message
  },
  asyncEnd(message) {
    // Handle asyncEnd message
  },
  error(message) {
    // Handle error message
  },
});

tracingChannel.traceSync(fn[, context[, thisArg[, ...args]]])

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

  • fn {Function} Function to wrap a trace around
  • context {Object} Shared object to correlate events through
  • thisArg {any} The receiver to be used for the function call
  • ...args {any} Optional arguments to pass to the function
  • Returns: {any} The return value of the given function

Trace a synchronous function call. This will always produce a [start event][] and [end event][] around the execution and may produce an [error event][] if the given function throws an error. This will run the given function using [channel.runStores(context, ...)][] on the start channel which ensures all events should have any bound stores set to match this trace context.

To ensure only correct trace graphs are formed, events will only be published if subscribers are present prior to starting the trace. Subscriptions which are added after the trace begins will not receive future events from that trace, only future traces will be seen.

mjs

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.traceSync(() => {
  // Do something
}, {
  some: 'thing',
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.traceSync(() => {
  // Do something
}, {
  some: 'thing',
});

tracingChannel.tracePromise(fn[, context[, thisArg[, ...args]]])

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

  • fn {Function} Promise-returning function to wrap a trace around
  • context {Object} Shared object to correlate trace events through
  • thisArg {any} The receiver to be used for the function call
  • ...args {any} Optional arguments to pass to the function
  • Returns: {Promise} Chained from promise returned by the given function

Trace a promise-returning function call. This will always produce a [start event][] and [end event][] around the synchronous portion of the function execution, and will produce an [asyncStart event][] and [asyncEnd event][] when a promise continuation is reached. It may also produce an [error event][] if the given function throws an error or the returned promise rejects. This will run the given function using [channel.runStores(context, ...)][] on the start channel which ensures all events should have any bound stores set to match this trace context.

To ensure only correct trace graphs are formed, events will only be published if subscribers are present prior to starting the trace. Subscriptions which are added after the trace begins will not receive future events from that trace, only future traces will be seen.

mjs

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.tracePromise(async () => {
  // Do something
}, {
  some: 'thing',
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.tracePromise(async () => {
  // Do something
}, {
  some: 'thing',
});

tracingChannel.traceCallback(fn[, position[, context[, thisArg[, ...args]]]])

<!-- YAML added:

  • v19.9.0
  • v18.19.0

-->

  • fn {Function} callback using function to wrap a trace around
  • position {number} Zero-indexed argument position of expected callback

(defaults to last argument if undefined is passed)

  • context {Object} Shared object to correlate trace events through (defaults

to {} if undefined is passed)

  • thisArg {any} The receiver to be used for the function call
  • ...args {any} arguments to pass to the function (must include the callback)
  • Returns: {any} The return value of the given function

Trace a callback-receiving function call. The callback is expected to follow the error as first arg convention typically used. This will always produce a [start event][] and [end event][] around the synchronous portion of the function execution, and will produce a [asyncStart event][] and [asyncEnd event][] around the callback execution. It may also produce an [error event][] if the given function throws or the first argument passed to the callback is set. This will run the given function using [channel.runStores(context, ...)][] on the start channel which ensures all events should have any bound stores set to match this trace context.

To ensure only correct trace graphs are formed, events will only be published if subscribers are present prior to starting the trace. Subscriptions which are added after the trace begins will not receive future events from that trace, only future traces will be seen.

mjs

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.traceCallback((arg1, callback) => {
  // Do something
  callback(null, 'result');
}, 1, {
  some: 'thing',
}, thisArg, arg1, callback);
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.traceCallback((arg1, callback) => {
  // Do something
  callback(null, 'result');
}, 1, {
  some: 'thing',
}, thisArg, arg1, callback);

The callback will also be run with [channel.runStores(context, ...)][] which enables context loss recovery in some cases.

mjs


const channels = diagnostics_channel.tracingChannel('my-channel');
const myStore = new AsyncLocalStorage();

// The start channel sets the initial store data to something
// and stores that store data value on the trace context object
channels.start.bindStore(myStore, (data) => {
  const span = new Span(data);
  data.span = span;
  return span;
});

// Then asyncStart can restore from that data it stored previously
channels.asyncStart.bindStore(myStore, (data) => {
  return data.span;
});
cjs
const diagnostics_channel = require('node:diagnostics_channel');
const { AsyncLocalStorage } = require('node:async_hooks');

const channels = diagnostics_channel.tracingChannel('my-channel');
const myStore = new AsyncLocalStorage();

// The start channel sets the initial store data to something
// and stores that store data value on the trace context object
channels.start.bindStore(myStore, (data) => {
  const span = new Span(data);
  data.span = span;
  return span;
});

// Then asyncStart can restore from that data it stored previously
channels.asyncStart.bindStore(myStore, (data) => {
  return data.span;
});

tracingChannel.hasSubscribers

<!-- YAML added:

  • v22.0.0
  • v20.13.0

-->

  • Returns: {boolean} true if any of the individual channels has a subscriber,

false if not.

This is a helper method available on a [TracingChannel][] instance to check if any of the [TracingChannel Channels][] have subscribers. A true is returned if any of them have at least one subscriber, a false is returned otherwise.

mjs

const channels = diagnostics_channel.tracingChannel('my-channel');

if (channels.hasSubscribers) {
  // Do something
}
cjs
const diagnostics_channel = require('node:diagnostics_channel');

const channels = diagnostics_channel.tracingChannel('my-channel');

if (channels.hasSubscribers) {
  // Do something
}

TracingChannel Channels

A TracingChannel is a collection of several diagnostics\_channels representing specific points in the execution lifecycle of a single traceable action. The behavior is split into five diagnostics\_channels consisting of start, end, asyncStart, asyncEnd, and error. A single traceable action will share the same event object between all events, this can be helpful for managing correlation through a weakmap.

These event objects will be extended with result or error values when the task "completes". In the case of a synchronous task the result will be the return value and the error will be anything thrown from the function. With callback-based async functions the result will be the second argument of the callback while the error will either be a thrown error visible in the end event or the first callback argument in either of the asyncStart or asyncEnd events.

To ensure only correct trace graphs are formed, events should only be published if subscribers are present prior to starting the trace. Subscriptions which are added after the trace begins should not receive future events from that trace, only future traces will be seen.

Tracing channels should follow a naming pattern of:

  • tracing:module.class.method:start or tracing:module.function:start
  • tracing:module.class.method:end or tracing:module.function:end
  • tracing:module.class.method:asyncStart or tracing:module.function:asyncStart
  • tracing:module.class.method:asyncEnd or tracing:module.function:asyncEnd
  • tracing:module.class.method:error or tracing:module.function:error

start(event)

  • Name: tracing:${name}:start

The start event represents the point at which a function is called. At this point the event data may contain function arguments or anything else available at the very start of the execution of the function.

end(event)

  • Name: tracing:${name}:end

The end event represents the point at which a function call returns a value. In the case of an async function this is when the promise returned not when the function itself makes a return statement internally. At this point, if the traced function was synchronous the result field will be set to the return value of the function. Alternatively, the error field may be present to represent any thrown errors.

It is recommended to listen specifically to the error event to track errors as it may be possible for a traceable action to produce multiple errors. For example, an async task which fails may be started internally before the sync part of the task then throws an error.

asyncStart(event)

  • Name: tracing:${name}:asyncStart

The asyncStart event represents the callback or continuation of a traceable function being reached. At this point things like callback arguments may be available, or anything else expressing the "result" of the action.

For callbacks-based functions, the first argument of the callback will be assigned to the error field, if not undefined or null, and the second argument will be assigned to the result field.

For promises, the argument to the resolve path will be assigned to result or the argument to the reject path will be assign to error.

It is recommended to listen specifically to the error event to track errors as it may be possible for a traceable action to produce multiple errors. For example, an async task which fails may be started internally before the sync part of the task then throws an error.

asyncEnd(event)

  • Name: tracing:${name}:asyncEnd

The asyncEnd event represents the callback of an asynchronous function returning. It's not likely event data will change after the asyncStart event, however it may be useful to see the point where the callback completes.

error(event)

  • Name: tracing:${name}:error

The error event represents any error produced by the traceable function either synchronously or asynchronously. If an error is thrown in the synchronous portion of the traced function the error will be assigned to the error field of the event and the error event will be triggered. If an error is received asynchronously through a callback or promise rejection it will also be assigned to the error field of the event and trigger the error event.

It is possible for a single traceable function call to produce errors multiple times so this should be considered when consuming this event. For example, if another async task is triggered internally which fails and then the sync part of the function then throws and error two error events will be emitted, one for the sync error and one for the async error.

Built-in Channels

Console

توجه: Stability: 1 - Experimental

##### Event: 'console.log'

  • args {any\[]}

Emitted when console.log() is called. Receives and array of the arguments passed to console.log().

##### Event: 'console.info'

  • args {any\[]}

Emitted when console.info() is called. Receives and array of the arguments passed to console.info().

##### Event: 'console.debug'

  • args {any\[]}

Emitted when console.debug() is called. Receives and array of the arguments passed to console.debug().

##### Event: 'console.warn'

  • args {any\[]}

Emitted when console.warn() is called. Receives and array of the arguments passed to console.warn().

##### Event: 'console.error'

  • args {any\[]}

Emitted when console.error() is called. Receives and array of the arguments passed to console.error().

Crypto

<!-- YAML added: v24.22.0 -->

توجه: Stability: 1 - Experimental

##### Event: 'crypto.fips.indicator'

  • operation {string} The provider-defined operation type.
  • reason {string} The provider-defined description of why the operation is

not approved.

  • blocked {boolean} Whether an indicator callback blocked the operation.
  • count {number} The number of matching pending indicator invocations

represented by this message.

  • dropped {number} The number of additional indicator invocations dropped

before this message was delivered.

Emitted when the OpenSSL FIPS provider used by Node.js detects an operation that is not FIPS approved after the corresponding provider check was relaxed. Such operations are possible when the provider is configured for backwards compatibility. The operation and reason values come from the provider and should be treated as opaque strings rather than stable enumerations.

Start Node.js with [--enable-fips-indicator-events][] to enable this channel. Without the option, subscribing does not install the OpenSSL callback and no messages are published.

Subscribing to the channel is observation-only and never changes the result of an operation. Node.js preserves the result from any native indicator callback installed before Node.js initializes its crypto support. When [--force-fips=strict][] is used, Node.js rejects callback-indicated non-approved operations whether or not indicator events are enabled or the channel has subscribers.

Messages are published asynchronously on the main thread because OpenSSL indicators can originate from Workers or other threads. Only subscriptions on the main thread receive messages. Delivery order relative to the originating operation is not defined, and a message cannot be correlated with a particular call or Worker.

One cryptographic operation can invoke the OpenSSL indicator more than once. Matching pending invocations are coalesced and reflected in count, which does not necessarily represent a number of cryptographic operations. At most 256 distinct messages are queued. Additional invocations are reported in dropped on the first queued message. Queued messages do not keep the event loop active, so this channel is best-effort diagnostics rather than an authoritative audit log.

This channel observes the default OpenSSL library context used by Node.js. It does not observe native addons or other code that uses another OSSL_LIB_CTX or another copy of libcrypto. It is active with OpenSSL 3.4 and later and is not available with BoringSSL. A provider configured to reject a check directly, including a pedantic OpenSSL FIPS provider, can reject an operation without emitting an indicator. Receiving or not receiving a message does not establish that Node.js or a cryptographic operation is FIPS validated.

mjs

diagnosticsChannel.subscribe('crypto.fips.indicator', (message) => {
  console.error('Non-approved cryptographic operation', message);
});

HTTP

توجه: Stability: 1 - Experimental

##### Event: 'http.client.request.created'

  • request {http.ClientRequest}

Emitted when client creates a request object. Unlike http.client.request.start, this event is emitted before the request has been sent.

##### Event: 'http.client.request.start'

  • request {http.ClientRequest}

Emitted when client starts a request.

##### Event: 'http.client.request.error'

  • request {http.ClientRequest}
  • error {Error}

Emitted when an error occurs during a client request.

##### Event: 'http.client.response.finish'

  • request {http.ClientRequest}
  • response {http.IncomingMessage}

Emitted when client receives a response.

##### Event: 'http.server.request.start'

  • request {http.IncomingMessage}
  • response {http.ServerResponse}
  • socket {net.Socket}
  • server {http.Server}

Emitted when server receives a request.

##### Event: 'http.server.response.created'

  • request {http.IncomingMessage}
  • response {http.ServerResponse}

Emitted when server creates a response. The event is emitted before the response is sent.

##### Event: 'http.server.response.finish'

  • request {http.IncomingMessage}
  • response {http.ServerResponse}
  • socket {net.Socket}
  • server {http.Server}

Emitted when server sends a response.

HTTP/2

توجه: Stability: 1 - Experimental

##### Event: 'http2.client.stream.created'

  • stream {ClientHttp2Stream}
  • headers {HTTP/2 Headers Object}

Emitted when a stream is created on the client.

##### Event: 'http2.client.stream.start'

  • stream {ClientHttp2Stream}
  • headers {HTTP/2 Headers Object}

Emitted when a stream is started on the client.

##### Event: 'http2.client.stream.error'

  • stream {ClientHttp2Stream}
  • error {Error}

Emitted when an error occurs during the processing of a stream on the client.

##### Event: 'http2.client.stream.finish'

  • stream {ClientHttp2Stream}
  • headers {HTTP/2 Headers Object}
  • flags {number}

Emitted when a stream is received on the client.

##### Event: 'http2.client.stream.bodyChunkSent'

  • stream {ClientHttp2Stream}
  • writev {boolean}
  • data {Buffer | string | Buffer\[] | Object\[]}
  • chunk {Buffer|string}
  • encoding {string}
  • encoding {string}

Emitted when a chunk of the client stream body is being sent.

##### Event: 'http2.client.stream.bodySent'

  • stream {ClientHttp2Stream}

Emitted after the client stream body has been fully sent.

##### Event: 'http2.client.stream.close'

  • stream {ClientHttp2Stream}

Emitted when a stream is closed on the client. The HTTP/2 error code used when closing the stream can be retrieved using the stream.rstCode property.

##### Event: 'http2.server.stream.created'

  • stream {ServerHttp2Stream}
  • headers {HTTP/2 Headers Object}

Emitted when a stream is created on the server.

##### Event: 'http2.server.stream.start'

  • stream {ServerHttp2Stream}
  • headers {HTTP/2 Headers Object}

Emitted when a stream is started on the server.

##### Event: 'http2.server.stream.error'

  • stream {ServerHttp2Stream}
  • error {Error}

Emitted when an error occurs during the processing of a stream on the server.

##### Event: 'http2.server.stream.finish'

  • stream {ServerHttp2Stream}
  • headers {HTTP/2 Headers Object}
  • flags {number}

Emitted when a stream is sent on the server.

##### Event: 'http2.server.stream.close'

  • stream {ServerHttp2Stream}

Emitted when a stream is closed on the server. The HTTP/2 error code used when closing the stream can be retrieved using the stream.rstCode property.

Modules

توجه: Stability: 1 - Experimental

##### Event: 'tracing:module.require:start'

  • event {Object} containing the following properties
  • id Argument passed to require(). Module name.
  • parentFilename Name of the module that attempted to require(id).

Emitted when require() is executed. See [start event][].

##### Event: 'tracing:module.require:end'

  • event {Object} containing the following properties
  • id Argument passed to require(). Module name.
  • parentFilename Name of the module that attempted to require(id).

Emitted when a require() call returns. See [end event][].

##### Event: 'tracing:module.require:error'

  • event {Object} containing the following properties
  • id Argument passed to require(). Module name.
  • parentFilename Name of the module that attempted to require(id).
  • error {Error}

Emitted when a require() throws an error. See [error event][].

##### Event: 'tracing:module.import:asyncStart'

  • event {Object} containing the following properties
  • id Argument passed to import(). Module name.
  • parentURL URL object of the module that attempted to import(id).

Emitted when import() is invoked. See [asyncStart event][].

##### Event: 'tracing:module.import:asyncEnd'

  • event {Object} containing the following properties
  • id Argument passed to import(). Module name.
  • parentURL URL object of the module that attempted to import(id).

Emitted when import() has completed. See [asyncEnd event][].

##### Event: 'tracing:module.import:error'

  • event {Object} containing the following properties
  • id Argument passed to import(). Module name.
  • parentURL URL object of the module that attempted to import(id).
  • error {Error}

Emitted when a import() throws an error. See [error event][].

NET

توجه: Stability: 1 - Experimental

##### Event: 'net.client.socket'

  • socket {net.Socket|tls.TLSSocket}

Emitted when a new TCP or pipe client socket connection is created.

##### Event: 'net.server.socket'

  • socket {net.Socket}

Emitted when a new TCP or pipe connection is received.

##### Event: 'tracing:net.server.listen:asyncStart'

  • server {net.Server}
  • options {Object}

Emitted when [net.Server.listen()][] is invoked, before the port or pipe is actually setup.

##### Event: 'tracing:net.server.listen:asyncEnd'

  • server {net.Server}

Emitted when [net.Server.listen()][] has completed and thus the server is ready to accept connection.

##### Event: 'tracing:net.server.listen:error'

  • server {net.Server}
  • error {Error}

Emitted when [net.Server.listen()][] is returning an error.

UDP

توجه: Stability: 1 - Experimental

##### Event: 'udp.socket'

  • socket {dgram.Socket}

Emitted when a new UDP socket is created.

Process

توجه: Stability: 1 - Experimental

<!-- YAML added: v16.18.0 -->

##### Event: 'child_process'

  • process {ChildProcess}

Emitted when a new process is created.

tracing:child_process.spawn:start

  • process {ChildProcess}
  • options {Object}

Emitted when [child_process.spawn()][] is invoked, before the process is actually spawned.

tracing:child_process.spawn:end

  • process {ChildProcess}

Emitted when [child_process.spawn()][] has completed successfully and the process has been created.

tracing:child_process.spawn:error

  • process {ChildProcess}
  • error {Error}

Emitted when [child_process.spawn()][] encounters an error.

##### Event: 'process.execve'

  • execPath {string}
  • args {string\[]}
  • env {string\[]}

Emitted when [process.execve()][] is invoked.

Web Locks

توجه: Stability: 1 - Experimental

<!-- YAML added: v24.15.0 -->

These channels are emitted for each [locks.request()][] call. See [worker_threads.locks][] for details on Web Locks.

##### Event: 'locks.request.start'

  • name {string} The name of the requested lock resource.
  • mode {string} The lock mode: 'exclusive' or 'shared'.

Emitted when a lock request is initiated, before the lock is granted.

##### Event: 'locks.request.grant'

  • name {string} The name of the requested lock resource.
  • mode {string} The lock mode: 'exclusive' or 'shared'.

Emitted when a lock is successfully granted and the callback is about to run.

##### Event: 'locks.request.miss'

  • name {string} The name of the requested lock resource.
  • mode {string} The lock mode: 'exclusive' or 'shared'.

Emitted when ifAvailable is true and the lock is not immediately available, and the request callback is invoked with null instead of a Lock object.

##### Event: 'locks.request.end'

  • name {string} The name of the requested lock resource.
  • mode {string} The lock mode: 'exclusive' or 'shared'.
  • steal {boolean} Whether the request uses steal semantics.
  • ifAvailable {boolean} Whether the request uses ifAvailable semantics.
  • error {Error|undefined} The error thrown by the callback, if any.

Emitted when a lock request has finished, whether the callback succeeded, threw an error, or the lock was stolen.

Worker Thread

توجه: Stability: 1 - Experimental

<!-- YAML added: v16.18.0 -->

##### Event: 'worker_threads'

  • worker {Worker}

Emitted when a new thread is created.

SQLite

<!-- YAML added: v24.22.0 -->

توجه: Stability: 1 - Experimental

##### Event: 'sqlite.db.query'

  • sql {string} The expanded SQL with bound parameter values substituted.

If expansion fails, the source SQL with unsubstituted placeholders is used instead.

  • database {DatabaseSync} The [DatabaseSync][] instance that executed the

statement.

  • duration {number} SQLite's internal estimate of the statement run time in

nanoseconds. This reflects C-layer execution time only and does not include JavaScript binding overhead such as argument marshaling or result-row construction.

Emitted after a SQL statement finishes executing against a [DatabaseSync][] instance. This is a profiling event: it fires once per statement upon completion and reports an estimated duration from SQLite's internal profiler. It is not a distributed-tracing span. There is no corresponding start event, no async context propagation, and no parent-span linkage. If you need OpenTelemetry-compatible spans or async context propagation, wrap your SQLite calls with a [TracingChannel][] at the JavaScript layer instead.

Publishing is zero-overhead when there are no subscribers.

No event is emitted for a statement that is abandoned mid-iteration and later finalized, either explicitly through [statement.close()][] or when the statement is garbage collected. Subscribers must not close the database or the statement, since both are still in use while the event is being delivered; see [database.close()][] and [statement.close()][].

[TracingChannel Channels]: #tracingchannel-channels ['uncaughtException']: process.md#event-uncaughtexception [--enable-fips-indicator-events]: cli.md#--enable-fips-indicator-events [--force-fips=strict]: cli.md#--force-fipsmode [DatabaseSync]: sqlite.md#class-databasesync [TracingChannel]: #class-tracingchannel [asyncEnd event]: #asyncendevent [asyncStart event]: #asyncstartevent [channel.bindStore(store)]: #channelbindstorestore-transform [channel.runStores(context, ...)]: #channelrunstorescontext-fn-thisarg-args [channel.subscribe(onMessage)]: #channelsubscribeonmessage [channel.unsubscribe(onMessage)]: #channelunsubscribeonmessage [child_process.spawn()]: child_process.md#child_processspawncommand-args-options [database.close()]: sqlite.md#databaseclose [diagnostics_channel.channel(name)]: #diagnostics_channelchannelname [diagnostics_channel.subscribe(name, onMessage)]: #diagnostics_channelsubscribename-onmessage [diagnostics_channel.tracingChannel()]: #diagnostics_channeltracingchannelnameorchannels [end event]: #endevent [error event]: #errorevent [locks.request()]: worker_threads.md#locksrequestname-options-callback [net.Server.listen()]: net.md#serverlisten [process.execve()]: process.md#processexecvefile-args-env [start event]: #startevent [statement.close()]: sqlite.md#statementclose [worker_threads.locks]: worker_threads.md#worker_threadslocks [context loss]: async_context.md#troubleshooting-context-loss