Diagnostics Channel | Node.js v18.17.1 Documentation

Node.js

- About this documentation
- Usage and example

- Assertion testing
- Asynchronous context tracking
- Async hooks
- Buffer
- C++ addons
- C/C++ addons with Node-API
- C++ embedder API
- Child processes
- Cluster
- Command-line options
- Console
- Corepack
- Crypto
- Debugger
- Deprecated APIs
- Diagnostics Channel
- DNS
- Domain
- Errors
- Events
- File system
- Globals
- HTTP
- HTTP/2
- HTTPS
- Inspector
- Internationalization
- Modules: CommonJS modules
- Modules: ECMAScript modules
- Modules: `node:module` API
- Modules: Packages
- Net
- OS
- Path
- Performance hooks
- Permissions
- Process
- Punycode
- Query strings
- Readline
- REPL
- Report
- Single executable applications
- Stream
- String decoder
- Test runner
- Timers
- TLS/SSL
- Trace events
- TTY
- UDP/datagram
- URL
- Utilities
- V8
- VM
- WASI
- Web Crypto API
- Web Streams API
- Worker threads
- Zlib

- Code repository and issue tracker

Table of contents

- Diagnostics Channel
  - Public API
    - Overview
      - `diagnostics_channel.hasSubscribers(name)`
      - `diagnostics_channel.channel(name)`
      - `diagnostics_channel.subscribe(name, onMessage)`
      - `diagnostics_channel.unsubscribe(name, onMessage)`
    - Class: `Channel`
      - `channel.hasSubscribers`
      - `channel.publish(message)`
      - `channel.subscribe(onMessage)`
      - `channel.unsubscribe(onMessage)`
    - Built-in Channels
      - HTTP

## Diagnostics Channel#

History

Version | Changes
--- | ---
v18.13.0 | diagnostics_channel is now Stable.
v15.1.0, v14.17.0 | Added in: v15.1.0, v14.17.0

Stability: 2 - Stable

Source Code: 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:

    import diagnostics_channel from 'node:diagnostics_channel';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.

    import diagnostics_channel from '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);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)`#

Added in: 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.

    import diagnostics_channel from 'node:diagnostics_channel';

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

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

##### `diagnostics_channel.channel(name)`#

Added in: 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.

    import diagnostics_channel from 'node:diagnostics_channel';

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

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

##### `diagnostics_channel.subscribe(name, onMessage)`#

Added in: v18.7.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'`.

    import diagnostics_channel from 'node:diagnostics_channel';

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

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

##### `diagnostics_channel.unsubscribe(name, onMessage)`#

Added in: v18.7.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)`.

    import diagnostics_channel from 'node:diagnostics_channel';

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

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

    diagnostics_channel.unsubscribe('my-channel', onMessage);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);

#### Class: `Channel`#

Added in: 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`#

Added in: 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.

    import diagnostics_channel from 'node:diagnostics_channel';

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

    if (channel.hasSubscribers) {
      // There are subscribers, prepare and publish message
    }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)`#

Added in: 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.

    import diagnostics_channel from 'node:diagnostics_channel';

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

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

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

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

##### `channel.subscribe(onMessage)`#

Added in: v15.1.0, v14.17.0Deprecated since: v18.7.0

Stability: 0 - Deprecated: Use `diagnostics_channel.subscribe(name, onMessage)`

- `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'`.

    import diagnostics_channel from 'node:diagnostics_channel';

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

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

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

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

##### `channel.unsubscribe(onMessage)`#

History

Version | Changes
--- | ---
v18.7.0 | Deprecated since: v18.7.0
v17.1.0, v16.14.0, v14.19.0 | Added return value. Added to channels without subscribers.
v15.1.0, v14.17.0 | Added in: v15.1.0, v14.17.0

Stability: 0 - Deprecated: Use `diagnostics_channel.unsubscribe(name, onMessage)`

- `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)`.

    import diagnostics_channel from 'node:diagnostics_channel';

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

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

    channel.subscribe(onMessage);

    channel.unsubscribe(onMessage);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);

#### Built-in Channels#

Stability: 1 - Experimental

While the diagnostics_channel API is now considered stable, the built-in channels currently available are not. Each channel must be declared stable independently.

##### HTTP#

`http.client.request.start`

- `request` <http.ClientRequest>

Emitted when client starts a request.

`http.client.response.finish`

- `request` <http.ClientRequest>
- `response` <http.IncomingMessage>

Emitted when client receives a response.

`http.server.request.start`

- `request` <http.IncomingMessage>
- `response` <http.ServerResponse>
- `socket` <net.Socket>
- `server` <http.Server>

Emitted when server receives a request.

`http.server.response.finish`

- `request` <http.IncomingMessage>
- `response` <http.ServerResponse>
- `socket` <net.Socket>
- `server` <http.Server>

Emitted when server sends a response.

`net.client.socket`

- `socket` <net.Socket>

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

`net.server.socket`

- `socket` <net.Socket>

Emitted when a new TCP or pipe connection is received.

`udp.socket`

- `socket` <dgram.Socket>

Emitted when a new UDP socket is created.