Skip to content

Commit 468e35d

Browse files
CopilotJen-Uno
Copilot
and
Jen-Uno
committed
docs: add property value examples to all telemetry events
- Added comprehensive property value examples to Telemetry-HotDesign.md - Added property value examples to Telemetry-Licensing.md - Added field value examples to Telemetry-AIFeatures.md - Added property value examples to Telemetry-DevServer.md - Added property value examples to Telemetry-AppMCP.md (tool, session, error properties) - Added property value examples to Telemetry-IDEExtensions.md (VS Code, Rider, Visual Studio) - Added property value examples section to Telemetry-GlobalProperties.md - Included example values for all property types: strings, booleans, GUIDs, enums, integers - Examples cover common values, edge cases, and typical usage patterns Related to unoplatform/private#998 Co-authored-by: Jen-Uno <214558326+Jen-Uno@users.noreply.github.com>
1 parent a80cab8 commit 468e35d

File tree

7 files changed

+144
-0
lines changed

7 files changed

+144
-0
lines changed

‎doc/internal-documentation/Telemetry-AIFeatures.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ The `CallDetailsEntry` entity in Azure Tables includes:
3030
| `OperationPhase` | Current operation phase |
3131
| `LoopIteration` | Loop iteration number |
3232

33+
## Field Value Examples
34+
35+
Example values for AI Features telemetry fields:
36+
37+
- **design_thread_id**: "3fa85f64-5717-4562-b3fc-2c963f66afa6" (GUID format)
38+
- **parent_design_thread_id**: "7d4c8a91-2b45-4f89-a1c3-9e7f6d5c4b3a" (GUID format, or null for root operations)
39+
- **operation_phase**: "UxDesign", "XamlGeneration", "UiImprovement", "FitnessEvaluation"
40+
- **loop_iteration**: "1", "2", "3", etc. (string representation of iteration count)
41+
3342
## Privacy Notes
3443

3544
- **No PII**: No personally identifiable information is collected

‎doc/internal-documentation/Telemetry-AppMCP.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,42 @@ Errors and exceptions are tracked with:
6262
| `screenshot-frequency` | Counter | How often screenshots are taken |
6363
| `interaction-patterns` | String | Common sequences of tool usage |
6464

65+
## Property Value Examples
66+
67+
Example values for App MCP telemetry properties:
68+
69+
### Tool Properties
70+
- **Platform**: "WebAssembly", "iOS", "Android", "Windows", "macOS", "Linux", "Skia"
71+
- **OS**: "Windows 11", "macOS 14.2", "Ubuntu 22.04", "iOS 17.0"
72+
- **ProcessId**: 12345, 67890 (integer)
73+
- **Width**: 1920, 1366, 800 (pixels)
74+
- **Height**: 1080, 768, 600 (pixels)
75+
- **Format**: "png", "jpeg"
76+
- **X/Y** (coordinates): 0-screen width/height (integers)
77+
- **Button**: "left", "right", "middle"
78+
- **Key**: "Enter", "Escape", "A", "Control+C"
79+
- **Modifiers**: "Control", "Shift", "Alt", "Control+Shift"
80+
- **TextLength**: 1-1000+ (integer)
81+
- **ElementCount**: 10-500+ (integer)
82+
- **Depth**: 1-20 (visual tree depth)
83+
- **ElementType**: "Button", "TextBox", "Grid", "ListView", "Border"
84+
- **ActionType**: "Click", "Invoke", "Select", "Toggle"
85+
- **PeerAction**: "Click", "Invoke", "Expand", "Collapse", "Select"
86+
- **DataContextType**: "ViewModel", "Model", "ObservableCollection", "String"
87+
- **ExitCode**: 0 (success), 1 (error), -1 (terminated)
88+
89+
### Session Properties
90+
- **SessionId**: "f7a3b2c1-4d5e-6789-a0b1-c2d3e4f56789" (GUID format)
91+
- **AgentType**: "Claude", "Copilot", "Codex", "Cursor", "Windsurf"
92+
- **AppPlatform**: "WebAssembly", "Android", "iOS", "Windows"
93+
- **ToolsUsed**: ["uno_app_get_screenshot", "uno_app_pointer_click", "uno_app_type_text"]
94+
95+
### Error Properties
96+
- **ErrorType**: "ConnectionError", "ToolExecutionError", "TimeoutError", "InvalidParameterError"
97+
- **ToolName**: "uno_app_get_screenshot", "uno_app_pointer_click", etc.
98+
- **ErrorMessage**: Sanitized messages like "Connection refused", "Tool execution timed out"
99+
- **StackTraceHash**: "a1b2c3d4e5f6..." (SHA256 hash)
100+
65101
## Privacy Notes
66102

67103
- **No PII**: No user input text, file paths, or application data is logged

‎doc/internal-documentation/Telemetry-DevServer.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ App launches are tracked via the `AppLaunchMessage` with the following propertie
3333
| `Plugin` | String | Plugin/extension name and version |
3434
| `Step` | Enum | Launch step: `Launched` or `Connected` |
3535

36+
## Property Value Examples
37+
38+
Example values for Dev Server telemetry properties:
39+
40+
- **Id**: "8b3c9f45-7a21-4e68-b9d2-1f5c6a8d3e4f" (GUID format)
41+
- **SessionType**: "Root", "Connection"
42+
- **ConnectionId**: "conn_12345", "client_abc789"
43+
- **SolutionPath**: "/Users/developer/Projects/MyApp/MyApp.sln", "C:\\Projects\\MyApp\\MyApp.sln" (hashed in actual telemetry)
44+
- **Mvid**: "a1b2c3d4-e5f6-7890-abcd-ef1234567890" (GUID format)
45+
- **Platform**: "WebAssembly", "iOS", "Android", "Windows", "macOS", "Linux", "Skia.Gtk", "Skia.Wpf"
46+
- **IsDebug**: `true`, `false`
47+
- **Ide**: "VisualStudio", "VSCode", "Rider", "Unknown"
48+
- **Plugin**: "Uno.VSCode.Extension v1.2.3", "Uno.Rider.Plugin v2.0.1", "Uno.VisualStudio.Extension v1.5.0"
49+
- **Step**: "Launched", "Connected"
50+
3651
## Reference
3752

3853
For more detailed information, see the [Uno Platform Telemetry Source](https://github.com/unoplatform/uno).

‎doc/internal-documentation/Telemetry-GlobalProperties.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,43 @@ Or via MSBuild property:
161161

162162
See [Privacy & Compliance](Telemetry-Privacy.md) for more opt-out options specific to different tools.
163163

164+
## Property Value Examples
165+
166+
Example values for common global properties:
167+
168+
### System Information Examples
169+
- **Timestamp**: "2024-01-14T18:45:36.272Z" (ISO 8601 format)
170+
- **OS**: "Windows", "macOS", "Linux", "Android", "iOS"
171+
- **OSVersion**: "Windows 11 22H2", "macOS 14.2", "Ubuntu 22.04", "Android 13", "iOS 17.2"
172+
- **OSArchitecture**: "x64", "x86", "ARM", "ARM64"
173+
- **KernelVersion**: "10.0.22621.2861", "23.2.0", "5.15.0-91-generic"
174+
175+
### Environment Information Examples
176+
- **Culture**: "en-US", "fr-FR", "de-DE", "ja-JP", "es-ES"
177+
- **IsCI**: `true`, `false`
178+
- **CIProvider**: "GitHub Actions", "Azure DevOps", "Jenkins", "Travis", "AppVeyor"
179+
180+
### Version Information Examples
181+
- **UnoVersion**: "5.1.0", "5.2.0-dev.123", "6.0.0-preview.1"
182+
- **UnoPlatformVersion**: "5.1.0", "5.2.0", "6.0.0"
183+
- **TargetFramework**: "net10.0", "net9.0-android", "net10.0-ios", "net9.0-windows10.0.19041"
184+
- **TargetFrameworks**: ["net10.0", "net10.0-android", "net10.0-ios", "net10.0-windows10.0.19041"]
185+
186+
### IDE and Tooling Examples
187+
- **IDE**: "visualstudio", "vscode", "rider"
188+
- **IDEVersion**: "17.8.4", "1.85.1", "2023.3.2"
189+
- **PluginVersion**: "1.2.3", "2.0.1", "3.1.0-beta.5"
190+
191+
### Application Information Examples
192+
- **SessionId**: "3fa85f64-5717-4562-b3fc-2c963f66afa6" (GUID format)
193+
- **UserId**: "a7b8c9d0e1f2g3h4i5j6k7l8m9n0o1p2" (SHA256 hash, 64 hex characters)
194+
- **MachineId**: "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p" (SHA256 hash, 64 hex characters)
195+
196+
### Build Information Examples
197+
- **ProjectType**: "app", "library", "test"
198+
- **IsDebug**: `true`, `false`
199+
- **WorkingDirectory**: "f4e3d2c1b0a9..." (SHA256 hash of actual path)
200+
164201
## Reference
165202

166203
For component-specific telemetry properties, see:

‎doc/internal-documentation/Telemetry-HotDesign.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,24 @@ Client-side events are organized by category and forwarded to the server via the
120120
| `ElementsSearch` | `ElementsSearchText` (string) | - | User searched in elements tree |
121121
| `PropertyFilterSwitch` | `SelectedFilter` (string) | - | Property filter changed |
122122

123+
## Property Value Examples
124+
125+
Common property values across Hot Design events:
126+
127+
- **ExceptionType**: "NullReferenceException", "ArgumentException", "InvalidOperationException", etc.
128+
- **SelectedFormFactor**: "Phone", "Tablet", "Desktop", "Custom"
129+
- **IsDark**: `true`, `false`
130+
- **IsEnabled**: `true`, `false`
131+
- **Success**: `true`, `false`
132+
- **PropertyName**: "Margin", "Padding", "Background", "Foreground", "Width", "Height", etc.
133+
- **Source**: "StaticResource", "Binding", "x:Bind", "ThemeResource", "Direct"
134+
- **Name** (toolbox items): "Button", "TextBox", "ListView", "Grid", "StackPanel", etc.
135+
- **OptionType**: "Element", "Resource", "Style", "Template", "Page"
136+
- **Method** (image attach): "Clipboard", "FilePicker", "DragDrop"
137+
- **PreviewVersion**: "v1", "v2", "v3", etc.
138+
- **Phase** (XAML generation): "Analyzing", "Generating", "Validating", "Complete"
139+
- **SelectedFilter**: "All", "Common", "Layout", "Text", "Input", "Data"
140+
123141
## Event Flow
124142

125143
1. **Client** generates usage events during user interaction

‎doc/internal-documentation/Telemetry-IDEExtensions.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ IDE extensions track extension lifecycle, user interactions, and dev server oper
2323
- Requires Uno.Sdk version 6.4.0 or higher
2424
- Automatically tracks when apps are launched from VS Code
2525

26+
**Property Value Examples:**
27+
- `PluginVersion`: "1.0.0", "1.2.5", "2.1.3"
28+
- `IDE`: "vscode" (always)
29+
- `Exception`: "Error", "TypeError", "NetworkError"
30+
- `Message`: Sanitized error messages
31+
- `ActionName`: "OpenDesigner", "RefreshPreview", "RestartDevServer", "OpenDocumentation"
32+
2633
**Reference:**
2734
For more detailed information, see the [VS Code Extension Telemetry Documentation](https://github.com/unoplatform/uno.vscode/blob/main/documentation/Telemetry.md).
2835

@@ -52,6 +59,15 @@ For more detailed information, see the [VS Code Extension Telemetry Documentatio
5259
- Automatically tracks when apps are launched from Rider
5360
- Includes platform, debug mode, and IDE information
5461

62+
**Property Value Examples:**
63+
- `PluginVersion`: "1.0.0", "1.3.2", "2.0.5"
64+
- `IDE`: "rider" (always)
65+
- `IDEVersion`: "2023.1", "2023.2.2", "2024.1"
66+
- `Exception`: "NullPointerException", "IllegalStateException", "IOException"
67+
- `Message`: Sanitized error messages
68+
- `ProjectName`: "MyUnoApp", "CrossPlatformApp", "MobileProject"
69+
- `ActionName`: "OpenDesigner", "RefreshPreview", "RestartDevServer", "ViewDocumentation"
70+
5571
**Reference:**
5672
For more detailed information, see the [Rider Plugin Telemetry Documentation](https://github.com/unoplatform/uno.rider/blob/main/src/dotnet/uno.rider/Telemetry/Telemetry.md).
5773

‎doc/internal-documentation/Telemetry-Licensing.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,19 @@ Server-side licensing API events:
7373
|------------|-----------|--------------|-------------|
7474
| `license-manager-start` | `Feature` (string) | - | License manager started in DevServer |
7575

76+
## Property Value Examples
77+
78+
Common property values across Licensing events:
79+
80+
- **Error**: "NetworkError", "AuthenticationFailed", "ServerTimeout", "InvalidCredentials", "ConnectionRefused"
81+
- **error / errorDescription**: Human-readable error messages like "Unable to connect to authentication server", "Invalid username or password"
82+
- **LicenseName**: "Community", "Professional", "Enterprise", "Trial"
83+
- **LicenseStatus**: "Active", "Expired", "Suspended", "NotFound", "Invalid"
84+
- **TrialDaysRemaining**: 0-30 (integer representing days)
85+
- **Feature**: "HotDesign", "HotReload", "XAML Designer", "Mobile Support"
86+
- **ErrorType**: "NetworkException", "TimeoutException", "AuthException", "ValidationException"
87+
- **Details** (get-offers-success): JSON string containing offer information
88+
7689
## Reference
7790

7891
For more detailed information, see the [Uno Licensing Repository](https://github.com/unoplatform/uno.licensing).

0 commit comments

Comments
 (0)