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

docs(telemetry): update instructions for disabling telemetry #1715

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/source/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ If present, an environment variable's value takes precedence over all other meth
| `APOLLO_HOME` | The path to the parent directory of Rover's binary. The default value is your operating system's default home directory. Rover will install itself in a folder called `.rover` inside the directory specified. |
| `APOLLO_CONFIG_HOME` | The path where Rover's configuration is stored. The default value is your operating system's default configuration directory. |
| `APOLLO_KEY` | The API key that Rover should use to authenticate with Apollo Studio. |
| `APOLLO_TELEMETRY_DISABLED` | Set to `1` if you don't want Rover to collect anonymous usage data. |
| `APOLLO_TELEMETRY_DISABLED` | Set to `true` if you don't want Rover to collect anonymous usage data. |
| `APOLLO_VCS_REMOTE_URL` | The URL of your project's remote repository. See [Git context](#git-context). |
| `APOLLO_VCS_BRANCH` | The name of the version-controlled branch. See [Git context](#git-context). |
| `APOLLO_VCS_COMMIT` | The long identifier (SHA in Git) of the commit. See [Git context](#git-context). |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/privacy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Privacy and data collection

By default, Rover collects some anonymous usage data to help us improve the tool.

**To opt out of data collection,** set the `APOLLO_TELEMETRY_DISABLED` environment variable to `1` in each environment where you use Rover.
**To opt out of data collection,** set the `APOLLO_TELEMETRY_DISABLED` environment variable to `true` in each environment where you use Rover.

> Rover doesn't collect _any_ personally identifiable information (such as API keys, graph names, or file paths). For more information, see Apollo collects and uses this data, see [our privacy policy](https://www.apollographql.com/Apollo-Privacy-Policy.pdf).

Expand Down
2 changes: 1 addition & 1 deletion installers/npm/binary.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ const install = (suppressLogs = false) => {
// for the curl installer.
if (!suppressLogs) {
console.error(
"If you would like to disable Rover's anonymized usage collection, you can set APOLLO_TELEMETRY_DISABLED=1"
"If you would like to disable Rover's anonymized usage collection, you can set APOLLO_TELEMETRY_DISABLED=true"
);
console.error(
"You can check out our documentation at https://go.apollo.dev/r/docs."
Expand Down
11 changes: 9 additions & 2 deletions src/utils/telemetry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ impl Report for Rover {
tracing::info!("Telemetry has been disabled.");
} else {
tracing::info!(
"Telemetry is enabled. To disable, set ${}=1",
"Telemetry is enabled. To disable, set ${}=true",
RoverEnvKey::TelemetryDisabled.to_string()
)
}
Expand Down Expand Up @@ -191,7 +191,14 @@ mod tests {
.insert_env_var(RoverEnvKey::TelemetryDisabled, "1")
.unwrap();
let expect_enabled = false;
let is_telemetry_enabled = rover.is_telemetry_enabled().unwrap();
let mut is_telemetry_enabled = rover.is_telemetry_enabled().unwrap();

assert_eq!(is_telemetry_enabled, expect_enabled);

rover
.insert_env_var(RoverEnvKey::TelemetryDisabled, "true")
.unwrap();
is_telemetry_enabled = rover.is_telemetry_enabled().unwrap();

assert_eq!(is_telemetry_enabled, expect_enabled);
}
Expand Down