colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

logging/trivial: add code comment about logging "<level> [timestamp]"

Browse Source
This commit is contained in:
Thomas Haller
2023-02-09 11:59:43 +01:00
parent 3fd28a11d4
commit 226848ea62
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/libnm-log-core/nm-logging.c
View File

@@ -707,6 +707,20 @@ _nm_log_impl(const char *file,
msg = nm_vsprintf_buf_or_alloc(fmt, fmt, msg_stack, &msg_heap, NULL); msg = nm_vsprintf_buf_or_alloc(fmt, fmt, msg_stack, &msg_heap, NULL);
/* We always print the level and the timestamp.
*
* Timestamps are very useful for understanding logfiles. While journalctl
* might record the timestamp, it is not present in plain `journalctl` output.
* Users who report a bug would simply send us the `journalctl` output and
* requesting an output with timestamps (even if it's stored somewhere inside
* journald) is not workable.
*
* We print the level, because this too, it's to quickly identify the severity
* of a message.
*
* We also do this for all messages (for all levels), because then the logging
* lines are formatted and aligned in a consistent way, which aids reading the
* logs. */
#define MESSAGE_FMT "%s%-7s [%ld.%04ld] %s" #define MESSAGE_FMT "%s%-7s [%ld.%04ld] %s"
#define MESSAGE_ARG(prefix, tv, msg) \ #define MESSAGE_ARG(prefix, tv, msg) \
prefix, nm_log_level_desc[level].level_str, (tv).tv_sec, ((tv).tv_usec / 100), (msg) prefix, nm_log_level_desc[level].level_str, (tv).tv_sec, ((tv).tv_usec / 100), (msg)