Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ensure types used in telemetry are strongly typed #2904

Closed
DonJayamanne opened this issue Oct 16, 2018 · 2 comments
Closed

Ensure types used in telemetry are strongly typed #2904

DonJayamanne opened this issue Oct 16, 2018 · 2 comments
Assignees
@DonJayamanne
Labels
debt Covers everything internal: CI, testing, refactoring of the codebase, etc.

Comments

@DonJayamanne
Copy link

DonJayamanne commented Oct 16, 2018 •
edited
Loading

Ensuring the type names map easily to the telemetry names, makes it easier to discover (avoids having to document or keep documentation in sync) properties captured in the Telemetry.

We should also consider adding strongly typed members for the durations component of telemetry.
@DonJayamanne DonJayamanne added needs PR debt Covers everything internal: CI, testing, refactoring of the codebase, etc. labels Oct 16, 2018
@DonJayamanne DonJayamanne self-assigned this Jan 15, 2019
@DonJayamanne DonJayamanne mentioned this issue Jan 15, 2019
Merged
3 tasks
@DonJayamanne DonJayamanne changed the title Ensure type names match with the telemetry names Ensure types used in telemetry are strongly typed Jan 17, 2019
@DonJayamanne DonJayamanne mentioned this issue Jan 17, 2019
Merged
5 tasks
@DonJayamanne
Copy link
Author

Benefit of the change:

  • Today when we use sendTelemetryEvent we pass in the event name and some properties. The two go hand in hand. However there's no way to ensure that we pass in all valid properties for a given telemetry.
    This PR will ensure that given a telemetry event we can define the exact telemetry properties that are expected.
  • Benefits - strong typing & looking at one file we can tell exactly what will be captured.

DonJayamanne added a commit that referenced this issue Jan 17, 2019
@DonJayamanne
Use enums for telemetry event names (#3992)
3eb481f 
For #2904 (part 1 for #2904)
DonJayamanne added a commit that referenced this issue Jan 17, 2019
@DonJayamanne
Strong typing of telemetry properties (#4031)
3f78993 
For #2904
@DonJayamanne
Copy link
Author

Fixed in latest release

@ghost ghost removed the needs PR label Jan 30, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Feb 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@DonJayamanne DonJayamanne

Labels
debt Covers everything internal: CI, testing, refactoring of the codebase, etc.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@DonJayamanne