Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/core/server/legacy/logging/appenders/legacy_appender.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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>) {
Expand Down
6 changes: 6 additions & 0 deletions src/core/server/logging/appenders/appenders.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

/**
Expand Down
82 changes: 82 additions & 0 deletions src/core/server/logging/logger.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
});
});
8 changes: 4 additions & 4 deletions src/core/server/logging/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}
}

Expand Down