Skip to content

Docs: Describe custom log directory setting in VS Code extension #5946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shati-patel merged 2 commits into from
Jun 14, 2021
Merged

Docs: Describe custom log directory setting in VS Code extension #5946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
254c769
Docs: Describe custom log directory setting in VS Code extension
shati-patel May 21, 2021
bfc8845
Update wording
shati-patel May 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/codeql/codeql-for-visual-studio-code/customizing-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,17 @@ The query history **Format** setting controls how the extension lists queries in

To override the default label, you can specify a different format for the query history items.

.. _configuring-settings-for-running-queries:

Configuring settings for running queries
-----------------------------------------

There are a number of settings for **Running Queries**. If your queries run too slowly and time out frequently, you may want to increase the memory.

.. include:: ../reusables/running-queries-debug.rst

To save query server logs in a custom location, edit the **Running Queries: Custom Log Directory** setting. If you use a custom log directory, the extension saves the logs permanently, instead of deleting them automatically after each workspace session. This is useful if you want to investigate these logs to improve the performance of your queries.

Configuring settings for testing queries
-----------------------------------------

Expand Down
2 changes: 2 additions & 0 deletions ...codeql-for-visual-studio-code/troubleshooting-codeql-for-visual-studio-code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ You are most likely to need to restart the query server if you make external cha
To see the logs from running a particular query, right-click the query in the Query History and select **Show Query Log**.
If the log file is too large for the extension to open in the VS Code editor, the file will be displayed in your file explorer so you can open it with an external program.

By default, the extension deletes logs after each workspace session. To override this behavior, you can specify a custom directory for query server logs. For more information, see ":ref:`Customizing settings <configuring-settings-for-running-queries>`."

Exploring problems with running tests
----------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/codeql/reusables/running-queries-debug.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
If you want to examine query performance, enable the **Running Queries: Debug** setting to include timing and tuple counts in the CodeQL Query Server logs shown in the Output view. The tuple count is useful because it indicates the size of the :ref:`predicates <predicates>` computed by the query.
If you want to examine query performance, enable the **Running Queries: Debug** setting to include timing and tuple counts. This is shown in the logs in the CodeQL Query Server tab of the Output view. The tuple count is useful because it indicates the size of the :ref:`predicates <predicates>` computed by the query.