refactor(app-shell,app-shell-odd): update winston and improve logging #16516
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
Update winston to 3.15 so that we can use the new child logger functionality to get loggers with different labels for different modules instead of creating whole new logger instances. When you create a new winston logger instance, winston will attach listeners to the transports. That means that if you create a bunch, you trigger node's built in "you may be leaking event listeners" warnings, which freaks out anybody who looks at the logs. By using child loggers, we don't create those warnings anymore.
We log everything to journald, and that's where we export logs from. Having the logs also in /data/ODD is just a waste of disk space and storage wear.
sfoster1
requested review from
shlokamin and
mjhuff
and removed request for
a team
TamarZanzouri
pushed a commit
that referenced
this pull request
Oct 18, 2024
…#16516) Update [winston](https://www.npmjs.com/package/winston/v/3.15.0) which is what we use for logging on the node side to the most recent version (3.15) so that we can use `logger.child()`, which lets you override logger metadata without having to create another logger instance. The reason to do this is that each full winston logger instance hangs event listeners off its shared transports (winstonjs/winston#1334) which results in annoying node warning messages about memory leaks that aren't real and are just based on "did you add more than a magic number of listeners to this event". With the child logs, nothing adds the events, and we don't get the warnings. Also, get rid of the file logging to `/app/ODD/logs/error.log` and `/app/ODD/logs/combined.log`, because we're already sending everything to journald via the console and [using that to provide the logs via http](https://github.com/Opentrons/opentrons/blob/edge/robot-server/robot_server/service/legacy/routers/logs.py#L16) so it's just extra storage wear and space usage that we don't actually need. ## testing - [x] do the logs still go
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.
Update winston which is what we use for logging on the node side to the most recent version (3.15) so that we can use
logger.child(), which lets you override logger metadata without having to create another logger instance.The reason to do this is that each full winston logger instance hangs event listeners off its shared transports (winstonjs/winston#1334) which results in annoying node warning messages about memory leaks that aren't real and are just based on "did you add more than a magic number of listeners to this event". With the child logs, nothing adds the events, and we don't get the warnings.
Also, get rid of the file logging to
/app/ODD/logs/error.logand/app/ODD/logs/combined.log, because we're already sending everything to journald via the console and using that to provide the logs via http so it's just extra storage wear and space usage that we don't actually need.testing