Skip to content

Commit fdf3320

Browse files
address PR comments
Signed-off-by: nkomonen-amazon <[email protected]>
1 parent e85aa7d commit fdf3320

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

telemetry/telemetryformat.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ _metrics_ is an array that contains the actual metrics posted to the service.
3030
- `name` defines the metric name
3131
- it must be in the format `namespace_camelCaseName` (e.g. `s3_objectUpload`).
3232
- 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.
3334
- Common Namespaces:
3435
- `toolkit_` is for general non-feature-specific metrics created by the toolkit. Eg: `toolkit_moduleOpen`
3536
- `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.
3738
- `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.
4343

4444
```
4545
"metrics": [

0 commit comments

Comments
 (0)