Skip to content

Commit b79110f

Browse files
authored
docs: Enhance event descriptions in Telemetry-DevServer.md
Updated event descriptions for clarity and detail in Telemetry documentation.
1 parent 578b09b commit b79110f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/internal-documentation/Telemetry-DevServer.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ Dev Server telemetry tracks server sessions and client connections, including ap
2626

2727
| Event Name | Properties | Measurements | Scope | Description |
2828
|------------|-----------|--------------|-------|-------------|
29-
| `startup` | `StartupHasSolution` (bool) | - | Global | DevServer started |
30-
| `shutdown` | `ShutdownType` (string) | `UptimeSeconds` (double) | Global | DevServer shutdown |
31-
| `startup-failure` | `StartupErrorMessage` (string), `StartupErrorType` (string), `StartupStackTrace` (string) | `UptimeSeconds` (double) | Global | DevServer startup failed |
32-
| `parent-process-lost` | - | - | Global | Parent process lost, graceful shutdown attempted |
29+
| `startup` | `StartupHasSolution` (bool) | - | Global | DevServer started and is ready to receive connections |
30+
| `shutdown` | `ShutdownType` (string) | `UptimeSeconds` (double) | Global | DevServer shutdown. This is the last event before `parent-process-lost` |
31+
| `startup-failure` | `StartupErrorMessage` (string), `StartupErrorType` (string), `StartupStackTrace` (string) | `UptimeSeconds` (double) | Global | A catastophic error occured with the dev server (not only during startup) |
32+
| `parent-process-lost` | - | - | Global | Parent process (process that started the dev server (i.e. IDE)) lost, graceful shutdown attempted. If unable to gracefully shut down, the process is killed and `parent-process-lost-forced-exit` even will be triggered |
3333
| `parent-process-lost-forced-exit` | - | - | Global | Forced exit after graceful shutdown timeout |
3434

3535
### Add-In Discovery Events
3636

3737
| Event Name | Properties | Measurements | Scope | Description |
3838
|------------|-----------|--------------|-------|-------------|
39-
| `addin-discovery-start` | - | - | Global | Add-in discovery started |
39+
| `addin-discovery-start` | - | - | Global | Add-in discovery started. An add-in is a service offered by the dev server global to the solution (can interact with the IDE) |
4040
| `addin-discovery-complete` | `DiscoveryResult` (string), `DiscoveryAddInList` (string) | `DiscoveryAddInCount` (double), `DiscoveryDurationMs` (double) | Global | Add-in discovery completed |
4141
| `addin-discovery-error` | `DiscoveryErrorMessage` (string), `DiscoveryErrorType` (string) | `DiscoveryDurationMs` (double) | Global | Add-in discovery failed |
4242

@@ -52,15 +52,15 @@ Dev Server telemetry tracks server sessions and client connections, including ap
5252

5353
| Event Name | Properties | Measurements | Scope | Description |
5454
|------------|-----------|--------------|-------|-------------|
55-
| `processor-discovery-start` | `AppInstanceId` (string), `DiscoveryIsFile` (bool) | - | Per-connection | Processor discovery started for connection |
55+
| `processor-discovery-start` | `AppInstanceId` (string), `DiscoveryIsFile` (bool) | - | Per-connection | Processor discovery started for connection, A processor is an agent that the client (connected application) asks the dev server to load.|
5656
| `processor-discovery-complete` | `AppInstanceId` (string), `DiscoveryIsFile` (bool), `DiscoveryResult` (string), `DiscoveryFailedProcessors` (string) | `DiscoveryDurationMs` (double), `DiscoveryAssembliesProcessed` (double), `DiscoveryProcessorsLoadedCount` (double), `DiscoveryProcessorsFailedCount` (double) | Per-connection | Processor discovery completed |
5757
| `processor-discovery-error` | `DiscoveryErrorMessage` (string), `DiscoveryErrorType` (string) | `DiscoveryDurationMs` (double), `DiscoveryAssembliesCount` (double), `DiscoveryProcessorsLoadedCount` (double), `DiscoveryProcessorsFailedCount` (double) | Per-connection | Processor discovery failed |
5858

5959
### Connection Events
6060

6161
| Event Name | Properties | Measurements | Scope | Description |
6262
|------------|-----------|--------------|-------|-------------|
63-
| `client-connection-opened` | `ConnectionId` (string) | - | Per-connection | Client connection opened (metadata anonymized) |
63+
| `client-connection-opened` | `ConnectionId` (string) | - | Per-connection | Client connection opened (metadata anonymized) and connected to the dev server |
6464
| `client-connection-closed` | `ConnectionId` (string) | `ConnectionDurationSeconds` (double) | Per-connection | Client connection closed |
6565

6666
## App Launch Tracking

0 commit comments

Comments
 (0)