Logging: add an option to turn logging off altogether by josephsl · Pull Request #8596 · nvaccess/nvda

josephsl · 2018-08-06T06:23:49Z

Link to issue number:

Summary of the issue:

Add an option to turn off logging altogether.

Description of how this pull request fixes the issue:

Add a new option in General settings panel to turn off logging. If this option is chosen, only a startup message (along with config path) will be logged, and log level will be set to 100.

Testing performed:

Tested on source code with logging level set to off and other values.

Known issues with pull request:

Even with logging level set to off, startup info messages will be shown up to config path. Ideally this too should not be logged, but for now, it is acceptable.

Change log entry:

New features: It is possible to turn off NVDA's logging features off by setting logging level to "disabled" from General settings panel. (#8516)

Thanks.

…ote).

…off logging functionality. re nvaccess#8516. If NVDA is run with --no-logging, logging facility will be turned off altogether. This is handy for not only testing this feature, but also for those who'd like to add this command-line switch while defining nVDA shortcut on the desktop or add this from Run dialog (Windows+R).

Switch to null logger if no logging flag is turned on via command-line switches. Also, detect log level of 'OFF' and set log level accordingly (to 100).

… for secure mode. Re nvaccess#8516. Describe available logging modes and what they mean. Also, when edscribing secure mode, add the fact that logging is turned off. Lastly, add an entry in command-line switches table for --no-logging switch.

LeonarddeR · 2018-08-06T06:39:35Z

Could you please use the closes or fixes keyword for the Link to issue number? In that case, github magic will automatically close the issue when the pr is merged.

josephsl · 2018-08-06T07:06:32Z

Hi, I see – we may need to document this in “contributing” guide. Thanks for the reminder.

Brian1Gaff · 2018-08-06T09:50:42Z

Not quite sure I agree with the premise behind this. Is a log where it is any less secure than other data in similar places on the users machine?? Its no good plugging a hole in a boat with no bottom.

DrSooom · 2018-08-07T09:37:32Z

Shall the default value set to "Info" (actual behaviour in NVDA Alpha 15781, 2018-08-03; General NVDA Settings window) or to "Disabled" (privacy by default)?

Furthermore there are two different nomenclature for the log levels in the User Guide.

Disabled, Info, Debug warning, Input/output Debug
| -l LOGLEVEL | --log-level=LOGLEVEL | The lowest level of message logged (debug 10, info 20, warning 30, error 40, critical 50, disabled 100), default is warning |

I'm a little bit confused.

josephsl · 2018-08-07T13:46:58Z

Hi, this code hasn’t been merged into master (alpha) branch yet because it needs to go through reviews. The two sets of log levels can be explained by the fact that one is user-friendly one for settings whereas the other one is for command-line use. Thanks.

DrSooom · 2018-08-08T15:19:15Z

I looked at the changed files in this PR directly via the GitHub website.

After merging there will be five log levels to be set up via the NVDA GUI and six via the command line. It would be nice to know which log level number have the five options which can be set via the GUI. Or as a question: What log level I have to choose in the command line to get the same result like with "Input/Output" via the GUI?

josephsl · 2018-08-08T15:20:49Z

Hi, that’ll be level 12. Thanks for pointing this out, as this isn’t documented (I’ll edit the user guide accordingly).

derekriemer

good. a few minor thoughts.

josephsl · 2018-08-31T01:25:46Z

Hi,

Although I have no comments about nvda.pyw, I'll edit the user guide based on feedback. Thanks.

Add notes about privacy for I/O and debug logging levels, along with word usage changes.

josephsl · 2018-10-14T03:07:58Z

Hi,

@feerrenrut, if you don't mind, I'd like to get a second look please. Thanks.

feerrenrut · 2018-12-14T13:46:03Z

 		# Input: kb(desktop):v
 		logFormatter=Formatter("%(levelname)s - %(codepath)s (%(asctime)s.%(msecs)03d):\n%(message)s", "%H:%M:%S")
-		if globalVars.appArgs.secure:
+		if globalVars.appArgs.secure or globalVars.appArgs.noLogging:


I think it should be possible to override this for debugging purposes. Perhaps either -l --log-level or --debug-logging could override this.

feerrenrut · 2018-12-14T15:14:02Z

Happy to take this feature on, since it's already more or less done and gives users / admin more choices. But I think it's a mistake to think that this is a pathway to privacy or security. For admin trying to ensure that they with GDPR or similar requirements when providing a shared system there are much better ways to ensure the system is cleaned between users. For users who don't trust the system they are using, it should be assumed that every key press, everything displayed, and sound made is recorded. One use case that I think provides an actual benefit, is for uses with limited disk space (though I doubt many users with such limited disk space exist).

Changes made: * log level checks: now a tuple will be checked. * Allow users to override no logging and logging during secure mode via debug logging or predefined logging levels via command line switches. This means no log will be written if secure mode is active and/or no loggin is specified, and if no debug logging nor custom log levels are given.

Clarified: * -l (log level): default is set to info, and added options for I/O and debugwarning. * --debug-warning: add a notice that it can override --no-logging. * --no-logging: add a notice that this can be overwritten with log levels from command line and if debug logging is on.

…ially logging options.

codeofdusk · 2019-01-13T01:31:54Z

The changelog entry for this PR should probably be changed from:

New features: It is possible to turn off NVDA's logging features off by setting logging level to "disabled" from General settings panel. (#8516)

To:

New features: It is possible to turn off NVDA's logging features by setting the logging level to "disabled" from the General settings panel. (#8516)

josephsl · 2019-01-13T02:51:51Z

Hi, thanks for confirming it, I’ll queue it for docs19.1 branch (after 2019.1 beta 1 is released). Thanks. From: Bill Dengler <notifications@github.com> Sent: Saturday, January 12, 2019 5:32 PM To: nvaccess/nvda <nvda@noreply.github.com> Cc: Joseph Lee <joseph.lee22590@gmail.com>; Author <author@noreply.github.com> Subject: Re: [nvaccess/nvda] Logging: add an option to turn logging off altogether (#8596) The changelog entry for this PR should probably be changed from: New features: It is possible to turn off NVDA's logging features off by setting logging level to "disabled" from General settings panel. (#8516 <#8516> ) To: New features: It is possible to turn off NVDA's logging features by setting the logging level to "disabled" from the General settings panel. (#8516 <#8516> ) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#8596 (comment)> , or mute the thread <https://github.com/notifications/unsubscribe-auth/AHgLkH36nTMFN1MxIXHCtaZb91OyXnOIks5vCoyLgaJpZM4Vv0U1> .

josephsl added 8 commits August 1, 2018 22:32

Log handler: update copyright headers

b3ef9f0

Log handler/level names: Python 3 split this into two dictionaries (n…

091e929

…ote).

Log handler: add support for no logging switch. Re nvaccess#8516.

634497f

Switch to null logger if no logging flag is turned on via command-line switches. Also, detect log level of 'OFF' and set log level accordingly (to 100).

Log handler: log level 100 -> Logger.OFF. Re nvaccess#8516.

c9684a4

Settings/General panel: add 'disabled' as a log level. Re nvaccess#8516.

0df4ad5

Merge branch 'master' into i8516noLogging

ca9928d

josephsl added 2 commits August 15, 2018 08:07

Merge branch 'master' into i8516noLogging

187221f

User guide: add log levels for I/O and debugwarning log levels.

359174b

derekriemer reviewed Aug 26, 2018

View reviewed changes

Comment thread source/nvda.pyw Outdated

Comment thread user_docs/en/userGuide.t2t

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t

Merge branch 'master' into i8516noLogging

a0737c2

User guide: address review actions.

b835815

Add notes about privacy for I/O and debug logging levels, along with word usage changes.

derekriemer approved these changes Sep 2, 2018

View reviewed changes

Merge branch 'master' into i8516noLogging

51d73eb

Merge branch 'master' into i8516noLogging

855aaff

ehollig requested a review from feerrenrut October 25, 2018 03:07

DrSooom mentioned this pull request Oct 26, 2018

Show warning prompt after initialling nvda.ini if the logging level isn't set to "INFO" or to "OFF" #8515

Open

feerrenrut suggested changes Dec 14, 2018

View reviewed changes

Merge branch 'master' into i8516noLogging

e2b1b65

josephsl added 3 commits December 14, 2018 09:42

User guide: edit descriptions for various command line options, espec…

95995ce

…ially logging options.

derekriemer approved these changes Dec 16, 2018

View reviewed changes

feerrenrut approved these changes Dec 17, 2018

View reviewed changes

Update changes file for PR nvaccess#8596

3017700

feerrenrut merged commit 5e710da into nvaccess:master Dec 17, 2018

nvaccessAuto added this to the 2018.4 milestone Dec 17, 2018

josephsl deleted the i8516noLogging branch April 2, 2019 03:36

This was referenced Dec 5, 2022

Use only supported log levels for command line option #14406

Merged

Fix-up 14406: restore combo-box to set log level in GUI parameters. #14432

Closed

Uh oh!

Conversation

josephsl commented Aug 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

Uh oh!

LeonarddeR commented Aug 6, 2018

Uh oh!

josephsl commented Aug 6, 2018 via email • edited by feerrenrut Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Brian1Gaff commented Aug 6, 2018 via email • edited by feerrenrut Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DrSooom commented Aug 7, 2018

Uh oh!

josephsl commented Aug 7, 2018 via email • edited by feerrenrut Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DrSooom commented Aug 8, 2018

Uh oh!

josephsl commented Aug 8, 2018 via email • edited by feerrenrut Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

derekriemer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josephsl commented Aug 31, 2018

Uh oh!

josephsl commented Oct 14, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feerrenrut Dec 14, 2018

Choose a reason for hiding this comment

Uh oh!

feerrenrut commented Dec 14, 2018

Uh oh!

codeofdusk commented Jan 13, 2019

Uh oh!

josephsl commented Jan 13, 2019 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

josephsl commented Aug 6, 2018 •

edited

Loading

josephsl commented Aug 6, 2018 via email •

edited by feerrenrut

Loading

Brian1Gaff commented Aug 6, 2018 via email •

edited by feerrenrut

Loading

josephsl commented Aug 7, 2018 via email •

edited by feerrenrut

Loading

josephsl commented Aug 8, 2018 via email •

edited by feerrenrut

Loading