added privacy statement, telemetry doc (#411)
* added privacy statement, telemetry doc * Delete 0.0.0.0 * Update docs/telemetry.md Co-Authored-By: dandua98 <danish@dandua.com> * Update docs/telemetry.md Co-Authored-By: dandua98 <danish@dandua.com> * Update docs/telemetry.md Co-Authored-By: dandua98 <danish@dandua.com> * Update README.md Co-Authored-By: dandua98 <danish@dandua.com> * Update docs/telemetry.md Co-Authored-By: dandua98 <danish@dandua.com> * Update docs/telemetry.md Co-Authored-By: dandua98 <danish@dandua.com>
This commit is contained in:
Родитель
9b48fcb951
Коммит
18f7c0cbad
|
@ -42,6 +42,11 @@ Once you make the selections you want and click generate, you can quickly extend
|
|||
- [Getting started with the codebase](/docs/getting-started-developers.md)
|
||||
- [Terminology for developers](/docs/terminology.md)
|
||||
|
||||
# Privacy Statement
|
||||
|
||||
This extension logs basic [telemetry](/docs/telemetry.md) for what is being selected. We are in the process of creating a telemetry data page to summarize usage trends.
|
||||
this repository once it's available. Please read [Microsoft Privacy Statement](https://privacy.microsoft.com/en-US/privacystatement) for more information.
|
||||
|
||||
# Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
|
|
|
@ -0,0 +1,29 @@
|
|||
# Web Template Studio Telemetry
|
||||
|
||||
Web Template Studio logs usage data and diagnostics telemetry through [Application Insights](https://azure.microsoft.com/en-us/services/monitor/).
|
||||
|
||||
## Telemetry Gathered
|
||||
|
||||
The wizard for Web Template Studio collects basic diagnostics telemetry and usage data:
|
||||
|
||||
- **Diagnostics telemetry:** Unhandled error and exceptions that happened while running the
|
||||
wizard are logged with Application Insights. This includes the stack trace of the error
|
||||
- **Usage telemetry:** including wizard usage and user selections.
|
||||
|
||||
## Usage Telemetry
|
||||
|
||||
Through the Application Insights API, telemetry events are collected to gather basic information regarding Web Template Studio extension usage. The following table describes the Telemetry Events we collect:
|
||||
|
||||
| **Property** | **Note** |
|
||||
| :-------------------: | ---------------------------------------------------------------------------------------------------- |
|
||||
| **Event Time** | Timestamp for when the event occurred |
|
||||
| **Event Name** | Unique event name/descriptor for the event. For ex: WebTemplateStudioVsix/Azure-Functions-Deployment |
|
||||
| **VSCode Session ID** | A unique identifier for the current session. Changes each time the editor is started. |
|
||||
| **VSCode Machine ID** | A unique identifier for the computer |
|
||||
| **VSCode Version** | VSCode version being used by the user |
|
||||
| **Extension Version** | Web Template Studio extension version being used |
|
||||
| **OS** | User's operating system |
|
||||
| **Error** | Error description if an error occurs |
|
||||
| **Stack** | Error stack trace if an error occurs |
|
||||
| **Result** | If the event succeeded or not |
|
||||
|
|
@ -1 +0,0 @@
|
|||
/Users/t-keng/coding/WebTemplateStudio/src/extension/src/api/templates
|
Загрузка…
Ссылка в новой задаче