aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authornicole mazzuca <mazzucan@outlook.com>2020-05-29 14:09:03 -0700
committerGitHub <noreply@github.com>2020-05-29 14:09:03 -0700
commit09319cd79e3bee6a41bb76db739aef3f3644f19f (patch)
tree36e6b5bd5c17268edc062aa9c462f47fc4f400cf /docs
parenta64dc07690bc8806e717e190f62eb58e198b599c (diff)
downloadvcpkg-09319cd79e3bee6a41bb76db739aef3f3644f19f.tar.gz
vcpkg-09319cd79e3bee6a41bb76db739aef3f3644f19f.zip
[vcpkg metrics] Allow someone to opt out after build (#11542)
* [vcpkg metrics] start using json library Additionally, add floats to the JSON library since they're required. * [vcpkg metrics] allow users to disable metrics after the build Additionally, as a drive by, fix UUID generation * fix metrics data * code review
Diffstat (limited to 'docs')
-rw-r--r--docs/about/privacy.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/about/privacy.md b/docs/about/privacy.md
index 542f27614..76661a2c8 100644
--- a/docs/about/privacy.md
+++ b/docs/about/privacy.md
@@ -1,7 +1,7 @@
# Vcpkg telemetry and privacy
vcpkg collects telemetry data to understand usage issues, such as failing packages, and to guide tool improvements. The collected data is anonymous.
-For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-US/privacystatement#mainenterprisedeveloperproductsmodule
+For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-US/privacystatement#mainenterprisedeveloperproductsmodule
## Scope
@@ -22,7 +22,11 @@ vcpkg displays text similar to the following when you build vcpkg. This is how M
```
Telemetry
---------
-vcpkg collects usage data in order to help us improve your experience. The data collected by Microsoft is anonymous. You can opt-out of telemetry by re-running the bootstrap-vcpkg script with -disableMetrics.
+vcpkg collects usage data in order to help us improve your experience.
+The data collected by Microsoft is anonymous.
+You can opt-out of telemetry by re-running the bootstrap-vcpkg script with -disableMetrics,
+passing --disable-metrics to vcpkg on the command line,
+or by setting the VCPKG_DISABLE_METRICS environment variable.
Read more about vcpkg telemetry at docs/about/privacy.md
```
@@ -39,7 +43,7 @@ You can see the telemetry events any command by appending `--printmetrics` after
In the source code (included in `toolsrc\`), you can search for calls to the functions `track_property()` and `track_metric()` to see every specific data point we collect.
-## Avoid inadvertent disclosure information
+## Avoid inadvertent disclosure information
vcpkg contributors and anyone else running a version of vcpkg that they built themselves should consider the path to their source code. If a crash occurs when using vcpkg, the file path from the build machine is collected as part of the stack trace and isn't hashed.
Because of this, builds of vcpkg shouldn't be located in directories whose path names expose personal or sensitive information.