Better telemetry through metadata #103
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jgellin-sf
requested review from
amphro,
code0100fun,
dehru,
jonnyhork,
mysticflute,
praksb and
tmock12
as code owners
Contributor
|
I like the reason addition. I'm wondering if we could also keep the descriptive test do possibly display to the user? and when i'm sending to telemetry i will only send the reason field.
|
Contributor
Author
|
@dehru The existing properties remain, so you can still get the actual syntax that is causing the syntax to be out of support. Is this what you mean, or do you think there should be additional descriptive text? |
Contributor
Yes, that's what i mean. Perfect. Thanks JG! |
dehru
approved these changes
Dec 15, 2020
Contributor
|
Combining mine and jon's PRs into one since they need to be integrated anyway. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR adds some metadata to the model that can be useful for telemetry. Currently, telemetry reports the number of unmodeled syntax objects and the number of errors in a query model. A more qualitative approach would allow us to make better inferences from the telemetric data. For example, it is more useful to know that a query has unmodeled syntax because of the presences of a semi-join than simply that it has 1 instance of unmodeled syntax.
This PR classifies unmodeled syntax objects with a
reasonproperty that accounts for why that particular model object is unmodeled. It also adds agrammarRuleproperty toModelErrorwhich shows which grammar rule the error takes place in. Combined with the type of error ('UNKNOWN', 'INCOMPLETEFROM', etc), this tells us much more about an error than simply that there is one.The changes in telemetry that these changes to the model can support are illustrated in the following examples.
Quantitative telemetry (current):
Qualitative telemetry:
What issues does this PR fix or reference?
@W-8547957@