Add command line option --LogModes

[kiminuo]

Contributes to #9805

This PR adds --LogModes command line option to specify that one wants to log to only specific logging targets¹. Specifically one can omit file to avoid storing logging data.

See also #9805 (comment).

Testing

dotnet build && dotnet run --framework net8.0 -- --LogModes="" # Do not log at all
dotnet build && dotnet run --framework net8.0 -- --LogModes="file" # Log only to file
dotnet build && dotnet run --framework net8.0 -- --LogModes="console" # Log only to console
dotnet build && dotnet run --framework net8.0 -- --LogModes="file,console" # Log to console & file
dotnet build && dotnet run --framework net8.0 -- --LogModes="console,file" # Log to file & console (equivalent to the above line)
dotnet build && dotnet run --framework net8.0 -- --LogModes="file,file,file" # Should log once, not three times :)
dotnet build && dotnet run --framework net8.0 -- --LogModes=",,,,,," # Parsed as an empty string really

Footnotes

1. --LogTargets might be a better name than log modes. ↩

[Szpoti]

Right now If I misspell file or console, because of the thrown exception, Wasabi will crash with the crash reporter.
This happens even if I don't specify neither file or console so during parsing, x is "".

Regardless the empty string, I don't think Wasabi should crash, rather it should log a warning or an error that it couldn't parse the LogMode.

[kiminuo]

Regardless the empty string, I don't think Wasabi should crash, rather it should log a warning or an error that it couldn't parse the LogMode.

Empty string should be parsed as "no logging targets". I changed it as such.

Right now If I misspell file or console, because of the thrown exception, Wasabi will crash with the crash reporter.

Ok, though real users do not see logs so if they make a typo, everything works except that it does not work as they want.

@Szpoti Another issue here is that we are here in the process of initializing the logger and then you say we should log something (before it's initialized).

[Szpoti]

Ok, though real users do not see logs so if they make a typo, everything works except that it does not work as they want.

I get your point, but this feature can only be done via terminal, right? My logic is that if a user starts Wasabi from the command line with dotnet run, with LogModes argument, they are definitely not a regular user, they probably know what they are doing.
Though the issue you mentioned (loggin before initializing the logger) stands, one might expect something in the logs nevertheless, either if the logging was redirected, or if it couldn't be redirected in the desired way.

On the other hand, now that the client doesn't crash with empty string, I get the idea why it should, if the user e.g. misspells the LogMode. I leave it up to you.

[kiminuo]

I get your point, but this feature can only be done via terminal, right? My logic is that if a user starts Wasabi from the command line with dotnet run, with LogModes argument, they are definitely not a regular user, they probably know what they are doing.

But from this perspective it's better to show an error than "hide" it from an experienced user, or not?

[Szpoti]

But from this perspective it's better to show an error than "hide" it from an experienced user, or not?

Yeah, I think you're right with that.

[yahiheb]

tACK

[kiminuo]

Changed warning to exception in e8880b7.

[kiminuo]

I reimplemented this PR to align better with how we specify options in Config class in 5965740.

Also we don't log to TorLogs.txt if LogMode.File is not specified.

One gotcha is that if the Tor process is already running we don't modify the setting (so in that scenario we fail). In #12749 I implemented restarting Tor if settings are not as user required (specified bridges in that PR) so we can use that approach to improve this. An alternative is to change the way how we set the --Log Tor setting by setting it always once we have a handle of Tor process we want to work with (this approach seems preferrable but I need to check it out in detail how to actually do it). Any opinion?

[turbolay]

tACK

[yahiheb]

tACK

[molnard]

cACK

[molnard]

Kimi asked me to merge with Admin rights CF was blocking him.