You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: telemetry/telemetryformat.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,16 +30,16 @@ _metrics_ is an array that contains the actual metrics posted to the service.
30
30
-`name` defines the metric name
31
31
- it must be in the format `namespace_camelCaseName` (e.g. `s3_objectUpload`).
32
32
- it must be in the format `{namespace}_{noun}{Verb}` (eg: `toolkit_moduleInit`)
33
+
- This format enables a natural grouping of related metrics in our definitions file, as well as improved searchability.
33
34
- Common Namespaces:
34
35
-`toolkit_` is for general non-feature-specific metrics created by the toolkit. Eg: `toolkit_moduleOpen`
35
36
-`ide_` is for IDE specific metrics, not controlled by our extension. Eg: `ide_editorOpen`
36
-
- NOTE: due to legacy reasons the above spec may not be followed, but all future definitions must follow it.
37
+
- NOTE: legacy metrics don't always follow the above rules, but new definitions must follow them.
37
38
-`description` explains what the metric means
38
-
- put effort to explaining the metrics purpose in detail. This tends to be the source of truth for
39
-
what the metric actually means and how it should be used.
40
-
-`metadata` contains data from `types` that define characteristics of the telemetry beyond
41
-
`createTime` and a `value`.
42
-
- This field is optional, but default `types` are automatically added regardless.
39
+
- put effort to explaining the metrics purpose in detail. This tends to be the source of truth for what the metric actually means and how it should be used.
40
+
- if a metric is deprecated, it must be indicated here
41
+
-`metadata` contains fields (`types`) that define characteristics of the telemetry beyond `createTime` and a `value`.
42
+
- This field is optional, but default fields (`types`) are always present on generated metrics.
0 commit comments