Skip to content
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.

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

add a setting to enable/disable telemetry #101

Merged
merged 6 commits into from
Nov 5, 2024
Merged

add a setting to enable/disable telemetry #101

merged 6 commits into from
Nov 5, 2024

Conversation

vabarbosa
Copy link
Collaborator

Description

this PR adds a new qiskitCodeAssistant.enableTelemetry setting to enable/disable whether telemetry is collected for the extension.

Linked Issue(s)

Fixes #98

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

manually tested the setting on and off and confirmed whether data was sent to and collected by the server.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@vabarbosa vabarbosa self-assigned this Nov 4, 2024
@vabarbosa vabarbosa requested a review from cbjuan as a code owner November 4, 2024 04:31
Copy link
Member

@cbjuan cbjuan left a comment

Choose a reason for hiding this comment

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

We should extend the comment in GETTING_STARTED.md to reflect which kind of telemetry we do gather

@vabarbosa
Copy link
Collaborator Author

We should extend the comment in GETTING_STARTED.md to reflect which kind of telemetry we do gather

good idea! the comment has been updated to reflect what is collected.

any feedback on the phrasing is appreciated. thanks

Copy link
Member

@cbjuan cbjuan left a comment

Choose a reason for hiding this comment

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

Last comments before approval. Looks good!

Comment on lines +92 to +95
1. The Telemetry can be disabled by unchecking the `qiskitCodeAssistant.enableTelemetry` setting or turning `off` the `telemetry.telemetryLevel` setting:

> **NOTE**: The telemetry does not collect your code nor the suggested code completions. What is collected is whether a code suggestion was accepted or dismissed.

Copy link
Member

@cbjuan cbjuan Nov 5, 2024

Choose a reason for hiding this comment

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

Suggested change
1. The Telemetry can be disabled by unchecking the `qiskitCodeAssistant.enableTelemetry` setting or turning `off` the `telemetry.telemetryLevel` setting:
> **NOTE**: The telemetry does not collect your code nor the suggested code completions. What is collected is whether a code suggestion was accepted or dismissed.
2. The Telemetry can be disabled by unchecking the `qiskitCodeAssistant.enableTelemetry` setting or turning `off` the `telemetry.telemetryLevel` setting:
> **NOTE**: The telemetry does not collect your code nor the suggested code completions. What is collected is whether a code suggestion was accepted or dismissed.

shouldn't it be 2 in the numbering?

Copy link
Member

Choose a reason for hiding this comment

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

Let's add the same to the README after the /~https://github.com/Qiskit/qiskit-code-assistant-vscode?tab=readme-ov-file#keyboard-shortcuts so we do the same as in jupyterlab

Copy link
Collaborator Author

@vabarbosa vabarbosa Nov 5, 2024

Choose a reason for hiding this comment

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

shouldn't it be 2 in the numbering?

it doesnt matter. the markdown rendering/preview will update/display the numbering correctly. i tend to just use all 1.'s so i dont have to worry about keeping them updated accordingly as we add/remove items from list.

Let's add the same to the README after the /~https://github.com/Qiskit/qiskit-code-assistant-vscode?tab=readme-ov-file#keyboard-shortcuts so we do the same as in jupyterlab

done! 23e7a76

Copy link
Member

@cbjuan cbjuan left a comment

Choose a reason for hiding this comment

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

Let's go!

@vabarbosa vabarbosa merged commit b5820eb into main Nov 5, 2024
1 check passed
@vabarbosa vabarbosa deleted the va-telemetry branch November 5, 2024 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow users to configure the telemetry
2 participants