Home > @microsoft/rush-lib > ITelemetryData
ITelemetryData interface
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Signature:
export interface ITelemetryData
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| durationInSeconds | readonly | number | (BETA) Duration in seconds |
| extraData? | readonly | { [key: string]: string | number | boolean; } | (BETA) (Optional) |
| machineInfo? | readonly | ITelemetryMachineInfo | (BETA) (Optional) Detailed information about the host machine. |
| name | readonly | string | (BETA) Command name |
| operationResults? | readonly | Record<string, ITelemetryOperationResult> | (BETA) (Optional) Only applicable to phased commands. Provides detailed results by operation. Keys are operation names, values contain result, timing information, and dependencies. |
| platform? | readonly | string | (BETA) (Optional) The platform the command was executed on, based on the Node.js process.platform() API |
| result | readonly | 'Succeeded' | 'Failed' | (BETA) The result of the command |
| rushVersion? | readonly | string | (BETA) (Optional) The Rush version |
| timestampMs? | readonly | number | (BETA) (Optional) The millisecond-resolution timestamp of the telemetry logging |