feat(telemetry): add PostHog event tracking to publish and run commands #1607
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
commit: |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
.vscode/settings.json
Outdated
| }, | ||
| "[jsonc]": { | ||
| "editor.defaultFormatter": "esbenp.prettier-vscode" |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
…o-release workflow
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new telemetry system for the Codemod CLI that tracks usage analytics via PostHog. The implementation adds event tracking to the publish and run commands to gather insights on how these features are being used in practice.
- Added a new
codemod-telemetrycrate with PostHog integration and null sender for opt-out scenarios - Integrated telemetry into
codemod publishandcodemod runcommands with execution statistics - Added environment variable support for disabling analytics and build-time PostHog API key injection
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/telemetry/* | New telemetry crate with PostHog sender and null sender implementations |
| crates/core/src/engine.rs | Added global execution statistics tracking via OnceLock |
| crates/cli/src/main.rs | Integrated telemetry sender initialization and dependency injection |
| crates/cli/src/commands/run.rs | Added telemetry events for codemod execution with success/failure tracking |
| crates/cli/src/commands/publish.rs | Added telemetry event for successful codemod publishing |
| Cargo.toml files | Updated dependencies and workspace configuration |
| .github/workflows/cargo-release.yml | Added PostHog API key environment variable for builds |
crates/cli/src/commands/run.rs
Outdated
| None, | ||
| ) | ||
| .await; | ||
| return Err(anyhow::anyhow!("Error executing codemod: {}", e)); |
There was a problem hiding this comment.
The original error information is being lost by wrapping it in a new anyhow error with just the Display representation. Consider using return Err(e) or .context() to preserve the error chain.
Copilot uses AI. Check for mistakes.
📚 Description
This PR introduces a new
telemetrycrate and integrates PostHog event tracking into thepublishandruncommands. The goal is to help Codemod better understand how these commands are being used in practice and gather insights for future improvements.telemetrycrate for sending eventscodemod publishcodemod runThis lays the foundation for richer product analytics across the CLI.
🧪 Test Plan
codemod publishandcodemod runlocally with a valid PostHog token