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 disable telemetry #14

Merged
merged 6 commits into from
Nov 5, 2024
Merged

Add a setting to disable telemetry #14

merged 6 commits into from
Nov 5, 2024

Conversation

ajbozarth
Copy link
Collaborator

@ajbozarth ajbozarth commented Oct 30, 2024

Description

This adds a new enableTelemetry boolean JupyterLab setting that is checked before sending a POST call to prompt/<id>/acceptance.
The default value is true.

Linked Issue(s)

Fixes #10

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Manual testing by switching the setting on and off and checking the inspector network tab to see if the acceptance endpoint is called after accepting a prompt in various ways.

Screenshot 2024-10-30 at 1 30 49 PM

This adds a new `enableTelemetry` boolean jupyterlab setting that is checked
before sending a prompt acceptance post. This new flag is enabled by default.
@ajbozarth ajbozarth added the enhancement New feature or request label Oct 30, 2024
@ajbozarth ajbozarth self-assigned this Oct 30, 2024
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 need to add a minimal comment to the README explaining that there is the option to disable the telemetry.

@ajbozarth
Copy link
Collaborator Author

We need to add a minimal comment to the README explaining that there is the option to disable the telemetry.

done

Copy link
Collaborator

@vabarbosa vabarbosa left a comment

Choose a reason for hiding this comment

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

just had a very minor suggestion

schema/plugin.json Outdated Show resolved Hide resolved
GETTING_STARTED.md Outdated Show resolved Hide resolved
README-PyPi.md Outdated Show resolved Hide resolved
@cbjuan
Copy link
Member

cbjuan commented Nov 4, 2024

Complementing @vabarbosa comment, we should extend the comment in GETTING_STARTED.md and README-PyPi.md to reflect which kind of telemetry we do gather (prompt acceptance)

@ajbozarth
Copy link
Collaborator Author

we should extend the comment in GETTING_STARTED.md and README-PyPi.md to reflect which kind of telemetry we do gather (prompt acceptance)

@cbjuan what should it say then? I left it open ended intentionally in case we add more telemetry

@cbjuan
Copy link
Member

cbjuan commented Nov 5, 2024

@ajbozarth this is what @vabarbosa added into the vscode PR Qiskit/qiskit-code-assistant-vscode#101

> **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. and I think is good enough to start with

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.

Thanks!

@ajbozarth ajbozarth merged commit 98d89d5 into main Nov 5, 2024
6 checks passed
@ajbozarth ajbozarth deleted the telemetry branch November 5, 2024 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow users to configure the telemetry
3 participants