Move winston NodeJS transports to cli package #4509
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dapplion
commented
Sep 6, 2022
| @@ -113,7 +113,7 @@ describe("chain / lightclient", function () { | |||
| }); | |||
| }).then(async (head) => { | |||
| // Initialize lightclient | |||
| loggerLC.important("Initializing lightclient", {slot: head.slot}); | |||
| loggerLC.info("Initializing lightclient", {slot: head.slot}); | |||
There was a problem hiding this comment.
.important API is not used anymore in production and forces creators of custom loggers to add it
dapplion
commented
Sep 6, 2022
| @@ -70,49 +69,4 @@ describe("BlockArchiveRepository", function () { | |||
| savedBlock2.message.slot = sampleBlock.message.slot; | |||
| expect(ssz.phase0.SignedBeaconBlock.equals(savedBlock1, savedBlock2)).to.equal(true); | |||
| }); | |||
|
|
|||
| it("batchPutBinary should be faster than batchPut", async () => { | |||
There was a problem hiding this comment.
This is not a test but a very old performance test with winston profiler. Removed as it's not even tracked
dapplion
commented
Sep 6, 2022
| description: "Set log level for a specific module by name: 'chain=debug' or 'network=debug,chain=debug'", | ||
| type: "array", | ||
| string: true, | ||
| coerce: (args: string[]) => args.map((item) => item.split(",")).flat(1), |
There was a problem hiding this comment.
New option that allows to customize arbitrary modules without dedicated flags per module
dapplion
commented
Sep 6, 2022
| datePattern: "YYYY-MM-DD", | ||
| handleExceptions: true, | ||
| maxFiles: args.logFileDailyRotate ?? defaultLogMaxFiles, | ||
| auditFile: path.join(path.dirname(filename), ".log_rotate_audit.json"), |
There was a problem hiding this comment.
For dockerized setups the audit file was placed in the process root and lost on restart. So DailyRotateFile could not clean the log files.
dapplion
commented
Sep 6, 2022
| return this.levelByModule.delete(module); | ||
| } | ||
|
|
||
| _write(info: LogInfo, enc: BufferEncoding, callback: (error?: Error | null | undefined) => void): void { |
There was a problem hiding this comment.
A bit intrusive into Winston mechanics but this is the easiest solution to have custom module levels by far from the few options I've tried
dapplion
commented
Sep 6, 2022
| @@ -60,7 +60,7 @@ describe("cmds / beacon / args handler", () => { | |||
| fs.writeFileSync(peerIdFile, JSON.stringify(prevPeerId.toJSON())); | |||
|
|
|||
| const {peerId} = await runBeaconHandlerInit({ | |||
| peerIdFile, | |||
| // peerIdFile, | |||
There was a problem hiding this comment.
This test is skipped, not sure why Typescript didn't complain about this one before
dapplion
commented
Sep 6, 2022
| @@ -85,7 +85,7 @@ function humanReadableTemplateFn(_info: {[key: string]: any; level: string; mess | |||
|
|
|||
| if (info.timestamp) str += info.timestamp; | |||
|
|
|||
| str += `[${infoString.toUpperCase()}] ${info.level.padStart(infoPad)}: ${info.message}`; | |||
| str += `[${infoString}] ${info.level.padStart(infoPad)}: ${info.message}`; | |||
There was a problem hiding this comment.
Do not mutate module field to keep it equal to what's there in the code
Performance Report✔️ no performance regression detected Full benchmark results
|
|
Tested locally with dev command and works well 👍 |
wemeetagain
approved these changes
Sep 6, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
@lodestar/utilspackage is meant to contain misc utilities re-used across multiple packages that is platform agnostic, and compatible in the browser.Defining a common logger for all packages makes sense, but including a NodeJS only transport (FileRotate) breaks the above invariant.
Flags of type
--logger.chain.level debughave been broken for a long time. This is due to the way winston handles log level at the transport level and doesn't allow customization on child logger.Description
Also, testing this change found out why file rotate does not clean old files. The library https://www.npmjs.com/package/winston-daily-rotate-file can only delete files that it know of if they are present in the audit file. The audit file location is by default the process cwd, which is not persisted if dockerized. Forcing the audit file to be in the same directory as the log file fixes the issue
lodestar/packages/cli/src/util/loggerTransports.ts
Line 38 in d6a7074
closes #2381