mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-11-24 09:08:59 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #9080 from dan-shaw/telemetry-update

Browse Source 
[vcpkg] update telemetry
This commit is contained in:
Robert Schumacher 2019-11-22 16:08:34 -08:00 committed by GitHub
commit cda348b6a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 59 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
docs/about/privacy.md
View File

@ -1,51 +1,45 @@
# Vcpkg telemetry and privacy
# Privacy and Vcpkg
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
## Do you collect telemetry data? What is it used for?
## Scope
We do collect telemetry data from usage of "vcpkg.exe". We explicitly ONLY collect information from invocations of the tool itself; we do NOT add any tracking information into the produced libraries. We use this information to understand usage issues, such as failing packages, and to guide tool improvements.
We explicitly ONLY collect information from invocations of the tool itself; we do NOT add any tracking information into the produced libraries. Telemetry is collected when using any of the `vcpkg` commands.
## What telemetry is collected?
## How to opt out
We collect the command line used, the time of invocation, and how long execution took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event.
In order to opt-out of data collection, you can re-run the boostrap script with the following flag, for Windows and Linux/OSX, respectively:
The vcpkg telemetry feature is enabled by default. In order to opt-out of data collection, you can re-run the boostrap script with the following flag, for Windows and Linux/OSX, respectively:
```PS> .\bootstrap-vcpkg.bat -disableMetrics```
```~/$ ./bootstrap-vcpkg.sh -disableMetrics```
For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-us/privacy.
## Disclosure
vcpkg displays text similar to the following when you build vcpkg. This is how Microsoft notifies you about data collection.
Here is an example of an event for the command line `vcpkg install zlib`:
```json
[{
"ver": 1,
"name": "Microsoft.ApplicationInsights.Event",
"time": "2016-09-01T00:19:10.949Z",
"sampleRate": 100.000000,
"seq": "0:0",
"iKey": "aaaaaaaa-4393-4dd9-ab8e-97e8fe6d7603",
"flags": 0.000000,
"tags": {
"ai.device.os": "Windows",
"ai.device.osVersion": "10.0.14912",
"ai.session.id": "aaaaaaaa-7c69-4b83-7d82-8a4198d7e88d",
"ai.user.id": "aaaaaaaa-c9ab-4bf5-0847-a3455f539754",
"ai.user.accountAcquisitionDate": "2016-08-20T00:38:09.860Z"
},
"data": {
"baseType": "EventData",
"baseData": {
"ver": 2,
"name": "commandline_test7",
"properties": { "version":"0.0.30-9b4e44a693459c0a618f370681f837de6dd95a30","cmdline":"install zlib","command":"install","installplan":"zlib:x86-windows" },
"measurements": { "elapsed_us":68064.355736 }
}
}
}]
```
In the source code (included in `toolsrc\`), you can search for calls to the functions `TrackProperty()` and `TrackMetric()` to see every specific data point we collect.
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.
## Is the data stored on my system?
Read more about vcpkg telemetry at docs/about/privacy.md
```
We store each event document in your temporary files directory. These will be cleaned out whenever you clear your temporary files.
## Data Collected
The telemetry feature doesn't collect personal data, such as usernames or email addresses. It doesn't scan your code and doesn't extract project-level data, such as name, repository, or author. The data is sent securely to Microsoft servers and held under restricted access.
Protecting your privacy is important to us. If you suspect the telemetry is collecting sensitive data or the data is being insecurely or inappropriately handled, file an issue in the Microsoft/vcpkg repository or send an email to vcpkg@microsoft.com for investigation.
We collect various telemetry events such as the command line used, the time of invocation, and how long execution took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event.
You can see the telemetry events any command by appending `--printmetrics` after the vcpkg command line.
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
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.

8
scripts/bootstrap.ps1
View File

@ -412,6 +412,14 @@ if ($ec -ne 0)
}
Write-Host "`nBuilding vcpkg.exe... done.`n"
Write-Host @"
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 bootstrap-vcpkg.bat with -disableMetrics.
Read more about vcpkg telemetry at docs/about/privacy.md
"@
Write-Verbose "Placing vcpkg.exe in the correct location"
Copy-Item "$vcpkgReleaseDir\vcpkg.exe" "$vcpkgRootDir\vcpkg.exe"

6
scripts/bootstrap.sh
View File

@ -262,3 +262,9 @@ mkdir -p "$buildDir"
rm -rf "$vcpkgRootDir/vcpkg"
cp "$buildDir/vcpkg" "$vcpkgRootDir/"
echo "Telemetry"
echo "---------"
echo "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 bootstrap-vcpkg.sh with -disableMetrics"
echo "Read more about vcpkg telemetry at docs/about/privacy.md"
echo ""

4
toolsrc/src/vcpkg.cpp
View File

@ -304,7 +304,6 @@ int main(const int argc, const char* const* const argv)
SetConsoleCP(CP_UTF8);
SetConsoleOutputCP(CP_UTF8);
const std::string trimmed_command_line = trim_path_from_command_line(Strings::to_utf8(GetCommandLineW()));
#endif
Checks::register_global_shutdown_handler([]() {
@ -335,9 +334,6 @@ int main(const int argc, const char* const* const argv)
{
auto locked_metrics = Metrics::g_metrics.lock();
locked_metrics->track_property("version", Commands::Version::version());
#if defined(_WIN32)
locked_metrics->track_property("cmdline", trimmed_command_line);
#endif
}
System::register_console_ctrl_handler();

10
toolsrc/src/vcpkg/build.cpp
View File

@ -580,7 +580,15 @@ namespace vcpkg::Build
{
auto locked_metrics = Metrics::g_metrics.lock();
locked_metrics->track_buildtime(spec.to_string() + ":[" + Strings::join(",", config.feature_list) + "]",
locked_metrics->track_buildtime(Hash::get_string_hash(spec.to_string(), Hash::Algorithm::Sha256) + ":[" +
Strings::join(",",
config.feature_list,
[](const std::string& feature) {
return Hash::get_string_hash(feature,
Hash::Algorithm::Sha256);
}) +
"]",
buildtimeus);
if (return_code != 0)
{

7
toolsrc/src/vcpkg/install.cpp
View File

@ -1,6 +1,7 @@
#include "pch.h"
#include <vcpkg/base/files.h>
#include <vcpkg/base/hash.h>
#include <vcpkg/base/system.print.h>
#include <vcpkg/base/util.h>
#include <vcpkg/build.h>
@ -690,13 +691,13 @@ namespace vcpkg::Install
// log the plan
const std::string specs_string = Strings::join(",", action_plan, [](const AnyAction& action) {
if (auto iaction = action.install_action.get())
return iaction->spec.to_string();
return Hash::get_string_hash(iaction->spec.to_string(), Hash::Algorithm::Sha256);
else if (auto raction = action.remove_action.get())
return "R$" + raction->spec.to_string();
return "R$" + Hash::get_string_hash(raction->spec.to_string(), Hash::Algorithm::Sha256);
Checks::unreachable(VCPKG_LINE_INFO);
});
Metrics::g_metrics.lock()->track_property("installplan", specs_string);
Metrics::g_metrics.lock()->track_property("installplan_1", specs_string);
Dependencies::print_plan(action_plan, is_recursive, paths.ports);

2
toolsrc/src/vcpkg/metrics.cpp
View File

@ -184,7 +184,7 @@ namespace vcpkg::Metrics
if (buildtime_names.size() > 0)
{
if (props_plus_buildtimes.size() > 0) props_plus_buildtimes.push_back(',');
props_plus_buildtimes.append(Strings::format(R"("buildnames": [%s], "buildtimes": [%s])",
props_plus_buildtimes.append(Strings::format(R"("buildnames_1": [%s], "buildtimes": [%s])",
Strings::join(",", buildtime_names, to_json_string),
Strings::join(",", buildtime_times)));
}