Skip to content
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

Add a settings option to log to console in json format. #25649

Merged
merged 7 commits into from
Jan 8, 2025
+43 −7
Merged

Add a settings option to log to console in json format. #25649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3be8ea8
Add a settings option to log to console in json format.
jum Jan 7, 2025
1c27a12
Run prettier.
jum Jan 7, 2025
b431397
cleanup
Nerivec Jan 7, 2025
0874865
fix test
Nerivec Jan 7, 2025
4a37f8c
add coverage
Nerivec Jan 7, 2025
2db1c2a
fix cross-platform
Nerivec Jan 7, 2025
8f9c6bc
Merge branch 'dev' into console_log_dev
Koenkk Jan 8, 2025
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
1 change: 1 addition & 0 deletions lib/types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ declare global {
device_options: KeyValue;
advanced: {
log_rotation: boolean;
log_console_json: boolean;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
log_console_json: boolean;
log_fromat: 'json' | 'text';

I think this is more extendable in the future

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't that be log_format_console if you want to do it that way? The file logs are a different category.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just had a chat with @Nerivec, let's keep it as is, could you make a PR for the docs then I can merge this.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Koenkk I liked your idea more (with adding the console postfix) - I'm courious what is the reason you decided to keep it as is?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe in general that apps should not spend a huge amount of work for multiple logging destinations and various formatting options. That is nowadays mostly the task of the deployment infrastructure, for example systemd or docker, and they do a decent job at that.

If you want a big refactoring of the current logging, you would have to order all the options on a per channel basis, for example having a file channel, a syslog channel, a console channel each having a format and extra channel specific options. I think this is going overboard and not worth the effort.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrejsoucek because it is unlikely that there will be any other formats than the existing one or json.

log_symlink_current: boolean;
log_output: ('console' | 'file' | 'syslog')[];
log_directory: string;
Expand Down
16 changes: 9 additions & 7 deletions lib/util/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,15 @@ class Logger {
this.logger.add(
new winston.transports.Console({
silent: consoleSilenced,
// winston.config.syslog.levels sets 'warning' as 'red'
format: winston.format.combine(
winston.format.colorize({colors: {debug: 'blue', info: 'green', warning: 'yellow', error: 'red'}}),
winston.format.printf((info) => {
return `[${info.timestamp}] ${info.level}: \t${info.message}`;
}),
),
format: settings.get().advanced.log_console_json
? winston.format.json()
: winston.format.combine(
// winston.config.syslog.levels sets 'warning' as 'red'
winston.format.colorize({colors: {debug: 'blue', info: 'green', warning: 'yellow', error: 'red'}}),
winston.format.printf((info) => {
return `[${info.timestamp}] ${info.level}: \t${info.message}`;
}),
),
}),
);

Expand Down
7 changes: 7 additions & 0 deletions lib/util/settings.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,13 @@
"description": "Log rotation",
"default": true
},
"log_console_json": {
"type": "boolean",
"title": "Console json log",
"requiresRestart": true,
"description": "Console json log",
"default": false
},
"log_symlink_current": {
"type": "boolean",
"title": "Log symlink current",
Expand Down
1 change: 1 addition & 0 deletions lib/util/settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ export const defaults: RecursivePartial<Settings> = {
device_options: {},
advanced: {
log_rotation: true,
log_console_json: false,
log_symlink_current: false,
log_output: ['console', 'file'],
log_directory: path.join(data.getPath(), 'log', '%TIMESTAMP%'),
Expand Down
1 change: 1 addition & 0 deletions test/extensions/bridge.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ describe('Extension: Bridge', () => {
log_level: 'info',
log_namespaced_levels: {},
log_output: ['console', 'file'],
log_console_json: false,
log_rotation: true,
log_symlink_current: false,
log_syslog: {},
Expand Down
24 changes: 24 additions & 0 deletions test/logger.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,4 +397,28 @@ describe('Logger', () => {
expect(logSpy).toHaveBeenLastCalledWith('debug', `z2m:test: ${splatChars}`);
expect(consoleWriteSpy.mock.calls[1][0]).toMatch(new RegExp(`^.*\tz2m:test: ${splatChars}`));
});

it('Logs to console in JSON when configured', () => {
settings.set(['advanced', 'log_console_json'], true);
logger.init();

consoleWriteSpy.mockClear();
logger.info(`Test JSON message`, 'z2m');

const outputJSON = JSON.parse(consoleWriteSpy.mock.calls[0][0]);
expect(outputJSON).toStrictEqual({
level: 'info',
message: 'z2m: Test JSON message',
timestamp: expect.any(String),
});

settings.set(['advanced', 'log_console_json'], false);
logger.init();

consoleWriteSpy.mockClear();
logger.info(`Test JSON message`, 'z2m');

const outputStr: string = consoleWriteSpy.mock.calls[0][0];
expect(outputStr.trim().endsWith('\u001b[32minfo\u001b[39m: \tz2m: Test JSON message')).toStrictEqual(true);
});
});
Loading