etesync-dav icon indicating copy to clipboard operation
etesync-dav copied to clipboard

Please provide guideline "How to create a log file for etesync-dav and how to redact potentially sensitive data from it"

Open porg opened this issue 4 years ago • 0 comments

I found no clear documentation or guidelines on how to create a logfile for supplementing a bug issue. Please write some easy to understand guidelines to encourage users to submit logs to bug reports! Otherwise it's currently a high barrier.

I found no info in the repository here.

The --help is very unclear on how logging works:

$ etesync-dav -h
[…]
-D, --debug           print debug information
[…]
logging:
  --logging-level LOGGING_LEVEL
                        threshold for the logger
  --logging-mask-passwords
                        mask passwords in logs
  --no-logging-mask-passwords
                        do not mask passwords in logs (opposite of --logging-
                        mask-passwords)

On top it talks about "debugging", on bottom about "logging". I assume it's the same thing. But certain I am not.

So how do I activate logging? Is this going to a file in a default directory? Where? Or can I supply a logfile as an argument? Or nothing, and I just have to execute the binary on the command line and get its STDOUT/STDERR ?

--logging-level what shall I supply here? A number? A name such as "critical, verbose". No idea.

--logging-mask-passwords and --no-logging-mask-passwords. What If a supply neither of those arguments? Which one is applied by default? They are mutually exclusive, I assume.

The only rudimentary thing I could do for now is a find/replace for my email-address and ofc all the raw VCALENDAR stuff one could also redact easily with a find/replace. But no idea whether the glibberish contains my account password or encryption password or other personally identification.

porg avatar Jun 10 '20 22:06 porg