feat: refactor telemetry to use a more standardized format VSCODE-651 #891
Conversation
This file contains 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
gagik
commented
Nov 29, 2024
| const commandPrefix = command ? `/${command} ` : ''; | ||
| const query = `@MongoDB ${commandPrefix}${message}`; | ||
|
|
||
| if (telemetry) { |
There was a problem hiding this comment.
This is an example of it might be nice to structure tracking in other functions as some hot-pluggable thing.
addaleax
reviewed
Nov 30, 2024
| @@ -477,14 +517,14 @@ export default class TelemetryService { | |||
| command, | |||
| error_code: errorCode, | |||
| error_name: errorName, | |||
| }); | |||
| } as ParticipantResponseFailedProperties); | |||
There was a problem hiding this comment.
[non-blocking]
Suggested change
| } as ParticipantResponseFailedProperties); | |
| } satisfies ParticipantResponseFailedProperties); |
I think we can do this now, our TS version and tooling seems to be fine with it (and it's generally nicer since it avoids the behavior of as that allows type coercions even in case of mismatches)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Built on top of #890
Makes some minor quality of life improvements to our current telemetry setup, especially for
sendMessageToParticipant.telemetryfield insendMessageToParticipant(ideally a structure we could use in other places in the future?), which is meant to be a scalable structure for us to pass different arguments to functions we want to track without messing with our objects and too much manual work.commandfield in various telemetry functions stricter; introduce and cleanup some types to better fit this. Right now we are not keeping a good track of what we call acommandwhen sending telemetry, so this is hoping to document this better with types.Copilotprefix in places where it may be redundant or not match its property type.Let me know what you think; this was mainly me a result of me trying to understand & document our current setup better, would be happy to adjust accordingly 🙂