[storage] define statistics object

Signed-off-by: Boris Glimcher <[email protected]>
opiproject · Dec 9, 2022 · ee306f8 · ee306f8
1 parent 65d9273
commit ee306f8
Show file tree

Hide file tree

Showing 73 changed files with 8,157 additions and 4,917 deletions.
diff --git a/storage/v1alpha1/autogen.md b/storage/v1alpha1/autogen.md
@@ -149,6 +149,7 @@
 
 - [opicommon.proto](#opicommon-proto)
     - [PciEndpoint](#opi_api-storage-v1-PciEndpoint)
+    - [VolumeStats](#opi_api-storage-v1-VolumeStats)
 
     - [EncryptionType](#opi_api-storage-v1-EncryptionType)
 
@@ -212,7 +213,7 @@
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | handle | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -484,7 +485,7 @@ Back End (network-facing) APIs. This service is for AIO generic kernel block dev
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | handle | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -698,7 +699,7 @@ Back End (network-facing) APIs. This is debug interface for null block devices.
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -1102,7 +1103,7 @@ Back End (network-facing) APIs. NVMe/TCP and NVMe/RoCEv2 protocols are covered b
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | id | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -1185,7 +1186,7 @@ Back End (network-facing) APIs. NVMe/TCP and NVMe/RoCEv2 protocols are covered b
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | id | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -1266,7 +1267,7 @@ Back End (network-facing) APIs. NVMe/TCP and NVMe/RoCEv2 protocols are covered b
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -1545,7 +1546,7 @@ Front End (host-facing) APIs. Mostly used for NVMe/PCIe emulation and host prese
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | id | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -1927,7 +1928,7 @@ Front End (host-facing) APIs. Mostly used for Virtio-blk emulation emulation and
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | id | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -1976,7 +1977,7 @@ Front End (host-facing) APIs. Mostly used for Virtio-blk emulation emulation and
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | id | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -2023,7 +2024,7 @@ Front End (host-facing) APIs. Mostly used for Virtio-blk emulation emulation and
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | id | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -2147,7 +2148,7 @@ Front End (host-facing) APIs. Mostly used for Virtio-scsi emulation and host pre
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | encrypted_volume_id | [opi_api.common.v1.ObjectKey](#opi_api-common-v1-ObjectKey) |  |  |
-| stats | [string](#string) |  |  |
+| stats | [VolumeStats](#opi_api-storage-v1-VolumeStats) |  |  |
 
 
 
@@ -2272,6 +2273,29 @@ confusion with storage &#34;devices&#34;.
 
 
 
+
+<a name="opi_api-storage-v1-VolumeStats"></a>
+
+### VolumeStats
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| read_bytes_count | [int32](#int32) |  |  |
+| read_ops_count | [int32](#int32) |  |  |
+| write_bytes_count | [int32](#int32) |  |  |
+| write_ops_count | [int32](#int32) |  |  |
+| unmap_bytes_count | [int32](#int32) |  |  |
+| unmap_ops_count | [int32](#int32) |  |  |
+| read_latency_ticks | [int32](#int32) |  |  |
+| write_latency_ticks | [int32](#int32) |  |  |
+| unmap_latency_ticks | [int32](#int32) |  |  |
+
+
+
+
+
 
 
 

diff --git a/storage/v1alpha1/backend_aio.proto b/storage/v1alpha1/backend_aio.proto
@@ -18,6 +18,7 @@ import "google/api/field_behavior.proto";
 import "google/protobuf/field_mask.proto";
 
 import "object_key.proto";
+import "opicommon.proto";
 import "uuid.proto";
 
 // Back End (network-facing) APIs. This service is for AIO generic kernel block device.
@@ -117,6 +118,6 @@ message AioControllerStatsRequest {
 
 message AioControllerStatsResponse {
     common.v1.ObjectKey handle = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }
 
diff --git a/storage/v1alpha1/backend_null.proto b/storage/v1alpha1/backend_null.proto
@@ -18,6 +18,7 @@ import "google/api/field_behavior.proto";
 import "google/protobuf/field_mask.proto";
 
 import "object_key.proto";
+import "opicommon.proto";
 import "uuid.proto";
 
 // Back End (network-facing) APIs. This is debug interface for null block devices.
@@ -113,6 +114,6 @@ message NullDebugStatsRequest {
 
 message NullDebugStatsResponse {
     common.v1.ObjectKey handle = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }
 
diff --git a/storage/v1alpha1/backend_nvme_tcp.proto b/storage/v1alpha1/backend_nvme_tcp.proto
@@ -18,6 +18,7 @@ import "google/api/field_behavior.proto";
 import "google/protobuf/field_mask.proto";
 
 import "object_key.proto";
+import "opicommon.proto";
 
 // Back End (network-facing) APIs. NVMe/TCP and NVMe/RoCEv2 protocols are covered by this service.
 service NVMfRemoteControllerService {
@@ -130,7 +131,7 @@ message NVMfRemoteControllerStatsRequest {
 }
 
 message NVMfRemoteControllerStatsResponse {
-    string stats = 1;
+    VolumeStats stats = 1;
 }
 
 enum NvmeTransportType {

diff --git a/storage/v1alpha1/frontend_nvme_pcie.proto b/storage/v1alpha1/frontend_nvme_pcie.proto
@@ -291,7 +291,7 @@ message NVMeSubsystemStatsRequest {
 }
 
 message NVMeSubsystemStatsResponse {
-    string stats = 1;
+    VolumeStats stats = 1;
 }
 
 message CreateNVMeControllerRequest {
@@ -343,7 +343,7 @@ message NVMeControllerStatsRequest {
 
 message NVMeControllerStatsResponse {
     common.v1.ObjectKey id = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }
 
 message CreateNVMeNamespaceRequest {
@@ -395,7 +395,7 @@ message NVMeNamespaceStatsRequest {
 
 message NVMeNamespaceStatsResponse {
     common.v1.ObjectKey id = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }
 
 // Namespace  Administrative States

diff --git a/storage/v1alpha1/frontend_virtio_blk.proto b/storage/v1alpha1/frontend_virtio_blk.proto
@@ -117,5 +117,5 @@ message VirtioBlkStatsRequest {
 
 message VirtioBlkStatsResponse {
     common.v1.ObjectKey id = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }
diff --git a/storage/v1alpha1/frontend_virtio_scsi.proto b/storage/v1alpha1/frontend_virtio_scsi.proto
@@ -197,7 +197,7 @@ message VirtioScsiTargetStatsRequest {
 
 message VirtioScsiTargetStatsResponse {
     common.v1.ObjectKey id = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }
 
 message CreateVirtioScsiControllerRequest {
@@ -249,7 +249,7 @@ message VirtioScsiControllerStatsRequest {
 
 message VirtioScsiControllerStatsResponse {
     common.v1.ObjectKey id = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }
 
 message CreateVirtioScsiLunRequest {
@@ -302,5 +302,5 @@ message VirtioScsiLunStatsRequest {
 
 message VirtioScsiLunStatsResponse {
     common.v1.ObjectKey id = 1;
-    string stats = 2;
+    VolumeStats stats = 2;
 }