feat: introduce telemetry - Githubissues

kubeshop / vscode-monokle

An extension for Visual Studio Code to validate your Kubernetes configuration

https://marketplace.visualstudio.com/items?itemName=kubeshop.monokle

MIT License

6 stars 0 forks source link

feat: introduce telemetry #33

Closed f1ames closed 1 year ago

f1ames commented 1 year ago

This PR fixes #24.

Based on #31 and should be merged after it.

Changes

Introduced Telemetry, see below for events list with properties.
Added enableTelemetry config option (trueby default).
Was inspired by Desktop, so we have install and session events based on similar logic as Desktop has.
Used machineId provided by VSC env.
Each event also sends native VSC sessionId. This can be used to group all events from single session (new session is when VSC instance is started/restarted).
There is VSC native TelemetryLogger, but I realized a bit too late. Still I think what we have now is quite stable and good enough for now.

https://github.com/kubeshop/vscode-monokle/blob/02dc37e543b1f9e73c0062dca9d602869f677448/src/utils/telemetry.ts#L69-L97

Fixes

None.

Checklist

[x] tested locally
[x] added new dependencies
[x] updated the docs
[ ] added a test

f1ames commented 1 year ago

I rechecked if we can send telemetry events differently, so properties are split in MixPanel instead of being shown as single property, but it seems this is how @segment/analytics-node works and there is no easy way to change it.