Skip to content

Commit

Permalink
Move telemetry doc content to ASP.NET Core docs (#438)
Browse files Browse the repository at this point in the history
  • Loading branch information
scottaddie authored Nov 11, 2020
1 parent 214cf81 commit fb26b80
Showing 1 changed file with 2 additions and 47 deletions.
49 changes: 2 additions & 47 deletions TELEMETRY.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,3 @@
# HttpRepl telemetry
# HTTP REPL telemetry

HttpRepl includes a telemetry feature that collects usage data. It's important that the HttpRepl team understands how the tool is used so it can be improved.

## How to opt out

The HttpRepl telemetry feature is enabled by default. To opt out of the telemetry feature, set the `DOTNET_HTTPREPL_TELEMETRY_OPTOUT` environment variable to `1` or `true`.

## Disclosure

HttpRepl displays text similar to the following when you first run the tool. Text may vary slightly depending on the version of the tool you're running. This "first run" experience is how Microsoft notifies you about data collection.

```console
Telemetry
---------
The .NET tools collect usage data in order to help us improve your experience. It is collected by Microsoft and shared with the community. You can opt-out of telemetry by setting the DOTNET_HTTPREPL_TELEMETRY_OPTOUT environment variable to '1' or 'true' using your favorite shell.
```

## Data points

The telemetry feature doesn't collect personal data, such as usernames or email addresses or URLs. It doesn't scan your HTTP requests or responses. 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 [dotnet/httprepl](https://github.com/dotnet/httprepl/issues) repository or send an email to [[email protected]](mailto:[email protected]) for investigation.

The telemetry feature collects the following data:

| SDK versions | Data |
|--------------|------|
| >=5.0 | Timestamp of invocation. |
| >=5.0 | Three octet IP address used to determine the geographical location. |
| >=5.0 | Operating system and version. |
| >=5.0 | Runtime ID (RID) the tool is running on. |
| >=5.0 | Whether the tool is running in a container. |
| >=5.0 | Hashed Media Access Control (MAC) address: a cryptographically (SHA256) hashed and unique ID for a machine. |
| >=5.0 | Kernel version. |
| >=5.0 | HttpRepl version. |
| >=5.0 | Whether or not the tool was started with help, run or connect arguments. Actual argument values are not collected. |
| >=5.0 | Command invoked (for example, "get") and whether or not it succeeded. |
| >=5.0 | For the `connect` command, whether or not the root, base or openapi arguments were supplied. Actual argument values are not collected. |
| >=5.0 | For the `pref` command, whether a `get` or `set` was issued and which preference was accessed. If not a well-known preference, the name is hashed. The value is not collected. |
| >=5.0 | For the `set header` command, the header name being set. If not a well-known header, the name is hashed. The value is not collected. |
| >=5.0 | For the `connect` command, whether or not a specific special-case for `dotnet new webapi` was used and, whether or not it was bypassed via preference. |
| >=5.0 | For all HTTP commands (e.g. GET, POST, PUT, etc), whether or not each of the options was specified. The values of the options are not collected. |

## See also

- [.NET Core SDK telemetry](https://docs.microsoft.com/en-us/dotnet/core/tools/telemetry)
- [.NET Core CLI Telemetry Data](https://dotnet.microsoft.com/platform/telemetry)
For information about the telemetry feature, see [HTTP REPL Telemetry](https://docs.microsoft.com/aspnet/core/web-api/http-repl/telemetry).

0 comments on commit fb26b80

Please sign in to comment.