Node: New setLogEventListeners() utility to get log events

### Details

- Instead of relying on `DEBUG` variable and stdout/stderr logs, an application may want to collect mediasoup generated logs and post them somewhere.
- This PR exposed a new `setLogEventListeners()` function at mediasoup root module level.

### Usage example

```ts
mediasoup.setLogEventListeners({
  ondebug: undefined,
  onwarn: (namespace: string, log: string) => {
    MyEnterpriseLogger.warn(`${namespace} ${log}`);
  },
  onerror: (namespace: string, log: string, error?: Error) => {
    if (error) {
      MyEnterpriseLogger.error(`${namespace} ${log}: ${error}`);
    } else {
      MyEnterpriseLogger.error(`${namespace} ${log}`);
    }
  }
});
```

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - `Worker`: Fix `io_uring` support detection ([PR #1445](https://github.com/versatica/mediasoup/pull/1445)).
 - Mitigate libsrtp wraparound with loss decryption failure ([PR #1438](https://github.com/versatica/mediasoup/pull/1438)).
+- Node: New `setLogEventListeners()` utility to get log events ([PR #XXXX](https://github.com/versatica/mediasoup/pull/XXXX)).
 
 ### 3.14.11
 

node/src/ActiveSpeakerObserver.ts

@@ -103,7 +103,7 @@ export class ActiveSpeakerObserver<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/AudioLevelObserver.ts

@@ -147,7 +147,7 @@ export class AudioLevelObserver<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/Consumer.ts

@@ -899,7 +899,7 @@ export class Consumer<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/DataConsumer.ts

@@ -430,7 +430,7 @@ export class DataConsumer<
  * Set buffered amount low threshold.
  */
  async setBufferedAmountLowThreshold(threshold: number): Promise<void> {
- logger.debug('setBufferedAmountLowThreshold() [threshold:%s]', threshold);
+ logger.debug(`setBufferedAmountLowThreshold() [threshold:${threshold}]`);
 
  /* Build Request. */
  const requestOffset =
@@ -714,10 +714,7 @@ export class DataConsumer<
  }
 
  default: {
- logger.error(
- 'ignoring unknown event "%s" in channel listener',
- event
- );
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/DirectTransport.ts

@@ -276,7 +276,7 @@ export class DirectTransport<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/Logger.ts

@@ -1,12 +1,35 @@
 import debug from 'debug';
+import { EnhancedEventEmitter } from './enhancedEvents';
 
 const APP_NAME = 'mediasoup';
 
+export type LoggerEmitterEvents = {
+ debuglog: [string, string];
+ warnlog: [string, string];
+ errorlog: [string, string, Error?];
+};
+
+export type LoggerEmitter = EnhancedEventEmitter<LoggerEmitterEvents>;
+
 export class Logger {
+ private static debugLogEmitter?: LoggerEmitter;
+ private static warnLogEmitter?: LoggerEmitter;
+ private static errorLogEmitter?: LoggerEmitter;
+
  readonly #debug: debug.Debugger;
  readonly #warn: debug.Debugger;
  readonly #error: debug.Debugger;
 
+ static setEmitters(
+ debugLogEmitter?: LoggerEmitter,
+ warnLogEmitter?: LoggerEmitter,
+ errorLogEmitter?: LoggerEmitter
+ ): void {
+ Logger.debugLogEmitter = debugLogEmitter;
+ Logger.warnLogEmitter = warnLogEmitter;
+ Logger.errorLogEmitter = errorLogEmitter;
+ }
+
  constructor(prefix?: string) {
  if (prefix) {
  this.#debug = debug(`${APP_NAME}:${prefix}`);
@@ -25,15 +48,26 @@ export class Logger {
  /* eslint-enable no-console */
  }
 
- get debug(): debug.Debugger {
- return this.#debug;
+ debug(log: string): void {
+ this.#debug(log);
+
+ Logger.debugLogEmitter?.safeEmit('debuglog', this.#debug.namespace, log);
  }
 
- get warn(): debug.Debugger {
- return this.#warn;
+ warn(log: string): void {
+ this.#warn(log);
+
+ Logger.warnLogEmitter?.safeEmit('warnlog', this.#warn.namespace, log);
  }
 
- get error(): debug.Debugger {
- return this.#error;
+ error(log: string, error?: Error): void {
+ this.#error(log, error);
+
+ Logger.errorLogEmitter?.safeEmit(
+ 'errorlog',
+ this.#error.namespace,
+ log,
+ error
+ );
  }
 }

node/src/PipeTransport.ts

@@ -450,7 +450,7 @@ export class PipeTransport<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/PlainTransport.ts

@@ -451,7 +451,7 @@ export class PlainTransport<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/Producer.ts

@@ -586,7 +586,7 @@ export class Producer<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/Router.ts

@@ -1212,7 +1212,7 @@ export class Router<
  })
  .catch(error => {
  logger.error(
- 'pipeToRouter() | error creating PipeTransport pair:%o',
+ 'pipeToRouter() | error creating PipeTransport pair:',
  error
  );
 
@@ -1281,8 +1281,8 @@ export class Router<
  return { pipeConsumer, pipeProducer };
  } catch (error) {
  logger.error(
- 'pipeToRouter() | error creating pipe Consumer/Producer pair:%o',
- error
+ 'pipeToRouter() | error creating pipe Consumer/Producer pair:',
+ error as Error
  );
 
  if (pipeConsumer) {
@@ -1326,8 +1326,8 @@ export class Router<
  return { pipeDataConsumer, pipeDataProducer };
  } catch (error) {
  logger.error(
- 'pipeToRouter() | error creating pipe DataConsumer/DataProducer pair:%o',
- error
+ 'pipeToRouter() | error creating pipe DataConsumer/DataProducer pair:',
+ error as Error
  );
 
  pipeDataConsumer?.close();
@@ -1526,10 +1526,7 @@ export class Router<
  const producer = this.#producers.get(producerId);
 
  if (!producer) {
- logger.error(
- 'canConsume() | Producer with id "%s" not found',
- producerId
- );
+ logger.error(`canConsume() | Producer with id "${producerId}" not found`);
 
  return false;
  }
@@ -1543,7 +1540,7 @@ export class Router<
  clonedRtpCapabilities
  );
  } catch (error) {
- logger.error('canConsume() | unexpected error: %s', String(error));
+ logger.error(`canConsume() | unexpected error: ${error}`);
 
  return false;
  }

node/src/Transport.ts

@@ -667,7 +667,7 @@ export abstract class Transport<
  * Set maximum incoming bitrate for receiving media.
  */
  async setMaxIncomingBitrate(bitrate: number): Promise<void> {
- logger.debug('setMaxIncomingBitrate() [bitrate:%s]', bitrate);
+ logger.debug(`setMaxIncomingBitrate() [bitrate:${bitrate}]`);
 
  /* Build Request. */
  const requestOffset =
@@ -688,7 +688,7 @@ export abstract class Transport<
  * Set maximum outgoing bitrate for sending media.
  */
  async setMaxOutgoingBitrate(bitrate: number): Promise<void> {
- logger.debug('setMaxOutgoingBitrate() [bitrate:%s]', bitrate);
+ logger.debug(`setMaxOutgoingBitrate() [bitrate:${bitrate}]`);
 
  /* Build Request. */
  const requestOffset = new FbsTransport.SetMaxOutgoingBitrateRequestT(
@@ -707,7 +707,7 @@ export abstract class Transport<
  * Set minimum outgoing bitrate for sending media.
  */
  async setMinOutgoingBitrate(bitrate: number): Promise<void> {
- logger.debug('setMinOutgoingBitrate() [bitrate:%s]', bitrate);
+ logger.debug(`setMinOutgoingBitrate() [bitrate:${bitrate}]`);
 
  /* Build Request. */
  const requestOffset = new FbsTransport.SetMinOutgoingBitrateRequestT(

node/src/WebRtcTransport.ts

@@ -644,7 +644,7 @@ export class WebRtcTransport<
  }
 
  default: {
- logger.error('ignoring unknown event "%s"', event);
+ logger.error(`ignoring unknown event "${event}"`);
  }
  }
  }

node/src/Worker.ts

@@ -348,11 +348,7 @@ export class Worker<
  spawnArgs.push(`--disableLiburing=true`);
  }
 
- logger.debug(
- 'spawning worker process: %s %s',
- spawnBin,
- spawnArgs.join(' ')
- );
+ logger.debug(`spawning worker process: ${spawnBin} ${spawnArgs.join(' ')}`);
 
  this.#child = spawn(
  // command
@@ -398,7 +394,7 @@ export class Worker<
  if (!spawnDone && event === Event.WORKER_RUNNING) {
  spawnDone = true;
 
- logger.debug('worker process running [pid:%s]', this.#pid);
+ logger.debug(`worker process running [pid:${this.#pid}]`);
 
  this.emit('@success');
  }
@@ -415,18 +411,14 @@ export class Worker<
 
  if (code === 42) {
  logger.error(
- 'worker process failed due to wrong settings [pid:%s]',
- this.#pid
+ `worker process failed due to wrong settings [pid:${this.#pid}]`
  );
 
  this.close();
  this.emit('@failure', new TypeError('wrong settings'));
  } else {
  logger.error(
- 'worker process failed unexpectedly [pid:%s, code:%s, signal:%s]',
- this.#pid,
- code,
- signal
+ `worker process failed unexpectedly [pid:${this.#pid}, code:${code}, signal:${signal}]`
  );
 
  this.close();
@@ -437,10 +429,7 @@ export class Worker<
  }
  } else {
  logger.error(
- 'worker process died unexpectedly [pid:%s, code:%s, signal:%s]',
- this.#pid,
- code,
- signal
+ `worker process died unexpectedly [pid:${this.#pid}, code:${code}, signal:${signal}]`
  );
 
  this.workerDied(
@@ -459,18 +448,14 @@ export class Worker<
  spawnDone = true;
 
  logger.error(
- 'worker process failed [pid:%s]: %s',
- this.#pid,
- error.message
+ `worker process failed [pid:${this.#pid}]: ${error.message}`
  );
 
  this.close();
  this.emit('@failure', error);
  } else {
  logger.error(
- 'worker process error [pid:%s]: %s',
- this.#pid,
- error.message
+ `worker process error [pid:${this.#pid}]: ${error.message}`
  );
 
  this.workerDied(error);
@@ -479,10 +464,7 @@ export class Worker<
 
  this.#child.on('close', (code, signal) => {
  logger.debug(
- 'worker subprocess closed [pid:%s, code:%s, signal:%s]',
- this.#pid,
- code,
- signal
+ `worker subprocess closed [pid:${this.#pid}, code:${code}, signal:${signal}]`
  );
 
  this.#subprocessClosed = true;

node/src/enhancedEvents.ts

@@ -25,9 +25,8 @@ export class EnhancedEventEmitter<
  return super.emit(eventName, ...args);
  } catch (error) {
  enhancedEventEmitterLogger.error(
- 'safeEmit() | event listener threw an error [eventName:%s]:%o',
- eventName,
- error
+ `safeEmit() | event listener threw an error [eventName:${eventName}]:`,
+ error as Error
  );
 
  try {