-
Notifications
You must be signed in to change notification settings - Fork 312
/
Copy pathtelemetry.ts
4400 lines (4371 loc) · 148 KB
/
telemetry.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
/* eslint-disable @typescript-eslint/no-explicit-any */
import { Telemetry } from './platform/common/constants';
import { CheckboxState, EventName, SliceOperationSource } from './platform/telemetry/constants';
import { DebuggingTelemetry } from './notebooks/debugger/constants';
import { EnvironmentType } from './platform/pythonEnvironments/info';
import { TelemetryErrorProperties } from './platform/errors/types';
import { ExportFormat } from './notebooks/export/types';
import {
InterruptResult,
KernelActionSource,
KernelConnectionMetadata,
KernelInterpreterDependencyResponse
} from './kernels/types';
// eslint-disable-next-line
import { PreferredKernelExactMatchReason } from './notebooks/controllers/types';
import { ExcludeType, PickType } from './platform/common/utils/misc';
import { SharedPropertyMapping } from './platform/telemetry/index';
import { IExtensionApi } from './standalone/api';
import { IExportedKernelService, Kernel, Kernels } from './api';
export * from './platform/telemetry/index';
export type DurationMeasurement = {
/**
* Duration of a measure in milliseconds.
* Common measurement used across a number of events.
*/
duration: number;
};
export type ResourceTypeTelemetryProperty = {
/**
* Used to determine whether this event is related to a Notebooks or Interactive window.
* Common to most of the events.
*/
resourceType?: 'notebook' | 'interactive';
};
type Owner = 'donjayamanne' | 'amunger' | 'IanMatthewHuff' | 'rebornix' | 'roblourens' | 'unknown';
type Feature =
| 'Notebook'
| 'InteractiveWindow'
| 'PlotViewer'
| 'DataFrameViewer'
| 'Debugger'
| 'KernelPicker'
| 'Import-Export'
| 'VariableViewer';
type EventTag = 'Cell Execution' | 'Remote' | 'Widgets' | 'KernelStartup' | 'IntelliSense' | 'Code Execution';
type EventSource = 'User Action' | 'N/A';
type IGdprEventData = {
owner: Owner;
// We extract the jsdoc comments from IEvenNamePropertyMapping found in in telemetry.ts.
// comment: string;
expiration?: string;
/**
* We extract the jsdoc comments from IEvenNamePropertyMapping found in in telemetry.ts.
* If this as well as jsDoc is empty, we'll generate an error. At least one of them must be provided.
* jsDoc comments have been around for a while, hence will be the default.
*/
comment?: string;
};
type ICustomEventData = {
/**
* General feature area of the event.
*/
feature: 'N/A' | Feature[];
/**
* Useful way to categorize events.
*/
tags?: EventTag[];
/**
* Did the user perform an action that triggered this event, or was it something something else.
* Useful for others to determine whether this is a user action or not.
*/
source: EventSource;
};
export type IEventData = IGdprEventData & ICustomEventData;
/**
* Used to define an individual property (data item) of an Event.
*/
type IBasePropertyData = {
/**
* EndUserPseudonymizedInformation is what allows us to identify a particular user across time, although we don't know the actual identity of the user. machineId or instanceId fall in this category.
* PublicPersonalData and PublicNonPersonalData is information that users provide us with, for example, publisher information on the marketplace.
* CustomerContent is information the user generated such as urls of repositories or custom snippets.
* CallstackOrException is for error data like callbacks and exceptions. Everything else is SystemMetaData.
*/
classification:
| 'SystemMetaData'
| 'CallstackOrException'
| 'CustomerContent'
| 'PublicNonPersonalData'
| 'EndUserPseudonymizedInformation';
/**
* FeatureInsight or PerformanceAndHealth.
* We only use BusinessInsight for events generated by surveys.
*/
purpose: 'PerformanceAndHealth' | 'FeatureInsight' | 'BusinessInsight';
/**
* Used to specify a reason for collecting the event. This is meant to be more descriptive than `classification` & `purpose`.
* (if not specified here, then we need jsDoc comments for the corresponding property).
* The telemetry generation tool will ensure we have necessary comments.
*/
comment?: string;
/**
* Used if you would like to dictate the max product version this telemetry event should be sent in.
* This allows external tools to specify which events should be removed from the codebase.
*/
expiration?: string;
/**
* Defaults to none. That's appropriate for pretty much all properties rather than a couple of common properties.
*
* @type {string}
* @memberof IPropertyData
*/
endpoint?: string;
};
export type IPropertyDataNonMeasurement = IBasePropertyData & {
/**
* If numbers to are to be sent, they must be sent as measures.
*/
isMeasurement?: false;
};
export type IPropertyDataMeasurement = IBasePropertyData & {
/**
* Numbers are handled differently in the telemetry system.
*/
isMeasurement: true;
};
/**
* This will include all of the properties for an Event.
* This will also include common properties such as error properties, duration, etc.
*/
type AllEventPropertiesData<T> = {
[P in keyof Required<T>]: Required<T>[P] extends number ? IPropertyDataMeasurement : IPropertyDataNonMeasurement;
};
/**
* This will include all of the properties for an Event, excluding the common properties.
* These are the properties that need to be documented and defined.
*/
type EventPropertiesData<T> = AllEventPropertiesData<T>;
type GdprEventDefinition<P> = P extends never | undefined
? IEventData
: keyof EventPropertiesData<ExcludeType<ExcludeType<P, number>, number | undefined>> extends never | undefined
? IEventData & {
measures: EventPropertiesData<PickType<P, number | undefined>> | EventPropertiesData<PickType<P, number>>;
}
: keyof (EventPropertiesData<PickType<P, number | undefined>> & EventPropertiesData<PickType<P, number>>) extends
| never
| undefined
? IEventData & {
properties: EventPropertiesData<ExcludeType<ExcludeType<P, number>, number | undefined>>;
}
: IEventData & {
measures: EventPropertiesData<PickType<P, number | undefined>> | EventPropertiesData<PickType<P, number>>;
properties: EventPropertiesData<ExcludeType<ExcludeType<P, number>, number | undefined>>;
};
type PropertyMeasureDefinition<P> = P extends never
? never
: keyof EventPropertiesData<ExcludeType<ExcludeType<P, number>, number | undefined>> extends never
? {
measures: EventPropertiesData<PickType<P, number | undefined>> | EventPropertiesData<PickType<P, number>>;
}
: keyof (EventPropertiesData<PickType<P, number | undefined>> &
EventPropertiesData<PickType<P, number>>) extends never
? {
properties: EventPropertiesData<ExcludeType<ExcludeType<P, number>, number | undefined>>;
}
: {
measures: EventPropertiesData<PickType<P, number | undefined>> | EventPropertiesData<PickType<P, number>>;
properties: EventPropertiesData<ExcludeType<ExcludeType<P, number>, number | undefined>>;
};
function globallySharedProperties(): PropertyMeasureDefinition<SharedPropertyMapping>['properties'] {
return {
isInsiderExtension: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight',
comment: 'Whether this is the Insider version of the Jupyter extension or not. Common to all events.'
},
isPythonExtensionInstalled: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight',
comment: 'Whether Python extension is installed or not. Common to all events.'
},
rawKernelSupported: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight',
comment: 'Whether the raw kernel is supported or not. Common to all events.'
}
};
}
function commonClassificationForDurationProperties(): PropertyMeasureDefinition<DurationMeasurement>['measures'] {
return {
duration: {
classification: 'PublicNonPersonalData',
purpose: 'PerformanceAndHealth',
isMeasurement: true
}
};
}
function commonClassificationForResourceType(): PropertyMeasureDefinition<ResourceTypeTelemetryProperty>['properties'] {
return {
resourceType: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'FeatureInsight'
}
};
}
function commonClassificationForErrorProperties(): PropertyMeasureDefinition<TelemetryErrorProperties>['properties'] {
return {
failed: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
failureCategory: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
failureSubCategory: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
pythonErrorFile: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
pythonErrorFolder: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
pythonErrorPackage: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
stackTrace: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
}
};
}
function commonClassificationForResourceSpecificTelemetryProperties(): PropertyMeasureDefinition<ResourceSpecificTelemetryProperties> {
return {
properties: {
actionSource: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
disableUI: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
userExecutedCell: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
resourceHash: {
classification: 'PublicNonPersonalData',
purpose: 'PerformanceAndHealth'
},
pythonEnvironmentVersion: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
pythonEnvironmentType: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
pythonEnvironmentPath: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
pythonEnvironmentPackages: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
kernelSessionId: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
kernelLanguage: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
kernelSpecHash: {
classification: 'EndUserPseudonymizedInformation',
purpose: 'FeatureInsight'
},
kernelId: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
kernelConnectionType: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
isUsingActiveInterpreter: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
capturedEnvVars: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
newKernelPicker: {
classification: 'PublicNonPersonalData',
comment: '',
purpose: 'PerformanceAndHealth'
},
...commonClassificationForResourceType()
}
};
}
export const CommonProperties = {
...commonClassificationForDurationProperties(),
...commonClassificationForErrorProperties(),
// ...commonClassificationForResourceSpecificTelemetryProperties(),
// ...commonClassificationForResourceType(),
...globallySharedProperties()
};
export const CommonPropertyAndMeasureTypeNames = [
'ResourceSpecificTelemetryProperties',
'DurationMeasurement',
'ResourceTypeTelemetryProperty',
'TelemetryErrorProperties'
];
export type TelemetryEventInfo<P> = GdprEventDefinition<P>;
export type ResourceSpecificTelemetryProperties = ResourceTypeTelemetryProperty &
Partial<{
/**
* Whether the user executed a cell.
* Common to most of the events.
*/
userExecutedCell?: boolean;
/**
* Hash of the Kernel Connection id.
* Common to most of the events.
*/
kernelId: string;
/**
* Hash of the kernelspec file (so we do not end up with duplicate telemetry for the same user in same session)
*/
kernelSpecHash: string;
/**
* Whether the notebook startup UI (progress indicator & the like) was displayed to the user or not.
* If its not displayed, then its considered an auto start (start in the background, like pre-warming kernel)
* Common to most of the events.
*/
disableUI?: boolean;
/**
* Hash of the resource (notebook.uri or pythonfile.uri associated with this).
* If we run the same notebook tomorrow, the hash will be the same.
* Used to check whether a particular notebook fails across time or not.
* This is also used to map different telemetry events related to this same resource. E.g. we could have an event sent for starting a notebook with this hash,
* and then later we get yet another event indicating starting a notebook failed. And another event indicating the Python environment used for this notebook is a conda environment or
* we have some other event indicating some other piece of data for this resource. With the information across multiple resources we can now join the different data points
* and have a better understanding of what is going on, e.g. why something failed.
* Common to most of the events.
*/
resourceHash?: string;
/**
* Unique identifier for an instance of a notebook session.
* If we restart or run this notebook tomorrow, this id will be different.
* Id could be something as simple as a hash of the current Epoch time.
* Common to most of the events.
*/
kernelSessionId: string;
/**
* Whether this resource is using the active Python interpreter or not.
* Common to most of the events.
*/
isUsingActiveInterpreter?: boolean;
/**
* Found plenty of issues when starting kernels with conda, hence useful to capture this info.
* Common to most of the events.
*/
pythonEnvironmentType?: EnvironmentType;
/**
* A key, so that rest of the information is tied to this. (hash)
* Common to most of the events.
*/
pythonEnvironmentPath?: string;
/**
* Found plenty of issues when starting Conda Python 3.7, Python 3.7 Python 3.9 (in early days when ipykernel was not up to date)
* Common to most of the events.
*/
pythonEnvironmentVersion?: string;
/**
* Comma delimited list of hashed packages & their versions.
* Common to most of the events.
*/
pythonEnvironmentPackages?: string;
/**
* Whether kernel was started using kernel spec, interpreter, etc.
* Common to most of the events.
*/
kernelConnectionType?: KernelConnectionMetadata['kind'];
/**
* Language of the kernel connection.
* Common to most of the events.
*/
kernelLanguage: string;
/**
* Whether this was started by Jupyter extension or a 3rd party.
* Common to most of the events.
*/
actionSource: KernelActionSource;
/**
* Whether we managed to capture the environment variables or not.
* In the case of conda environments, `false` would be an error condition, as we must have env variables for conda to work.
* Common to most of the events.
*/
capturedEnvVars?: boolean;
/**
* Whether using the new kernel picker or not.
* This will be obsolete once we ship the new kernel picker.
*/
newKernelPicker?: boolean;
}>;
export class IEventNamePropertyMapping {
/**
* Telemetry event sent with perf measures related to activation and loading of extension.
*/
public [EventName.EXTENSION_LOAD]: TelemetryEventInfo<{
/**
* Number of workspace folders opened
*/
workspaceFolderCount: number;
/**
* Time taken to activate the extension.
*/
totalActivateTime: number;
/**
* Total time to load the modules.
*/
codeLoadingTime: number;
}> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
measures: {
totalActivateTime: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth',
isMeasurement: true
},
codeLoadingTime: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth',
isMeasurement: true
},
workspaceFolderCount: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth',
isMeasurement: true
}
}
};
/**
* Telemetry event sent with perf measures related to loading experiments.
*/
public [Telemetry.ExperimentLoad]: TelemetryEventInfo<DurationMeasurement> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
measures: commonClassificationForDurationProperties()
};
/**
* Telemetry event sent when substituting Environment variables to calculate value of variables.
* E.g. user has a a .env file with tokens that need to be replaced with env variables.
* such as an env file having the variable `${HOME}`.
* Gives us an idea of whether users have variable references in their .env files or not.
*/
[EventName.ENVFILE_VARIABLE_SUBSTITUTION]: TelemetryEventInfo<undefined> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A'
};
/**
* Telemetry event sent when an environment file is detected in the workspace.
*/
[EventName.ENVFILE_WORKSPACE]: TelemetryEventInfo<undefined> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A'
};
/**
* Telemetry event sent with hash of an imported python package.
* Used to detect the popularity of a package, that would help determine which packages
* need to be prioritized when resolving issues with intellisense or supporting similar issues related to a (known) specific package.
*/
[EventName.HASHED_PACKAGE_NAME]: TelemetryEventInfo<
{
/**
* Hash of the package name
*/
hashedNamev2: string;
/**
* Whether the package was detected in an existing file (upon open, upon save, upon close) or when it was being used during execution.
*/
when: 'onExecution' | 'onOpenCloseOrSave';
} & ResourceTypeTelemetryProperty
> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
properties: {
hashedNamev2: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
when: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
...commonClassificationForResourceType()
}
};
/**
* Total time taken by Python extension to return the active Python environment.
*/
[Telemetry.ActiveInterpreterListingPerf]: TelemetryEventInfo<{
/**
* Whether this is the first time in the session.
* (fetching kernels first time in the session is slower, later its cached).
* This is a generic property supported for all telemetry (sent by decorators).
*/
firstTime?: boolean;
/**
* Total time taken to list interpreters.
*/
duration: number;
}> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
properties: {
firstTime: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth'
}
},
measures: commonClassificationForDurationProperties()
};
/**
* Mime type of a cell output.
* Used to detect the popularity of a mime type, that would help determine which mime types are most common.
* E.g. if we see widget mimetype, then we know how many use ipywidgets and the like and helps us prioritize widget issues,
* or prioritize rendering of widgets when opening an existing notebook or the like.
*/
[Telemetry.CellOutputMimeType]: TelemetryEventInfo<
{
/**
* Mimetype of the output.
*/
mimeType: string;
/**
* Whether the package was detected in an existing file (upon open, upon save, upon close) or when it was being used during execution.
*/
when: 'onExecution' | 'onOpenCloseOrSave';
} & ResourceTypeTelemetryProperty
> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
properties: {
mimeType: {
classification: 'PublicNonPersonalData',
purpose: 'FeatureInsight'
},
when: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
...commonClassificationForResourceType()
}
};
/**
* Used to capture time taken to get environment variables for a python environment.
* Also lets us know whether it worked or not.
*/
[Telemetry.GetActivatedEnvironmentVariables]: TelemetryEventInfo<{
/**
* Type of the Python environment.
*/
envType?: EnvironmentType;
/**
* Whether the env variables were fetched successfully or not.
*/
failed: boolean;
/**
* Source where the env variables were fetched from.
* If `python`, then env variables were fetched from Python extension.
* If `jupyter`, then env variables were fetched from Jupyter extension.
*/
source: 'python' | 'jupyter';
/**
* Reason for not being able to get the env variables.
*/
reason?:
| 'noActivationCommands'
| 'unknownOS'
| 'emptyVariables'
| 'unhandledError'
| 'emptyFromCondaRun'
| 'emptyFromPython'
| 'condaActivationFailed'
| 'failedToGetActivatedEnvVariablesFromPython'
| 'failedToGetCustomEnvVariables';
/**
* Time taken.
*/
duration: number;
}> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
properties: {
envType: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
failed: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth'
},
reason: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth'
},
source: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
}
},
measures: commonClassificationForDurationProperties()
};
/**
* Telemetry event sent when user opens the data viewer via the variable view.
*/
[EventName.OPEN_DATAVIEWER_FROM_VARIABLE_WINDOW_REQUEST]: TelemetryEventInfo<never | undefined> = {
owner: 'IanMatthewHuff',
source: 'User Action',
feature: ['DataFrameViewer', 'VariableViewer']
};
/**
* Telemetry event sent when user opens the data viewer via the variable view and there is an error in doing so.
*/
[EventName.OPEN_DATAVIEWER_FROM_VARIABLE_WINDOW_ERROR]: TelemetryEventInfo<never | undefined> = {
owner: 'IanMatthewHuff',
source: 'N/A',
feature: ['DataFrameViewer', 'VariableViewer']
};
/**
* Telemetry event sent when user opens the data viewer via the variable view and we successfully open the view.
*/
[EventName.OPEN_DATAVIEWER_FROM_VARIABLE_WINDOW_SUCCESS]: TelemetryEventInfo<never | undefined> = {
owner: 'IanMatthewHuff',
source: 'User Action',
feature: ['DataFrameViewer', 'VariableViewer']
};
/**
* User adds a cell below the current cell for IW.
*/
[Telemetry.AddCellBelow]: TelemetryEventInfo<DurationMeasurement> = {
owner: 'amunger',
feature: ['InteractiveWindow'],
source: 'User Action',
measures: commonClassificationForDurationProperties()
};
/**
* How long on average we spent parsing code lens. Sent on shutdown.
* We should be able to deprecate in favor of DocumentWithCodeCells, but we should compare the numbers first.
**/
[Telemetry.CodeLensAverageAcquisitionTime]: TelemetryEventInfo<DurationMeasurement> = {
owner: 'amunger',
feature: ['InteractiveWindow'],
source: 'User Action',
measures: commonClassificationForDurationProperties()
};
/**
* Info about code lenses, count and average time to parse the document.
**/
[Telemetry.DocumentWithCodeCells]: TelemetryEventInfo<{
/**
* Average time taken to aquire code lenses for a document without using the cache
**/
codeLensUpdateTime: number;
/**
* Maximum number of code lenses returned for the document
**/
maxCellCount: number;
}> = {
owner: 'amunger',
feature: ['InteractiveWindow'],
source: 'N/A',
measures: {
codeLensUpdateTime: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth',
isMeasurement: true
},
maxCellCount: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight',
isMeasurement: true
}
}
};
/**
* Telemetry event sent when user hits the `continue` button while debugging IW
*/
[Telemetry.DebugContinue]: TelemetryEventInfo<never | undefined> = {
owner: 'roblourens',
feature: ['Debugger'],
source: 'User Action'
};
/**
* Telemetry event sent when user debugs the cell in the IW
*/
[Telemetry.DebugCurrentCell]: TelemetryEventInfo<never | undefined> = {
owner: 'roblourens',
feature: ['Debugger'],
source: 'User Action'
};
/**
* Telemetry event sent when user hits the `step over` button while debugging IW
*/
[Telemetry.DebugStepOver]: TelemetryEventInfo<never | undefined> = {
owner: 'roblourens',
feature: ['Debugger'],
source: 'User Action'
};
/**
* Telemetry event sent when user hits the `stop` button while debugging IW
*/
[Telemetry.DebugStop]: TelemetryEventInfo<never | undefined> = {
owner: 'roblourens',
feature: ['Debugger'],
source: 'User Action'
};
/**
* Telemetry event sent when user debugs the file in the IW
*/
[Telemetry.DebugFileInteractive]: TelemetryEventInfo<never | undefined> = {
owner: 'roblourens',
feature: ['Debugger'],
source: 'User Action'
};
/**
* How often we wait to fetch remote kernel specs or how long it takes to fetch them.
*/
[Telemetry.JupyterKernelSpecEnumeration]: TelemetryEventInfo<
| {
/**
* Failure to enumerate kernel specs
*/
failed: true;
/**
* Whether Jupyter session manager was ready before we started.
*/
sessionManagerReady?: boolean;
/**
* Whether Jupyter spec manager was ready before we started.
*/
specsManagerReady?: boolean;
/**
* Reason for the failure
*/
reason:
| 'NoSpecsManager'
| 'SpecsDidNotChangeInTime'
| 'NoSpecsEventAfterRefresh'
| 'SpecManagerIsNotReady'
| 'SessionManagerIsNotReady';
}
| (DurationMeasurement & {
/**
* Whether Jupyter session manager was ready before we started.
*/
wasSessionManagerReady: boolean;
/**
* Whether Jupyter spec manager was ready before we started.
*/
wasSpecsManagerReady: boolean;
/**
* Whether Jupyter session manager was ready after we started.
*/
sessionManagerReady: boolean;
/**
* Whether Jupyter spec manager was ready after we started.
*/
specsManagerReady: boolean;
})
> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
tags: ['KernelStartup'],
properties: {
...commonClassificationForErrorProperties(),
failed: {
classification: 'CallstackOrException',
purpose: 'PerformanceAndHealth'
},
reason: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth',
comment: 'Reason for failure to fetch kernel specs'
},
sessionManagerReady: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth'
},
specsManagerReady: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth'
},
wasSessionManagerReady: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth'
},
wasSpecsManagerReady: {
classification: 'SystemMetaData',
purpose: 'PerformanceAndHealth'
}
},
measures: commonClassificationForDurationProperties()
};
/**
* Information about KernelSpecs
*/
[Telemetry.KernelSpec]: TelemetryEventInfo<{
/**
* Unique Id of this Server
*/
serverIdHash: string;
/**
* Extension that owns (provided) this Jupyter Url
*/
providerExtensionId: string;
/**
* Hash of the kernelspec file (so we do not end up with duplicate telemetry for the same user in same session)
*/
kernelSpecHash: string;
/**
* Has of the origin/base Url.
*/
baseUrlHash: string;
/**
* Hash of the Kernel Connection id.
*/
kernelId: string;
/**
* What kind of kernel spec did we fail to create.
*/
kernelConnectionType:
| 'startUsingPythonInterpreter'
| 'startUsingLocalKernelSpec'
| 'startUsingRemoteKernelSpec'
| 'connectToLiveRemoteKernel';
/**
* Language of the kernel spec.
*/
kernelLanguage: string | undefined;
/**
* Type of the Python environment.
*/
envType?: EnvironmentType;
/**
* Whether the argv0 is same as the interpreter.
*/
isArgv0SameAsInterpreter?: boolean;
/**
* First argument of the kernelSpec argv (without the full path)
* Helps determine if we have python/conda executables used for kernelSpecs.
*/
argv0?: string;
/**
* argv of KernelSpec
* Helps determine if we have ipykernel, ipykernel_launcher, etc and other combinations
* In the case of paths, all path values are stripped, exe names are not.
*/
argv?: string;
}> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',
properties: {
kernelSpecHash: {
classification: 'EndUserPseudonymizedInformation',
purpose: 'FeatureInsight'
},
serverIdHash: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
providerExtensionId: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
baseUrlHash: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
kernelId: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
kernelConnectionType: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
kernelLanguage: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
envType: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
isArgv0SameAsInterpreter: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
argv0: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
},
argv: {
classification: 'SystemMetaData',
purpose: 'FeatureInsight'
}
}
};
/**
* Sent when user enters a Remote Jupyter Url
*/
[Telemetry.EnterRemoteJupyterUrl]: TelemetryEventInfo<{
/**
* Unique Id of this Server
*/
serverIdHash: string;
/**
* Has of the origin/base Url.
*/
baseUrlHash: string;
/**
* Whether user is connecting to the local host.
*/
isLocalHost: boolean;
/**
* Whether this is Jupyter Hub or not.
*/
isJupyterHub: boolean;
/**
* Whether the Url was successfully validated or not.
*/
failed?: boolean;
/**
* Failure reason.
*/
reason?: 'ConnectionFailure' | 'InsecureHTTP' | 'SelfCert' | 'ExpiredCert' | 'AuthFailure';
}> = {
owner: 'donjayamanne',
feature: 'N/A',
source: 'N/A',