Improve logging #46

nirs · 2024-09-16T17:03:53Z

This does not fix all the issues mentioned in #43 but prepare the infrastructure. With these changes adding timestamps for all logs is a trivial change.

Log everything to stderr - this has many advantages: much easier to
understand what happened before errors, much easier to understand the
daemon state, since stderr is line buffered, so events (e.g. start,
stop, connect, disconnect) are logged immediately. Easier to get logs
from users.
Replace fprintf and printf with logging macros (ERRORF, ERROR, INFO)
Replace perror with ERRORN, showing the same output an error log.
Use prefix for all logs ("DEBUG|", "INFO |", "ERROR|") to make the
meaning of the message clear, and make all log message
aligned nicely.
Remove unneeded log for vmnet_return_t when we get VMNET_SUCCESS
Replace print_vmnet_status() with vmnet_strerror() returning readable
error name. Callers use ERRORF() to log the vmnet function name,
return value and error name.
Log socket length when it is too long
Log the signal name and number
Don't use perror() for logging errors from function snot setting errno
Don't log same error twice (once in a function, second in the caller)

Example log with this change

# tail -f /var/log/socket_vmnet/stderr 
INFO | Initializing vmnet.framework (mode 1001)
INFO | * vmnet_subnet_mask: 255.255.255.0
INFO | * vmnet_mtu: 1500
INFO | * vmnet_end_address: 192.168.105.254
INFO | * vmnet_start_address: 192.168.105.1
INFO | * vmnet_interface_id: 3924D245-6997-472D-A263-97E2A27FF173
INFO | * vmnet_max_packet_size: 1514
INFO | * vmnet_nat66_prefix: fd9b:5a14:ba57:e3d3::
INFO | * vmnet_mac_address: 6a:d6:97:42:f0:20
INFO | Accepted a connection (fd 5)
INFO | Accepted a connection (fd 6)
INFO | Accepted a connection (fd 7)
INFO | Connection closed by peer (fd 7)
INFO | Closing a connection (fd 7)
INFO | Connection closed by peer (fd 6)
INFO | Closing a connection (fd 6)
INFO | Connection closed by peer (fd 5)
INFO | Closing a connection (fd 5)

nirs · 2024-09-16T17:08:31Z

main.c

+#define INFOF(fmt, ...)     fprintf(stderr, "INFO | " fmt "\n", __VA_ARGS__)
+#define ERROR(msg)          fprintf(stderr, "ERROR| " msg "\n")
+#define ERRORF(fmt, ...)    fprintf(stderr, "ERROR| " fmt "\n", __VA_ARGS__)
+#define ERRORN(name)        ERRORF(name ": %s", strerror(errno))


This should move to log.h so we can split the to code to multiple files and use consistent logging.

I guess we should use https://developer.apple.com/documentation/os/os_log ?

See man 3 os_log for the usage

Sure, I'll try this.

But I think we should keep the logging macros so it is easy to change the logging backend later.

Do you plan to update this?

What I have here was good enough for testing and fixing various issue, and I did not have time to check this direction so far.

I can update with with the version I run locally on top of current master, and we can add an issue to consider os_log.

We anyway need to add timestamps, using os_log will avoid this work.

Added an issue to consider using os_log: #64

main.c

- Log everything to stderr - this has many advantages: much easier to understand what happened before errors, much easier to understand the daemon state, since stderr is line buffered, so events (e.g. start, stop, connect, disconnect) are logged immediately. Easier to get logs from users. - Replace fprintf and printf with logging macros (ERRORF, ERROR, INFO) - Replace perror with ERRORN, showing the same output an error log. - Use prefix for all logs ("DEBUG|", "INFO |", "ERROR|") to make the meaning of the message clear, and make all log message aligned nicely. - Remove unneeded log for vmnet_return_t when we get VMNET_SUCCESS - Replace print_vmnet_status() with vmnet_strerror() returning readable error name. Callers use ERRORF() to log the vmnet function name, return value and error name. - Log socket length when it is too long - Log the signal name and number - Don't use perror() for logging errors from function snot setting errno - Don't log same error twice (once in a function, second in the caller) Signed-off-by: Nir Soffer <[email protected]>

AkihiroSuda

Thanks

nirs · 2024-11-08T14:25:24Z

Opened #70 to update docs/launchd configuration.

nirs marked this pull request as draft September 16, 2024 17:03

nirs force-pushed the logging branch from af0b6df to 5e3c3c5 Compare September 16, 2024 17:06

nirs commented Sep 16, 2024

View reviewed changes

AkihiroSuda added this to the v1.1.5 milestone Sep 17, 2024

nirs commented Sep 17, 2024

View reviewed changes

main.c Outdated Show resolved Hide resolved

nirs force-pushed the logging branch 2 times, most recently from d8500a8 to f28945a Compare September 17, 2024 20:21