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.

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

Plan to support Telemetry Collection for Emitter in TypeSpec VS Code Extension #5865

Open
3 of 5 tasks
lirenhe opened this issue Feb 5, 2025 · 2 comments
Open
3 of 5 tasks
Assignees
Labels
ide Issues for VS, VSCode, Monaco, etc.

Comments

@lirenhe
Copy link
Member

lirenhe commented Feb 5, 2025

Clear and concise description of the problem

Description:

We need to support telemetry collection from our emitters in the TypeSpec VS Code extension. It would include error when emitting fails, some of the options when emitter is triggered, etc.
The goal is to gather useful data to improve our CodeGen while ensuring compliance with privacy regulations such as GDPR.

Today, typespec extension could get all the logs that our emitters output, then we need to decide what information is useful for collection. This work is related to #5298

I don't think typespec extension would collect output for all emitters, a white list of emitter should be fine.

A couple of requirements for Telemetry collection

  • We would only log the success/failure of client/server emitters without other detailed information.
  • We need user identity to get a brief understanding of the behavior. e.g. How many times does a user invoke the client emitters, How often do they invoke a specific emitter.

cc @lmazuel

Checklist

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@lirenhe lirenhe added the ide Issues for VS, VSCode, Monaco, etc. label Feb 5, 2025
@lirenhe lirenhe changed the title Plan to support Telemetry Collection for Emitter that Microsoft owns in TypeSpec VS Code Extension Plan to support Telemetry Collection for Emitter in TypeSpec VS Code Extension Feb 5, 2025
@lirenhe
Copy link
Member Author

lirenhe commented Feb 13, 2025

@chunyu3, we also need the option to allow user to turn off the telemetry collection.

@RodgeFu RodgeFu assigned chunyu3 and unassigned lirenhe Feb 13, 2025
@RodgeFu
Copy link
Contributor

RodgeFu commented Feb 13, 2025

@chunyu3, we also need the option to allow user to turn off the telemetry collection.

vscode will help to handle it when we adopt its library which will be done in #5298 . thx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ide Issues for VS, VSCode, Monaco, etc.
Projects
None yet
Development

No branches or pull requests

3 participants