0

[Telemetry] Update doc for network bandwidth routine

Bug: 261312788
Test: CQ

Change-Id: I6829f42217fa668119113d5250494478b0485db7
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6164038
Reviewed-by: Chung-sheng Wu <chungsheng@google.com>
Commit-Queue: Byron Lee <byronlee@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1404653}
This commit is contained in:
Byron Lee
2025-01-10 01:08:18 -08:00
committed by Chromium LUCI CQ
parent 80b8660bcd
commit e8fa826318
2 changed files with 28 additions and 1 deletions
chrome/common/chromeos/extensions/api
docs/telemetry_extension

@ -186,7 +186,7 @@ namespace os.diagnostics {
dictionary NetworkBandwidthRoutineRunningInfo {
// The type of test that routine is running.
NetworkBandwidthRoutineRunningType type;
// The current network speed in Kbps.
// The current network speed in Kbit/s.
double speedKbps;
};

@ -641,11 +641,31 @@ M117.
------------ | ------- | ----------- |
| uuid | string | UUID of the routine that entered this state |
### Enum NetworkBandwidthRoutineRunningType
| Property Name |
------------ |
| download |
| upload |
### NetworkBandwidthRoutineRunningInfo
| Property Name | Type | Description |
------------ | ------- | ----------- |
| type | NetworkBandwidthRoutineRunningType | The type of test that routine is running |
| speedKbps | number | The current network speed in Kbit/s |
### RoutineRunningInfoUnion
This is a [union type](#Dictionary_based-union-types). Exactly one field is set.
| Property Name | Type | Description |
------------ | ------- | ----------- |
| networkBandwidth | NetworkBandwidthRoutineRunningInfo | Extra detail for a running network bandwidth routine |
### RoutineRunningInfo
| Property Name | Type | Description |
------------ | ------- | ----------- |
| uuid | string | UUID of the routine that entered this state |
| percentage | number | Current percentage of the routine status (0-100) |
| info | RoutineRunningInfoUnion | Extra details about a running routine |
### CheckLedLitUpStateInquiry
Details regarding the inquiry to check the LED lit up state. Clients should
@ -708,6 +728,7 @@ This is a [union type](#Dictionary_based-union-types). Exactly one field is set.
------------ | ------- | ----------- |
| memory | MemoryRoutineFinishedDetail | Extra detail for a finished memory routine |
| fan | FanRoutineFinishedDetail | Extra detail for a finished fan routine |
| networkBandwidth | NetworkBandwidthRoutineFinishedDetail | Extra detail for a finished network bandwidth routine |
| cameraFrameAnalysis | CameraFrameAnalysisRoutineFinishedDetail | Extra detail for a finished camera frame analysis routine |
### MemtesterResult
@ -803,6 +824,12 @@ unrecognized devices.
| Property Name | Type | Description |
------------ | ------- | ----------- |
### NetworkBandwidthRoutineFinishedDetail
| Property Name | Type | Description |
------------ | ------- | ----------- |
| downloadSpeedKbps | number | Average download speed in Kbit/s |
| uploadSpeedKbps | number | Average upload speed in Kbit/s |
### Enum LedName
| Property Name |
------------ |