Skip to content

Add note about telemetry for CodeQL extension settings #15333

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 1 commit into from
Jan 16, 2024
Merged

Add note about telemetry for CodeQL extension settings #15333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions ...eql-for-visual-studio-code/about-telemetry-in-codeql-for-visual-studio-code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ If you opt in, GitHub collects the following information related to the usage of
- Randomly generated GUID that uniquely identifies a CodeQL extension installation. (Discarded before aggregation.)
- IP address of the client sending the telemetry data. (Discarded before aggregation.)
- Whether or not the ``codeQL.canary`` setting is enabled and set to ``true``.
- Whether any :doc:`CodeQL extension settings <customizing-settings>` are configured.
Copy link
Copy Markdown
Contributor

@robertbrignull robertbrignull Jan 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

codeQL.canary is also a CodeQL extension setting, so from a technical perspective it's odd to mention them in two separate lines. But I don't know what's more understandable for the user. I thought I'd mention this, but I think what's written here already is a perfectly fine explanation.

Copy link
Copy Markdown
Contributor Author

@shati-patel shati-patel Jan 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I wondered about that too! @jf205, any preference on whether we continue to call out the canary setting separately, or just include the general line about settings?


How long data is retained
--------------------------
Expand Down