Add Anonymous Telemetry #223
Merged
Conversation
This file contains hidden or 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
…e telemetry tracking.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces anonymous telemetry tracking to Orra, allowing minimal usage data to be collected (in a privacy‐preserving way) with an opt-out option. Key changes include:
- Adding telemetry tracking events in various orchestration, service, and server lifecycle methods.
- Creating a new TelemetryService with methods to track events based on hashed IDs.
- Updating documentation, changelogs, and configuration to reflect telemetry data collection.
Reviewed Changes
Copilot reviewed 19 out of 21 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| releases/... | Version and changelog updates for SDK, Plan Engine, and CLI |
| planengine/types.go | Added TelemetrySvc field to PlanEngine structure |
| planengine/telemetry.go | New TelemetryService implementation for event tracking |
| planengine/orchestrate.go | Tracking telemetry events for orchestration failures and attempts |
| planengine/main.go | Initialization of TelemetryService and client integration |
| planengine/events.go | Definition of telemetry event constants |
| planengine/engine.go | Added telemetry tracking in service registration, grounding, etc. |
| planengine/compworker.go | Tracking telemetry events for compensation workers |
| planengine/app_test.go | Updated tests to include telemetry service dependency |
| docs/telemetry.md | Documentation describing telemetry functionality and opt-out |
| README.md | README updates with telemetry information |
Files not reviewed (2)
- planengine/_env: Language not supported
- planengine/go.mod: Language not supported
Comments suppressed due to low confidence (1)
planengine/config.go:44
- [nitpick] Consider renaming 'AnonymouseIDFilename' to 'AnonymousIDFilename' to avoid potential confusion.
AnonymouseIDFilename = "orra.telemetry.uuid"
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Updates
Orra now collects minimal, anonymous usage data to help improve the project.
Only hashed project and execution plan IDs are tracked-no personal data or IP addresses.
Telemetry is opt-out: set ANONYMIZED_TELEMETRY=false in your environment or .env file.
Added documentation that explains how telemetry works with links to the actual code.
General project README updates.