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

Make phone home behavior opt-in #7435

Closed
jonforums opened this issue Jan 31, 2024 · 5 comments
Closed

Make phone home behavior opt-in #7435

jonforums opened this issue Jan 31, 2024 · 5 comments
Assignees
Labels
cli customer issue documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jonforums
Copy link

Read your blogs, interesting idea, and finally got around to trying dolt only to be greeted by this sad message

PS $ dolt version
dolt version 1.32.3
Warning: you are on an old version of Dolt. The newest version is 1.32.4.

Really, the siren song of auto phone home features in the name of convenience remains that strong?

Didn't find mention of dolt's behavior in the README. Didn't find mention of dolt's behavior in the docs.

Didn't even find a way to opt-in/opt-out via an envar.

But did find the phone home code.

Consider making any phone home behavior opt-in via an envar and prominently document it. While I dislike deno's opt-out rather than opt-in stance, at least they documented the envar needed to disable phone home auto version checks.

@timsehn timsehn added enhancement New feature or request documentation Improvements or additions to documentation labels Jan 31, 2024
@timsehn
Copy link
Contributor

timsehn commented Jan 31, 2024

This feature is rather new. It was implemented in December.

#3417

I agree there should be an env var to disable the behavior.

@timsehn timsehn added the cli label Jan 31, 2024
@timsehn
Copy link
Contributor

timsehn commented Jan 31, 2024

You'll also notice this "phones home" to GitHub not "home" per se. We do not collect metrics off of it.

client := github.NewClient(nil)

We do collect usage metrics from each client which you can disable. @zachmu is most familiar with that code.

@zachmu
Copy link
Member

zachmu commented Jan 31, 2024

Hi @jonforums,

We're updating the docs to mention how to disable any phoning home behavior. In the meantime, you can run this command to opt out of anonymous metrics collection:

dolt config --global --add metrics.disabled true

@timsehn
Copy link
Contributor

timsehn commented Jan 31, 2024

After some internal discussion, we are going to do the following things:

  1. Make an env var to disable version checks to GitHub and document it in the actual message it sends. Something like:
$ dolt version
dolt version 1.32.3
Warning: you are on an old version of Dolt. The newest version is 1.32.4.
Set DOLT_DISABLE_VERSION_CHECKS = 1 to disable this check.

We will send this once for each new version. of the client, not on every call to dolt version.

  1. We will document the client metrics behavior in our FAQ (https://docs.dolthub.com/other/faq). Our README is quite long so I bet it has a better chance being found in the FAQ. I don't think it's the right thing for product adoption to lead with it in the README.

@timsehn
Copy link
Contributor

timsehn commented Feb 6, 2024

These action items are complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli customer issue documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants