Skip to content

Commit 24dbe87

Browse files
authored
docs: Revise telemetry documentation for licensing events
Updated event names and descriptions in the telemetry documentation for clarity and consistency.
1 parent 5a3e287 commit 24dbe87

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

doc/internal-documentation/Telemetry-Licensing.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@
44

55
Licensing telemetry tracks license management operations, user navigation, and API interactions.
66

7-
## License Manager Events (Client)
7+
## License Manager Events (Client/Studio App)
88

9-
Client-side license manager events:
9+
### Licensing Event
10+
11+
| Event Name | Properties | Measurements | Description |
12+
|------------|-----------|--------------|-------------|
13+
| `license-status` | `LicenseName` (string), `LicenseStatus` (string), `TrialDaysRemaining` (int), `LicenseExpiryDate` (date) | - | License status checked |
14+
15+
### Authentication Events
1016

1117
| Event Name | Properties | Measurements | Description |
1218
|------------|-----------|--------------|-------------|
@@ -18,13 +24,8 @@ Client-side license manager events:
1824
| `login-failure` | `error` (string), `errorDescription` (string) | - | Login failed |
1925
| `login-canceled` | - | - | User canceled login |
2026
| `login-timeout` | `error` (string), `errorDescription` (string) | - | Login timed out |
21-
| `license-status` | `LicenseName` (string), `LicenseStatus` (string), `TrialDaysRemaining` (int), `LicenseExpiryDate` (date) | - | License status checked |
22-
| `manager-started` | `Feature` (string) | - | License manager started for a feature |
23-
| `manager-failed` | `errorType` (string), `errorStackTrace` (string) | - | License manager failed |
24-
25-
## Navigation Events
2627

27-
User navigation events:
28+
### Navigation Events
2829

2930
| Event Name | Description |
3031
|------------|-------------|
@@ -42,36 +43,42 @@ User navigation events:
4243
| `nav-to-purchase-now` | User navigated to Purchase |
4344
| `nav-to-trial-extension` | User navigated to Trial Extension |
4445

45-
## License API Events (Server)
46+
## LicenseSpring API Events (Server)
4647

47-
Server-side licensing API events:
48+
**Event Name Prefix:** `uno/licensing/api`
4849

4950
| Event Name | Properties | Measurements | Description |
5051
|------------|-----------|--------------|-------------|
51-
| `get-user` | - | - | User info requested |
5252
| `get-user-success` | - | `DurationMs` | User info retrieved successfully |
5353
| `get-user-failure` | `Error` (string) | `DurationMs` | User info retrieval failed |
54-
| `get-licenses` | - | - | Licenses requested |
54+
| `get-licenses-requested` | - | - | Licenses requested |
5555
| `get-licenses-success` | - | `DurationMs` | Licenses retrieved successfully |
5656
| `get-licenses-failure` | `Error` (string) | `DurationMs` | License retrieval failed |
57-
| `get-offers` | - | - | Offers requested |
57+
| `get-offers-requested` | - | - | Offers retrieved successfully | Offers requested (trial days left, purchase link, etc.) for the current user.)
5858
| `get-offers-success` | `Details` (string) | `DurationMs` | Offers retrieved successfully |
5959
| `get-offers-failure` | `Error` (string) | `DurationMs` | Offer retrieval failed |
60-
| `get-features` | - | - | Features requested |
60+
| `get-features-requested` | - | - | Features requested |
6161
| `get-features-success` | - | `DurationMs` | Features retrieved successfully |
6262
| `get-features-failure` | - | `DurationMs` | Feature retrieval failed |
63-
| `invalid-api-key` | - | - | API key validation failed |
63+
| `invalid-api-key` | - | - | LicenseSpring API key validation failed |
6464
| `invalid-token` | - | - | Token validation failed |
65-
| `no-license-id` | - | - | No license ID provided |
66-
| `id-not-found` | - | - | License ID not found |
67-
| `license-feature-not-granted` | `Feature` (string) | - | Feature not granted by license |
68-
| `license-feature-info-returned` | `Feature` (string) | - | Feature info returned |
65+
| `no-license-id` | - | - | No LicenseSpring ID for the ysuer |
66+
| `id-not-found` | - | - | Customer ID not found for the user in LicenseSpring |
6967

7068
## DevServer Licensing Events
7169

70+
**Event Name Prefix:** `uno/licensing/devserver`
71+
7272
| Event Name | Properties | Measurements | Description |
7373
|------------|-----------|--------------|-------------|
74-
| `license-manager-start` | `Feature` (string) | - | License manager started in DevServer |
74+
| `license-manager-start` | `Feature` (string) | - | License manager started in DevServer (i.e., attempting to start the **Studio app**) |
75+
| `license-feature-not-granted` | `Feature` (string) | - | Feature not granted by license. Either the user does not have a valid license to access a feature (e.g., Hot Design) |
76+
| `license-feature-info-returned` | `Feature` (string) | - | Feature info returned |
77+
| `manager-started` | `Feature` (string) | - | License manager started for a feature (i.e., **Studio app** started) |
78+
| `manager-failed` | `errorType` (string), `errorStackTrace` (string) | - | License manager failed |
79+
| `service-started` | - | - | Service (i.e., addin) started |
80+
| `service-stopped` | - | - | Service (i.e., addin) stopped|
81+
| `service-failed` | `errorType` (string), `errorStackTrace` (string) | - | Service (i.e., addin) failed |
7582

7683
## Property Value Examples
7784

0 commit comments

Comments
 (0)