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

Jump to bottom

Configuration option to output logs in logfmt #12934

Open
wants to merge 17 commits into
base: unstable
Choose a base branch
from
Open

Configuration option to output logs in logfmt #12934

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
22937cf
Configuration option to output logs in logfmt
azuredream Jan 11, 2024
22276d4
Configuration option to output logs in logfmt
azuredream Jan 12, 2024
cee0b01
Configuration option to output logs in logfmt
azuredream Jan 12, 2024
34a7453
Configuration option to output logs in logfmt
azuredream Jan 12, 2024
f1ab440
Configuration option to output logs in logfmt
azuredream Jan 12, 2024
7266874
Configuration option to output logs in logfmt
azuredream Jan 21, 2024
68580e7
Configuration option to output logs in logfmt
azuredream Jan 21, 2024
30c2314
Configuration option to output logs in logfmt
azuredream Jan 21, 2024
4f518b5
Merge branch 'redis:unstable' into log-in-logfmt-style
azuredream Jan 26, 2024
aa1370f
Configuration option to output logs in logfmt
azuredream Jan 26, 2024
c457d44
Configuration option to output logs in logfmt
azuredream Jan 31, 2024
7ed5616
Configuration option to output logs in logfmt
azuredream Jan 31, 2024
69d36e6
Configuration option to output logs in logfmt
azuredream Jan 31, 2024
b7d1327
Configuration option to output logs in logfmt
azuredream Feb 4, 2024
92e2bf2
Configuration option to output logs in logfmt
azuredream Feb 4, 2024
11c6bd5
Configuration option to output logs in logfmt
azuredream Feb 4, 2024
c755a32
Configuration option to output logs in logfmt
azuredream Feb 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions src/config.c
View file
Open in desktop
Expand Up @@ -3095,6 +3095,7 @@ standardConfig static_configs[] = {
createBoolConfig("latency-tracking", NULL, MODIFIABLE_CONFIG, server.latency_tracking_enabled, 1, NULL, NULL),
createBoolConfig("aof-disable-auto-gc", NULL, MODIFIABLE_CONFIG | HIDDEN_CONFIG, server.aof_disable_auto_gc, 0, NULL, updateAofAutoGCEnabled),
createBoolConfig("replica-ignore-disk-write-errors", NULL, MODIFIABLE_CONFIG, server.repl_ignore_disk_write_error, 0, NULL, NULL),
createBoolConfig("syslog-logfmt", NULL, MODIFIABLE_CONFIG, server.logfmt, 0, NULL, NULL),
zuiderkwast marked this conversation as resolved.
Show resolved Hide resolved

/* String Configs */
createStringConfig("aclfile", NULL, IMMUTABLE_CONFIG, ALLOW_EMPTY_STRING, server.acl_filename, "", NULL, NULL),
Expand Down
9 changes: 7 additions & 2 deletions src/server.c
View file
Open in desktop
Expand Up @@ -144,8 +144,13 @@ void serverLogRaw(int level, const char *msg) {
} else {
role_char = (server.masterhost ? 'S':'M'); /* Slave or Master. */
}
fprintf(fp,"%d:%c %s %c %s\n",
(int)getpid(),role_char, buf,c[level],msg);
if(server.logfmt) {
fprintf(fp,"pid=%d role_char=%c timestamp=\"%s\" level=%c message=\"%s\"\n",
(int)getpid(),role_char, buf,c[level],msg);
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest role=%c (instead of role_char=%c). Is one char clear enough? If not, we can consider using role=master, role=sentinel, etc. but it makes the log longer. Maybe one char is clear enough?

For the level, maybe it would be more normal to use the words warning, notice, info, debug instead of the symbols?

Do we need to check if msg contains double quotes and linebreaks and escape those?

Copy link
Contributor

Choose a reason for hiding this comment

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

One more thing: I think the timestamp should be in ISO format, like 2024-01-11T10:34:38.000Z (always in UTC or with another timezone, i'm not sure what's best...)

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for your review!
I suppose the questions are for @madolson. I'll wait for his reply.

Copy link
Contributor

Choose a reason for hiding this comment

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

@azuredream The questions are for you. :) What do you think?

Copy link
Contributor

@madolson madolson Jan 11, 2024 •
edited

Choose a reason for hiding this comment

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

I actually have a slightly different opinion, which is that I think the strftime format for timestamps should be configurable. It's easiest to test and validate, and I've seen various asks for it to be in a slight different format over time.

Copy link
Contributor

Choose a reason for hiding this comment

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

@madolson the log in debug.c you linked prints the argv, which can be a key name.

Correct, it's on my list of stuff I would like to remove. It was vaguely on my radar as one of the things to fix with https://github.com/redis/redis/pulls?q=is%3Apr+is%3Aopen+redact.

Copy link
Contributor

Choose a reason for hiding this comment

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

@madolson Ah, so do we need to get #11747 merged before we can proceed with this and avoid escaping stuff in message? (I don't like that PRs are blocked by other PRs. Maybe we can just change " to ' in that log entry for now?)

For modules logging, can we simply replace " with ' in-place in moduleLogRaw?

Copy link
Contributor

Choose a reason for hiding this comment

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

@madolson Ah, so do we need to get #11747 merged before we can proceed with this and avoid escaping stuff in message? (I don't like that PRs are blocked by other PRs. Maybe we can just change " to ' in that log entry for now?)

Let's do as you suggested for the moment. Let's also make a debug assertion so we never add the " for any logs.

For modules logging, can we simply replace " with ' in-place in moduleLogRaw?

Like at runtime? I suppose that works, but is also a bit of a breaking change.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes at runtime. Or replace with \". What else can we do?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes at runtime. Or replace with ". What else can we do?

I suppose we probably need to do that now.

}else {
fprintf(fp,"%d:%c %s %c %s\n",
(int)getpid(),role_char, buf,c[level],msg);
}
}
fflush(fp);

Expand Down
1 change: 1 addition & 0 deletions src/server.h
View file
Open in desktop
Expand Up @@ -1846,6 +1846,7 @@ struct redisServer {
int memcheck_enabled; /* Enable memory check on crash. */
int use_exit_on_panic; /* Use exit() on panic and assert rather than
* abort(). useful for Valgrind. */
int logfmt; /* Print log in logfmt style */
/* Shutdown */
int shutdown_timeout; /* Graceful shutdown time limit in seconds. */
int shutdown_on_sigint; /* Shutdown flags configured for SIGINT. */
Expand Down