re:re:actable
Урок 032 минуты чтения

Что такое diagnostics_channel и зачем он нужен?

На этой странице
Кратко

diagnostics_channel - API Node.js для публикации диагностических событий без жесткой зависимости между приложением, библиотекой и observability-инструментом. Его используют instrumentation libraries, tracing и monitoring.

Вопрос

Что такое diagnostics_channel и зачем он нужен?

Зачем нужен diagnostics channel?

Представь библиотеку HTTP-клиента. Она хочет сообщать:

  • request start;
  • request end;
  • error;
  • retry;
  • timing.

Но она не должна напрямую зависеть от OpenTelemetry, Pino, Datadog или другого инструмента. diagnostics_channel дает общий механизм publish/subscribe.

Минимальный пример

import diagnosticsChannel from 'node:diagnostics_channel';
 
const channel = diagnosticsChannel.channel('app:db:query');
 
channel.subscribe((message) => {
  console.log('query event', message);
});
 
channel.publish({
  sql: 'SELECT 1',
  durationMs: 12,
});

Почему это лучше обычного EventEmitter?

diagnostics_channelEventEmitter
Предназначен для instrumentationОбщий event API
Можно публиковать без subscribersЧасто часть runtime логики
Удобен для библиотекУдобен для business events
Хорошо сочетается с tracingНе специализирован

Когда использовать?

Используй для:

  • instrumentation libraries;
  • framework hooks;
  • DB/query timing events;
  • HTTP client/server events;
  • tracing bridges;
  • metrics collection.

Не используй как основной бизнес event bus.

Как избежать overhead?

Перед дорогой сборкой payload можно проверить, есть ли subscribers:

if (channel.hasSubscribers) {
  channel.publish({
    expensivePayload: buildPayload(),
  });
}

Что важно помнить

  • diagnostics_channel — встроенный pub/sub для диагностических событий без жесткой связи модулей.
  • Библиотеки публикуют события, а APM и инструменты трассировки на них подписываются.
  • Если подписчиков нет, публикация почти ничего не стоит.
  • undici, http и другие модули Node.js уже публикуют события в каналы.

Мини-шпаргалка

  • channel(name) создает или возвращает канал.
  • subscribe(fn) подписывает listener.
  • publish(message) публикует событие.
  • hasSubscribers помогает не собирать дорогой payload.
  • Это API для diagnostics/instrumentation, не для доменных событий.

Документация

Node.js: Diagnostics Channel.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам