Configurable logging #3730

Ryszard-Trojnacki · 2025-04-03T14:40:04Z

Added possibility to configure LiteFarm logging.

Till now all logging configuration was hardcoded and only variable was NODE_ENV. I have introduced new variables for logging:

LOG_LEVEL - allows to setup main/file logging,
LOG_CONSOLE_LEVEL - allows to setup console login,
LOG_DISABLE_SENTRY - allows to disable Sentry logging.

Also I have changed console logging format from JSON to cli, because it was totally unreadable.

Beside changing the level of logging, there is a possibility to turn off logging by setting off value to parameter. LOG_CONSOLE_LEVEL=off allows to turn off console logging.

New variables does not change the actual behavior.
Only change that is done by this patch is change of default format of console logging.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

I have updated .env.default file with variables.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Passes test case
UI components visually reviewed on desktop view
UI components visually reviewed on mobile view
Other (please explain)

Tested all configuration options manually.

Checklist:

I have commented my code, particularly in hard-to-understand areas
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
The precommit and linting ran successfully
I have added or updated language tags for text that's part of the UI
I have added "MISSING" for all new language tags to languages I don't speak
I have added the GNU General Public License to all new files

antsgar · 2025-04-07T23:40:31Z

packages/api/src/common/logger.js

+ * @param value log level string
+ * @param def default log level
+ */
+function getLogLevel(value, def) {


Could we change def to default? I prefer not to shorten variable names because it can be confusing

default is a JavaScript reserved keyword used in switch. It can't be used as a variable name.

OK, I have changed this to defaultValue. I hope this is OK now.

Ah, you're right! Ironically I think I found def confusing from how it's used in Python. Thanks for updating it!

antsgar · 2025-04-07T23:41:16Z

packages/api/src/common/logger.js

+  if (typeof value !== 'string') return def;
+  value = value.toLowerCase().trim();


NIT but we usually prefer to avoid inline conditionals

Done and corrected in other places.

antsgar · 2025-04-08T00:10:41Z

packages/api/src/common/logger.js


 // Report Errors to Sentry
-if (process.env.NODE_ENV !== 'development') {
+if (process.env.NODE_ENV !== 'development' && !isTrue(process.env.LOG_DISABLE_SENTRY)) {


The negation of isTrue is a bit hard to read IMO. Could we change the env var to LOG_ENABLE_SENTRY instead?

antsgar · 2025-04-08T00:11:18Z

@Ryszard-Trojnacki left a few minor comments, thank you for working on this!

Ryszard-Trojnacki · 2025-04-08T05:22:29Z

@antsgar I have included all your comments.

packages/api/.env.default

SayakaOno · 2025-05-02T18:12:28Z

packages/api/src/common/logger.js

-if (process.env.NODE_ENV !== 'production') {
+const consoleLogLevel = getLogLevel(
+  process.env.LOG_CONSOLE_LEVEL,
+  process.env.NODE_ENV !== 'production' ? 'error' : 'off',


I'm so sorry for the late review Ryszard.

@antsgar
As we discussed in this Slack thread, we want to enable error logs in production. Could you confirm that:

process.env.NODE_ENV !== 'production' ? 'error' : 'off'

should instead just be 'error'?

Just checking before requesting any changes, especially since this PR has been open for a while.

Also, if we go ahead with this change, we would need to replace console.log used for error logging with console.error.

I have changed the first part.

Also, if we go ahead with this change, we would need to replace console.log used for error logging with console.error.

As I understand you want me to change almost all calls to console.log to console.error?

There is also other option. I can change:

console.log = (...args) => logger.info.call(logger, ...args);

to:

console.log = (...args) => logger.error.call(logger, ...args);

and console.log would be by default logger.error.

@Ryszard-Trojnacki Thank you so much for making the change and for your comment!
We actually discussed it this morning and are now thinking about setting LOG_CONSOLE_LEVEL to info, since we’ll want to support both info and log.

I also noticed that objects are being logged as undefined with the changes. I was thinking we might want to consider formatting the output using winston.format.printf (https://github.com/winstonjs/winston?tab=readme-ov-file#formats).
Do you happen to have any suggestions or alternatives that might work better?

Just for reference, here's the current log:

And here's how it looks with the changes:

Changed format of console logging. Added ability to turn off logging. Added option to turn off Sentry logging.

Minor code readability fixes.

Co-authored-by: Antonella Sgarlatta <antsgar@gmail.com>

Ryszard-Trojnacki requested review from a team as code owners April 3, 2025 14:40

Ryszard-Trojnacki requested review from SayakaOno and antsgar and removed request for a team April 3, 2025 14:40

antsgar reviewed Apr 8, 2025

View reviewed changes

antsgar previously approved these changes Apr 8, 2025

View reviewed changes

packages/api/.env.default Outdated Show resolved Hide resolved

Ryszard-Trojnacki dismissed antsgar’s stale review via de6e3f4 April 10, 2025 07:04

antsgar self-requested a review April 11, 2025 01:12

antsgar previously approved these changes Apr 11, 2025

View reviewed changes

SayakaOno reviewed May 2, 2025

View reviewed changes

Ryszard-Trojnacki dismissed antsgar’s stale review via b8e4bcd May 13, 2025 09:47

Ryszard-Trojnacki and others added 4 commits September 16, 2025 13:38

Added options to configure logging.

4ac51c9

Changed format of console logging. Added ability to turn off logging. Added option to turn off Sentry logging.

Change LOG_DISABLE_SENTRY to LOG_ENABLE_SENTRY.

a05f092

Minor code readability fixes.

Fixed typo in packages/api/.env.default

69de493

Co-authored-by: Antonella Sgarlatta <antsgar@gmail.com>

Changed default log level for console logger to error.

e513877

Ryszard-Trojnacki force-pushed the feature/ILOT-55-logging branch from 4438e0e to e513877 Compare September 16, 2025 11:38

		if (typeof value !== 'string') return def;
		value = value.toLowerCase().trim();

Configurable logging #3730

Are you sure you want to change the base?

Configurable logging #3730

Uh oh!

Conversation

Ryszard-Trojnacki commented Apr 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

antsgar commented Apr 8, 2025

Uh oh!

Ryszard-Trojnacki commented Apr 8, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants