Feature/telemetry catalog schema segmentation - #141
Merged
dimitar-radenkov merged 6 commits intoJul 25, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR formalizes Pointframe’s telemetry schema by introducing a centralized event catalog (with required property definitions and event channels) and wiring telemetry calls throughout the app to use catalog-backed constants. It also strengthens documentation guarantees by ensuring the README telemetry table stays synchronized with the catalog via unit tests, and adds an Application Insights workbook template for analytics.
Changes:
- Add
TelemetryEventCatalog/TelemetryEvents/TelemetryPropertyKeysto enforce a single source of truth for event names, required properties, and product vs diagnostic channel. - Update telemetry emission across ViewModels/services to use the catalog constants and to send
telemetry_channel+telemetry_schema_version. - Add tests to validate catalog rules and README documentation consistency, plus an App Insights workbook template.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Expands telemetry privacy table, documents schema/channel fields, and clarifies last_action behavior. |
| Pointframe/Views/OverlayWindow.Recording.cs | Switches recording telemetry calls to catalog constants/keys. |
| Pointframe/ViewModels/TrimViewModel.cs | Uses catalog event constants and routes trim exceptions through diagnostic exception tracking. |
| Pointframe/ViewModels/SettingsViewModel.cs | Adds settings/about telemetry events and introduces optional telemetry injection. |
| Pointframe/ViewModels/RecordingHudViewModel.cs | Adds HUD interaction telemetry and optional telemetry injection. |
| Pointframe/ViewModels/OverlayViewModel.cs | Replaces string-based telemetry with catalog events for overlay actions. |
| Pointframe/ViewModels/LibraryViewModel.cs | Moves library telemetry to catalog events and updates NullTelemetryService for new interface methods. |
| Pointframe/ViewModels/BeautifierViewModel.cs | Uses catalog telemetry events for beautify actions. |
| Pointframe/ViewModels/AnnotationViewModel.cs | Uses catalog telemetry events/keys for annotation commits. |
| Pointframe/ViewModels/AboutViewModel.cs | Adds about open/close and URL-host telemetry, with optional telemetry injection. |
| Pointframe/Services/Update/AutoUpdateService.cs | Uses catalog telemetry events/keys for update confirm/dismiss events. |
| Pointframe/Services/Infrastructure/TrayIconManager.cs | Uses catalog telemetry events for update check, trim open, and GIF export events; routes export exceptions diagnostically. |
| Pointframe/Services/Infrastructure/TelemetryService.cs | Implements channel-aware tracking, schema validation warnings, explicit batching processor, and flush semantics. |
| Pointframe/Services/Infrastructure/TelemetryHeartbeatService.cs | Adjusts heartbeat interval to 4 hours and switches to catalog events/keys. |
| Pointframe/Services/Infrastructure/TelemetryEventCatalog.cs | Introduces event/property constants plus a catalog with required property validation. |
| Pointframe/Services/Infrastructure/ITelemetryService.cs | Extends telemetry interface with product/diagnostic event separation and diagnostic exception tracking. |
| Pointframe/Services/Infrastructure/AppErrorHandler.cs | Routes unhandled exceptions through diagnostic exception tracking. |
| Pointframe/Services/Infrastructure/ActivationTelemetryService.cs | Moves capture/recording telemetry to catalog events/keys. |
| Pointframe/Services/Capture/CaptureLaunchService.cs | Moves capture telemetry to catalog events/keys and standardizes property keys. |
| Pointframe/Services/Annotation/OcrLassoController.cs | Moves OCR telemetry to catalog events/keys. |
| Pointframe/AppServiceRegistration.cs | Injects telemetry into RecordingHudViewModel factory construction. |
| Pointframe/App.xaml.cs | Moves startup/exit/update/library telemetry to catalog events/keys and preserves flush on exit. |
| Pointframe.Tests/Services/TelemetryServiceTests.cs | Updates tests for channel tagging, local schema warnings when disabled, and new flush behavior. |
| Pointframe.Tests/Services/TelemetryEventCatalogTests.cs | Adds validation tests for required properties and diagnostic channel coverage. |
| Pointframe.Tests/Services/TelemetryDocumentationTests.cs | Adds README↔catalog synchronization tests and heartbeat interval documentation check. |
| Pointframe.Tests/Services/ActivationTelemetryServiceTests.cs | Updates tests to use catalog event/property constants. |
| docs/appinsights-pointframe-workbook.all-in-one.template.json | Adds an Application Insights workbook template for product analytics and telemetry quality checks. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.