From 162c669df67dc919c0e410bac54b84b2905bee39 Mon Sep 17 00:00:00 2001 From: Travis Wu Date: Tue, 15 Sep 2026 11:28:04 +0800 Subject: [PATCH] docs(metrics): add storageUsage to the metricType enum Per-VM allocated storage, ranked like the other VM metrics. The CubeCOS collector (cubecos#1449) writes it to telegraf; this exposes it on /metrics/{metricType}/rank/vms. Named storageUsage rather than diskUsage because diskUsage is already taken by the host filesystem percentage, and this is per-VM bytes allocated in the storage pool -- a different entity and a different unit. Listed right after diskUsage in the enum, both prose descriptions and both error examples, so every place the values appear stays in the same order. Signed-off-by: Travis Wu --- docs.yaml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs.yaml b/docs.yaml index ec0e62f..3b34e37 100644 --- a/docs.yaml +++ b/docs.yaml @@ -4591,8 +4591,8 @@ paths: msg: type: string example: metricType should be cpuUsage, memoryUsage, diskUsage, - diskBandwidth, diskIops, diskLatency, diskReadIops, diskWriteIops, - networkTrafficIn, or networkTrafficOut + storageUsage, diskBandwidth, diskIops, diskLatency, diskReadIops, + diskWriteIops, networkTrafficIn, or networkTrafficOut status: type: string example: bad request @@ -4704,8 +4704,8 @@ paths: msg: type: string example: metricType should be cpuUsage, memoryUsage, diskUsage, - diskBandwidth, diskIops, diskLatency, diskReadIops, diskWriteIops, - networkTrafficIn, or networkTrafficOut + storageUsage, diskBandwidth, diskIops, diskLatency, diskReadIops, + diskWriteIops, networkTrafficIn, or networkTrafficOut status: type: string example: bad request @@ -12408,6 +12408,7 @@ components: - cpuUsage - memoryUsage - diskUsage + - storageUsage - diskBandwidth - diskIops - diskLatency @@ -12416,8 +12417,8 @@ components: - networkTrafficIn - networkTrafficOut description: The type of metric to query, the value can be 'cpuUsage', 'memoryUsage', - 'diskUsage', 'diskBandwidth', 'diskIops', 'diskLatency', 'diskReadIops', 'diskWriteIops', - 'networkTrafficIn', or 'networkTrafficOut'. + 'diskUsage', 'storageUsage', 'diskBandwidth', 'diskIops', 'diskLatency', 'diskReadIops', + 'diskWriteIops', 'networkTrafficIn', or 'networkTrafficOut'. viewType: in: path name: viewType