From 76b85ec0267e2d966ae709176a75be8a89a665e3 Mon Sep 17 00:00:00 2001 From: Bob Brown Date: Wed, 19 Jul 2017 21:35:52 -0700 Subject: [PATCH] Create Enabling logging.md --- Documentation/LanguageServer/Enabling logging.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Documentation/LanguageServer/Enabling logging.md diff --git a/Documentation/LanguageServer/Enabling logging.md b/Documentation/LanguageServer/Enabling logging.md new file mode 100644 index 0000000000..b61520ca9c --- /dev/null +++ b/Documentation/LanguageServer/Enabling logging.md @@ -0,0 +1,16 @@ +# How to enable logging in the extension + +If you are experiencing a problem that we are unable to diagnose based on information in your issue request, we might ask you to enable logging and send us your logs. + +Logging is controlled by environment variables and is disabled by default. To enable logging launch VS Code from an environment that contains the following variables: + +``` +VSCODE_CPP_LOGDIR=c:\path\to\logfolder +VSCODE_CPP_LOGFILE_LEVEL=5 +``` + +When you open your folder in VS Code, we will create a vscode.cpp.log.\.txt file for each extension process launched (\ = process id). + +The log file level is a number that determines how much detail we'll log. Level 5 is generally detailed enough to give us information about what is going on in your session. We don't recommend you set this higher than 7 since the log quickly becomes cluttered with information that doesn't really help us diagnose your issues and actually makes it harder for us to spot the problem. It will also slow down the extension considerably and may make it harder for you to reproduce your problem. + +**Don't forget to remove the environment variables when you are finished providing us with the logs.** You wouldn't want the extension to needlessly spend CPU time and disk space writing data you don't need into log files.