Don't log to stdout in dev #27677
Don't log to stdout in dev #27677
Conversation
dev-build/conf/logback.xml
Outdated
| <if condition='!property("STAGE").contains("DEV")'> | ||
| <then> | ||
| <appender-ref ref="ASYNCSTDOUT"/> | ||
| </then> | ||
| </if> |
There was a problem hiding this comment.
I hadn't seen this approach (using Conditional processing & Janino) for having different PROD & DEV logging configuration before, but doing a GitHub search I can see it's being used in 4 other places elsewhere at the Guardian, presumably successfully?
The approach I was more familiar with, from Ophan, was having two separate logback files:
logback.xml- this gets used in devlogback-PROD.xml
...then we take advantage of the fact that when we create Production artifacts, we can specify custom javaOptions in build.sbt, adding a -Dlogger.resource=logback-PROD.xml argument - so only built artifacts get run with that parameter, not when you're running the code locally in dev.
Like I say, I wasn't familiar with the Conditional processing & Janino approach, but I think both approaches have advantages/disadvantages.
Does property("STAGE") mean the environment variable or the system property - and what is actually set in our running Frontend instances?
There was a problem hiding this comment.
Thanks maybe we will be better off with that approach although we have many files for all of the frontend applications.
The property("STAGE") is a system property that we are setting in the .sbtopts file to -DSTAGE=DEV
Co-Authored-By: Andrew Nowak <[email protected]>
prout-bot
added
Pending-on-ADMIN-PROD
Pending-on-FRONTS-PROD
Seen-on-ADMIN-PROD
and removed
Pending-on-ADMIN-PROD
labels
|
Seen on ADMIN-PROD (merged by @DanielCliftonGuardian 12 minutes and 55 seconds ago)
|
|
Seen on FRONTS-PROD (merged by @DanielCliftonGuardian 13 minutes and 1 second ago)
|
What is the value of this and can you measure success?
We do not wish to log to stdout in dev as this is hindering the developer experience with the high output of logs.
This was introduced when we switched to using dev-x logs #27403
Resolves #27653
What does this change?
This PR disables stdout logging when running locally when stage is equal to dev.
Added the system variable -DSTAGE=DEV to the sbt bash script
Added Janino as necessary for conditional rendering https://logback.qos.ch/manual/configuration.html#conditional
Deployed to code. Still sending logs
Checklist