Add telemetry #6

DonJayamanne · 2017-11-03T16:57:57Z

No description provided.

DonJayamanne · 2017-11-03T16:58:53Z

@brettcannon I can't see the telemetry on app insights, there could be a delay in the data coming through. Will keep monitoring.

brettcannon

I think there's like one design question about an idea that may (or may not) make things easier to maintain, a spelling mistake in an attribute, and a change to the copyright headers.

brettcannon · 2017-11-03T18:06:48Z

src/client/common/telemetry/constants.ts

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.


// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License.

Less visibly jarring by dropping the --- lines, plus it doesn't mention the license file name since it's actually LICENSE in our case, but if we changed it I don't think we would want to update every single comment. 😉

copied this from VS Code.

I can go back and fix it, better now

I'll just fix the mentioning of the license file, easier than removing the lines

brettcannon · 2017-11-03T18:10:44Z

src/client/common/telemetry/index.ts

+                // tslint:disable-next-line:prefer-type-cast
+                (result as Promise<void>)
+                    .then(data => {
+                        sendTelemetryEvent(eventName, stopWatch.elpsedTime);


elapsedTime

brettcannon · 2017-11-03T18:11:26Z

src/client/common/telemetry/index.ts

+
+export function sendTelemetryEvent(eventName: string, durationMs?: number, properties?: TelemetryProperties) {
+    const reporter = getTelemetryReporter();
+    const measures = typeof durationMs === 'number' ? { duration: durationMs } : undefined;


Is there any reason we need to worry about the unit of measure changing? E.g. should as label the data as duration-ms?

I don't think we'll every want another unit (we can always do the math at the moment of reporting)

brettcannon · 2017-11-03T18:13:23Z

src/client/common/telemetry/index.ts

+}
+
+// tslint:disable-next-line:no-any function-name
+export function captureTelemetry(eventName: string) {


I miss context managers from Python.

brettcannon · 2017-11-03T18:14:55Z

src/client/common/telemetry/index.ts

+            // tslint:disable-next-line:no-invalid-this no-use-before-declare no-unsafe-any
+            const result = originalMethod.apply(this, args);
+
+            // If method being wrapped returns a promise then wait for it.


Is it worth having two separate functions, e.g. captureAsyncTelemetry() and captureTelemetry() to simplify this logic at all?

I don't think so, this is a decorator function (a decorator that can be applied to any method (sync or async).

e.g.

class Somethind { @captureTelemetry() public doSomethingSynchronously(){ } @captureTelemetry() public async doSomethingAsynchronously(){ } }

brettcannon · 2017-11-03T18:17:31Z

src/client/common/telemetry/vscode-extension-telemetry.d.ts

@@ -1,36 +1,30 @@
-declare module "vscode-extension-telemetry" {


Is there really no .d.ts file on npm for the package? If so, has that fact been reported upstream?

nope, everyone seems to be creating their own dts for this damn thing... can't understand why. plan was to create a dts a create PR (separate piece of work)

nothing to do here.

brettcannon · 2017-11-03T18:18:11Z

src/client/common/utils.ts

@@ -1,3 +1,7 @@
+/*---------------------------------------------------------------------------------------------


This should only be added to new files, not pre-existing ones where external contributors may have made changes.

brettcannon · 2017-11-03T18:21:46Z

src/client/interpreter/interpreterVersion.ts

+                if (stdout && stdout.length > 0) {
+                    // Take the second part, see below example.
+                    // pip 9.0.1 from /Users/donjayamanne/anaconda3/lib/python3.6/site-packages (python 3.6).
+                    const parts = stdout.split(' ');


Is it worth using a regex to avoid potential format changes that could break this and lead to accidentally capturing PII?

will do,
@brettcannon what's PII?

brettcannon · 2017-11-03T18:25:09Z

src/client/providers/execInTerminalProvider.ts

@@ -203,6 +210,7 @@ function execSelectionInDjangoShell() {
        terminal.sendText(unix_code);
    }
    terminal.show();
+    sendTelemetryEvent(EXECUTION_DJANGO, undefined, { scope: 'selection' });


I take it there's no way to execute Django as a file since that option isn't listed here?

brettcannon · 2017-11-03T18:30:20Z

src/test/interpreters/interpreterVersion.test.ts

+        const pyVersion = await interpreterVersion.getVersion('INVALID_INTERPRETER', 'DEFAULT_TEST_VALUE');
+        assert.equal(pyVersion, 'DEFAULT_TEST_VALUE', 'Incorrect version');
+    });
+    test('Must return the Pip Version', async () => {


You definitely do not need to change this, but as an FYI, the official capitalization is "pip" (all lower-case).

lol, i will deifinitely change this, as i'm making other chages.

…into Telemetry * 'Telemetry' of https://github.com/Microsoft/vscode-python: fixed unit tests incorrect telemetry scope for running unittests do not stop discovery when running tests

brettcannon

FYI I went through and removed the copyright header from all preexisting files. And since I was already doing that I just went ahead and tweaked the formatting for the new files.

* more corrections * Merge conflicts * corrections * Delete jupyterServerManager.unit.test.ts * corrections * CI

DonJayamanne added 20 commits November 2, 2017 08:35

remove unwanted and unused deps and features

d7304ab

enable decorators

0b5f90f

telemetry helper

4d93442

telemetry for activation of extension

0742155

moved type declaration close to source

5c1995b

changes to how conda version is captured

ba24f1b

telemetry for formatters

b9ae68f

telemetry added

731d374

capture telemetry when interpreter is set

83c2733

resolved linter warning

9c8ab22

added telemetry for workspace symbols

6d33aa7

added telemetry for code execution

2a53c3a

refactorred telemetry code

b7ee666

added telemetry for unit tests

70c6054

merged master

c69ff4a

added copyright header

2275821

fix test runner id

dfa30f7

more strictness for later

ad3efb4

add copyright header

8ba7495

tests for interpreter and pip version

c62743a

DonJayamanne requested a review from brettcannon November 3, 2017 16:57

DonJayamanne added 3 commits November 3, 2017 10:40

missed colon

27701cd

do not stop discovery when running tests

f40ce28

incorrect telemetry scope for running unittests

de928ad

brettcannon suggested changes Nov 3, 2017

View reviewed changes

DonJayamanne added 4 commits November 3, 2017 13:08

fixed unit tests

92ec931

fixed license headers

8a06e98

Merge branch 'Telemetry' of https://github.com/Microsoft/vscode-python …

167c781

…into Telemetry * 'Telemetry' of https://github.com/Microsoft/vscode-python: fixed unit tests incorrect telemetry scope for running unittests do not stop discovery when running tests

use regex when extracting version info

4b570a5

brettcannon added 24 commits November 3, 2017 15:54

Remove copyright header

e114788

Remove copyright header

a7f3e52

Remove copyright header

21b924f

Remove copyright header

da85710

Remove copyright header

f2d31f6

Remove copyright header

74ae430

Remove copyright header

93600b7

Remove copyright header

4e923af

Remove copyright header

a89fd8e

Remove copyright header

d6241ef

Remove copyright header

f736006

Remove copyright header

78c0d19

Remove copyright header

e330ef0

Remove copyright header

5168eb2

Remove copyright header

258a381

Remove copyright header

4247d9b

Remove copyright header

bb2826e

Remove copyright header

93c6561

Remove copyright header

c653c06

Remove copyright header

e55c15e

Remove copyright header

a1b9b26

Remove copyright header

7c56f5a

Simplify copyright header

ef467e2

Remove copyright header

b7100a7

brettcannon approved these changes Nov 3, 2017

View reviewed changes

DonJayamanne merged commit 45530ab into master Nov 3, 2017

DonJayamanne deleted the Telemetry branch November 6, 2017 23:28

pypros referenced this pull request in pypros/vscode-python Feb 20, 2019

Fixes#6 after review @soltysh

a1fddab

karrtikr pushed a commit that referenced this pull request Mar 5, 2019

Fix all typescript errors when compiled in strict mode #6 (#4422)

2c7f25c

* more corrections * Merge conflicts * corrections * Delete jupyterServerManager.unit.test.ts * corrections * CI

lock bot locked as resolved and limited conversation to collaborators Jul 31, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add telemetry #6

Add telemetry #6

DonJayamanne commented Nov 3, 2017

DonJayamanne commented Nov 3, 2017

brettcannon left a comment

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

DonJayamanne Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon Nov 3, 2017

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon Nov 3, 2017

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon Nov 3, 2017

DonJayamanne Nov 3, 2017

brettcannon left a comment

		@@ -0,0 +1,30 @@
		/*---------------------------------------------------------------------------------------------
		* Copyright (c) Microsoft Corporation. All rights reserved.

		@@ -1,36 +1,30 @@
		declare module "vscode-extension-telemetry" {

		@@ -1,3 +1,7 @@
		/*---------------------------------------------------------------------------------------------

Add telemetry #6

Add telemetry #6

Conversation

DonJayamanne commented Nov 3, 2017

DonJayamanne commented Nov 3, 2017

brettcannon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brettcannon left a comment

Choose a reason for hiding this comment