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

Telemetry implementation for Kiota #3264

Open
baywet opened this issue Sep 7, 2023 · 4 comments
Open

Telemetry implementation for Kiota #3264

baywet opened this issue Sep 7, 2023 · 4 comments
Labels
enhancement New feature or request generator Issues or improvements relater to generation capabilities. needs more information
Milestone

Comments

@baywet
Copy link
Member

baywet commented Sep 7, 2023

Follow up to #2933

The current telemetry implemented in the vscode extension gives us some level of understanding of usage and patterns. We should refine this and extend it to the CLI itself since the extension is only a small portion of our audience.
The dotnet CLI is most likely how we should model it.

The telemetry should print a message on first call for the version, so people are aware anonymized data is being collected and have an option to opt out.
This message should not be displayed in CI (check the environment variable) as we might want to disable the telemetry in CI scenarios to avoid "noise".

The extension should probably pass a session id to the CLI through the RPS service so we can track dependencies end to end in case of crashes.

Pointers to the dotnet CLI implementation.
sdk/src/Cli/dotnet/Telemetry/Telemetry.cs at main · dotnet/sdk · GitHub
the metrics they collect sdk/src/Cli/dotnet/Telemetry/TelemetryCommonProperties.cs at main · dotnet/sdk · GitHub
they use some filters for some commands sdk/src/Cli/dotnet/Telemetry/TelemetryFilter.cs at main · dotnet/sdk · GitHub
sdk/src/Cli/dotnet/Telemetry/TelemetryFilter.cs at 72b4ede487d5e03fa58fb0df27ad2188e261242c · dotnet/sdk · GitHub

Before we move on to the implementation, we need to refine what should be collected, what shouldn't, and what questions are we trying to answer

@baywet baywet added enhancement New feature or request needs more information generator Issues or improvements relater to generation capabilities. labels Sep 7, 2023
@baywet baywet added this to the Kiota v1.8 milestone Sep 7, 2023
@baywet baywet added this to Kiota Sep 7, 2023
@github-project-automation github-project-automation bot moved this to Todo in Kiota Sep 7, 2023
@sebastienlevert sebastienlevert modified the milestones: Kiota v1.8, Kiota v1.9 Oct 6, 2023
@baywet baywet modified the milestones: Kiota v1.9, Kiota v1.10 Nov 28, 2023
@baywet baywet modified the milestones: Kiota v1.10, Kiota v1.11 Jan 11, 2024
@sebastienlevert
Copy link
Contributor

You can follow our journey here while we're building the specs for this capability #4063.

@baywet baywet modified the milestones: Kiota v1.11, Kiota v1.12 Jan 30, 2024
@petrhollayms petrhollayms changed the title Telemetry implementation for the CLI Telemetry implementation for Kiota CLI Feb 21, 2024
@sebastienlevert sebastienlevert changed the title Telemetry implementation for Kiota CLI Telemetry implementation for Kiota Feb 29, 2024
@baywet baywet self-assigned this Mar 4, 2024
@baywet baywet modified the milestones: Kiota v1.12, Kiota v1.13 Mar 4, 2024
@baywet
Copy link
Member Author

baywet commented Apr 24, 2024

Slight update here. The spec of what to collect and how to opt out is pretty much ready. We have received the feedback it might alienate some users and are reviewing our options now. @sebastienlevert to confirm the plans at a later time, no work to be done for now.

@baywet baywet modified the milestones: Kiota v1.14, Backlog Apr 24, 2024
@baywet baywet moved this from Todo 📃 to In Design 🎨 in Kiota Apr 24, 2024
@baywet baywet removed their assignment Apr 24, 2024
@sebastienlevert
Copy link
Contributor

We'll keep this issue open for some time. But as of today, our decision is to rely on the telemetry already provided by the VS Code implementation that is all guided by the VS Code telemetry guidelines.

@maisarissi maisarissi moved this from In Design 🎨 to Ready for development 🧑‍💻 in Kiota Jan 24, 2025
@maisarissi
Copy link
Contributor

Due to the new work planned to provide Kiota as a npm package that will be consumed by TTK and TypeSpec, we will need to implement telemetry so we can track usage, identify improvements and understand how our customers are using the capabilities we are offering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request generator Issues or improvements relater to generation capabilities. needs more information
Projects
Status: Ready for development 🧑‍💻
Development

No branches or pull requests

4 participants