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

apollographql · Aug 22, 2023 · 27e2531 · 27e2531
1 parent 9a39dde
commit 27e2531
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/docs/source/configuring.md b/docs/source/configuring.md
@@ -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). |

diff --git a/docs/source/privacy.mdx b/docs/source/privacy.mdx
@@ -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).
 

diff --git a/installers/npm/binary.js b/installers/npm/binary.js
@@ -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."

diff --git a/src/utils/telemetry.rs b/src/utils/telemetry.rs
@@ -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()
             )
         }
@@ -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);
     }