Add Appender.receiveAllLevels option to fix LegacyAppender (#55752)

src/core/server/legacy/logging/appenders/legacy_appender.ts

@@ -33,6 +33,12 @@ export class LegacyAppender implements DisposableAppender {
  legacyLoggingConfig: schema.any(),
  });
 
+ /**
+ * Sets {@link Appender.receiveAllLevels} because legacy does its own filtering based on the legacy logging
+ * configuration.
+ */
+ public readonly receiveAllLevels = true;
+
  private readonly loggingServer: LegacyLoggingServer;
 
  constructor(legacyLoggingConfig: Readonly<LegacyVars>) {

src/core/server/logging/appenders/appenders.ts

@@ -42,6 +42,12 @@ export type AppenderConfigType = TypeOf<typeof appendersSchema>;
  */
 export interface Appender {
  append(record: LogRecord): void;
+
+ /**
+ * Used to signal to `Logger` that log level filtering should be ignored for this appender. Defaults to `false`.
+ * @deprecated Should be removed once the `LegacyAppender` is removed.
+ */
+ receiveAllLevels?: boolean;
 }
 
 /**

src/core/server/logging/logger.test.ts

@@ -410,3 +410,85 @@ test('passes log record to appenders only if log level is supported.', () => {
  });
  }
 });
+
+test('passes log record to appender with receiveAllLevels: true, regardless if log level is supported', () => {
+ const receiveAllAppender = { append: jest.fn(), receiveAllLevels: true };
+ const warnLogger = new BaseLogger(context, LogLevel.Warn, [receiveAllAppender], factory);
+
+ warnLogger.trace('trace-message');
+ expect(receiveAllAppender.append).toHaveBeenCalledTimes(1);
+ expect(receiveAllAppender.append.mock.calls[0][0]).toMatchObject({
+ level: LogLevel.Trace,
+ message: 'trace-message',
+ });
+
+ warnLogger.debug('debug-message');
+ expect(receiveAllAppender.append).toHaveBeenCalledTimes(2);
+ expect(receiveAllAppender.append.mock.calls[1][0]).toMatchObject({
+ level: LogLevel.Debug,
+ message: 'debug-message',
+ });
+
+ warnLogger.info('info-message');
+ expect(receiveAllAppender.append).toHaveBeenCalledTimes(3);
+ expect(receiveAllAppender.append.mock.calls[2][0]).toMatchObject({
+ level: LogLevel.Info,
+ message: 'info-message',
+ });
+
+ warnLogger.warn('warn-message');
+ expect(receiveAllAppender.append).toHaveBeenCalledTimes(4);
+ expect(receiveAllAppender.append.mock.calls[3][0]).toMatchObject({
+ level: LogLevel.Warn,
+ message: 'warn-message',
+ });
+
+ warnLogger.error('error-message');
+ expect(receiveAllAppender.append).toHaveBeenCalledTimes(5);
+ expect(receiveAllAppender.append.mock.calls[4][0]).toMatchObject({
+ level: LogLevel.Error,
+ message: 'error-message',
+ });
+
+ warnLogger.fatal('fatal-message');
+ expect(receiveAllAppender.append).toHaveBeenCalledTimes(6);
+ expect(receiveAllAppender.append.mock.calls[5][0]).toMatchObject({
+ level: LogLevel.Fatal,
+ message: 'fatal-message',
+ });
+});
+
+test('passes log record to appender with receiveAllLevels: false, only if log level is supported', () => {
+ const notReceiveAllAppender = { append: jest.fn(), receiveAllLevels: false };
+ const warnLogger = new BaseLogger(context, LogLevel.Warn, [notReceiveAllAppender], factory);
+
+ warnLogger.trace('trace-message');
+ expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(0);
+
+ warnLogger.debug('debug-message');
+ expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(0);
+
+ warnLogger.info('info-message');
+ expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(0);
+
+ warnLogger.warn('warn-message');
+ expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(1);
+ expect(notReceiveAllAppender.append.mock.calls[0][0]).toMatchObject({
+ level: LogLevel.Warn,
+ message: 'warn-message',
+ });
+
+ warnLogger.error('error-message');
+ expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(2);
+ expect(notReceiveAllAppender.append.mock.calls[1][0]).toMatchObject({
+ level: LogLevel.Error,
+ message: 'error-message',
+ });
+
+ warnLogger.fatal('fatal-message');
+ expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(3);
+ expect(notReceiveAllAppender.append.mock.calls[2][0]).toMatchObject({
+ level: LogLevel.Fatal,
+ message: 'fatal-message',
+ });
+});

src/core/server/logging/logger.ts

@@ -136,12 +136,12 @@ export class BaseLogger implements Logger {
  }
 
  public log(record: LogRecord) {
- if (!this.level.supports(record.level)) {
- return;
- }
+ const supportedLevel = this.level.supports(record.level);
 
  for (const appender of this.appenders) {
- appender.append(record);
+ if (supportedLevel || appender.receiveAllLevels) {
+ appender.append(record);
+ }
  }
  }