Skip to content

fix(logger): increase max listeners of file transports to 20 #5537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wemeetagain merged 1 commit into from
May 30, 2023
Merged

fix(logger): increase max listeners of file transports to 20 #5537

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions packages/logger/src/node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ import {WinstonLogger} from "./winston.js";

const DATE_PATTERN = "YYYY-MM-DD";

/**
* Increase max listeners of file transports to prevent `MaxListenersExceededWarning` warnings.
* Each child logger (`logger.child`) adds a new listener. Setting a reasonable limit to still
* detect potential memory leaks. See https://github.com/ChainSafe/lodestar/issues/5529 for details.
*/
const FILE_TRANSPORT_MAX_LISTENERS = 20;

export type LoggerNodeOpts = {
level: LogLevel;
/**
Expand Down Expand Up @@ -104,12 +111,12 @@ function getNodeLoggerTransports(opts: LoggerNodeOpts): winston.transport[] {
handleExceptions: true,
maxFiles: opts.file.dailyRotate,
auditFile: path.join(path.dirname(filename), ".log_rotate_audit.json"),
})
}).setMaxListeners(FILE_TRANSPORT_MAX_LISTENERS)
: new winston.transports.File({
level: opts.file.level,
filename: filename,
handleExceptions: true,
})
}).setMaxListeners(FILE_TRANSPORT_MAX_LISTENERS)
);
}

Expand Down