Add telemetry collection

Uses vscode-commons in order to collect telemetry. Please refer to USAGE_DATA.md to see what telemetry data is collected. Closes redhat-developer#415 Signed-off-by: David Thompson <davthomp@redhat.com>
datho7561 · Feb 25, 2021 · d7a8e22 · d7a8e22
1 parent 34d84a7
commit d7a8e22
Show file tree

Hide file tree

Showing 9 changed files with 454 additions and 44 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1,42 +1,45 @@
 // A launch configuration that compiles the extension and then opens it inside a new window
 {
   "version": "0.2.0",
-  "configurations": [
-      {
-          "name": "Launch Extension",
-          "type": "extensionHost",
-          "request": "launch",
-          "runtimeExecutable": "${execPath}",
-          "args": ["--extensionDevelopmentPath=${workspaceRoot}" ],
-          "stopOnEntry": false,
-          "sourceMaps": true,
-          "outFiles": [ "${workspaceRoot}/dist/**/*.js" ],
-          "preLaunchTask": "npm: watch"
-      },
-      {
-        "name": "Launch Extension & Wait for remote debugger",
-        "type": "extensionHost",
-        "request": "launch",
-        "runtimeExecutable": "${execPath}",
-        "args": ["--extensionDevelopmentPath=${workspaceRoot}" ],
-        "stopOnEntry": false,
-        "sourceMaps": true,
-        "outFiles": [ "${workspaceRoot}/dist/**/*.js" ],
-        "preLaunchTask": "npm: watch",
-        "env": {
-            "SUSPEND_SERVER":"true"
-        }
+  "configurations": [{
+      "name": "Launch Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
+      "stopOnEntry": false,
+      "sourceMaps": true,
+      "outFiles": ["${workspaceRoot}/dist/**/*.js"],
+      "preLaunchTask": "npm: watch",
+      "env": {
+        "VSCODE_REDHAT_TELEMETRY_DEBUG": "true"
+      }
     },
-      {
-          "name": "Launch Tests",
-          "type": "extensionHost",
-          "request": "launch",
-          "runtimeExecutable": "${execPath}",
-          "args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test" ],
-          "stopOnEntry": false,
-          "sourceMaps": true,
-          "outFiles": [ "${workspaceRoot}/dist/**/*.js"  ],
-          "preLaunchTask": "npm: watch"
+    {
+      "name": "Launch Extension & Wait for remote debugger",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
+      "stopOnEntry": false,
+      "sourceMaps": true,
+      "outFiles": ["${workspaceRoot}/dist/**/*.js"],
+      "preLaunchTask": "npm: watch",
+      "env": {
+        "SUSPEND_SERVER": "true",
+        "VSCODE_REDHAT_TELEMETRY_DEBUG": "true"
       }
+    },
+    {
+      "name": "Launch Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test"],
+      "stopOnEntry": false,
+      "sourceMaps": true,
+      "outFiles": ["${workspaceRoot}/dist/**/*.js"],
+      "preLaunchTask": "npm: watch"
+    }
   ]
-}
+}
diff --git a/USAGE_DATA.md b/USAGE_DATA.md
@@ -0,0 +1,27 @@
+# Data collection
+
+vscode-xml has opt-in telemetry collection, provided by [vscode-commons](https://github.com/redhat-developer/vscode-commons).
+
+## What's included in the vscode-xml telemetry data
+
+ * JVM information:
+    * Whether LemMinX is being run with Java or as a GraalVM native image (binary)
+    * The name of the vm (`java.vm.name`)
+    * The name of the runtime (`java.runtime.name`)
+    * The version of the JVM (`java.version`)
+    * The free, total, and max VM memory
+    * Does NOT include the `JAVA_HOME` environment variable for privacy reasons
+ * LemMinX Version information:
+    * The server version number
+ * The value of the `xml.server.preferBinary` setting
+ * A telemetry event is sent every time you click the "Download Java" link that appears when you have [LemMinX extensions](./docs/Extensions.md) installed but don't have Java installed.
+
+## What's included in the general telemetry data
+
+Please see the
+[vscode-commons data collection information](https://github.com/redhat-developer/vscode-commons/blob/master/USAGE_DATA.md#other-extensions)
+for information on what data it collects.
+
+## How to opt in or out
+
+Use the `redhat.telemetry.enabled` setting in order to enable or disable telemetry collection.