Refactor: move HardwareUsage to the Usage map

n0x29a · n0x29a · commit 0b061a36e5ec · 2025-05-13T17:06:00.000+02:00
diff --git a/docs/redoc/master/openapi.json b/docs/redoc/master/openapi.json
@@ -15225,6 +15225,22 @@
             "type": "boolean"
           }
         ]
+      },
+      "Usage": {
+        "description": "Usage of the hardware resources, spent to process the request",
+        "type": "object",
+        "properties": {
+          "hardware": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/HardwareUsage"
+              },
+              {
+                "nullable": true
+              }
+            ]
+          }
+        }
       }
     }
   }
diff --git a/lib/api/src/grpc/proto/points_internal_service.proto b/lib/api/src/grpc/proto/points_internal_service.proto
@@ -123,7 +123,7 @@ message UpdateBatchInternal {
 message PointsOperationResponseInternal {
   UpdateResultInternal result = 1;
   double time = 2; // Time spent to process
-  optional HardwareUsage usage = 3;
+  optional Usage usage = 3;
 }
 
 // Has to be backward compatible with `UpdateResult`!
@@ -314,7 +314,7 @@ message QueryResultInternal {
 message QueryBatchResponseInternal {
   repeated QueryResultInternal results = 1;
   double time = 2; // Time spent to process
-  optional HardwareUsage usage = 5;
+  optional Usage usage = 5;
 }
 
 message FacetCountsInternal {
@@ -344,5 +344,5 @@ message FacetHitInternal {
 message FacetResponseInternal {
     repeated FacetHitInternal hits = 1;
     double time = 2; // Time spent to process
-    optional HardwareUsage usage = 3;
+    optional Usage usage = 3;
 }
diff --git a/lib/api/src/grpc/qdrant.rs b/lib/api/src/grpc/qdrant.rs
@@ -9887,7 +9887,7 @@ pub struct QueryBatchResponseInternal {
     #[prost(double, tag = "2")]
     pub time: f64,
     #[prost(message, optional, tag = "5")]
-    pub usage: ::core::option::Option<HardwareUsage>,
+    pub usage: ::core::option::Option<Usage>,
 }
 #[derive(serde::Serialize)]
 #[derive(validator::Validate)]
@@ -9953,7 +9953,7 @@ pub struct FacetResponseInternal {
     #[prost(double, tag = "2")]
     pub time: f64,
     #[prost(message, optional, tag = "3")]
-    pub usage: ::core::option::Option<HardwareUsage>,
+    pub usage: ::core::option::Option<Usage>,
 }
 /// Generated client implementations.
 pub mod points_internal_client {
diff --git a/lib/api/src/rest/models.rs b/lib/api/src/rest/models.rs
@@ -45,7 +45,16 @@ pub struct ApiResponse<D> {
     pub status: ApiStatus,
     pub time: f64,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub usage: Option<HardwareUsage>,
+    pub usage: Option<Usage>,
+}
+
+/// Usage of the hardware resources, spent to process the request
+#[derive(Debug, Serialize, JsonSchema, Anonymize, Clone)]
+#[serde(rename_all = "snake_case")]
+#[anonymize(false)]
+pub struct Usage {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub hardware: Option<HardwareUsage>,
 }
 
 /// Usage of the hardware resources, spent to process the request
diff --git a/lib/collection/src/shards/remote_shard.rs b/lib/collection/src/shards/remote_shard.rs
@@ -1201,7 +1201,9 @@ impl ShardOperation for RemoteShard {
         } = batch_response;
 
         if let Some(hw_usage) = usage {
-            hw_measurement_acc.accumulate_request(hw_usage);
+            if let Some(hardware) = hw_usage.hardware {
+                hw_measurement_acc.accumulate_request(hardware);
+            }
         }
 
         let result = results
@@ -1271,7 +1273,9 @@ impl ShardOperation for RemoteShard {
             .into_inner();
 
         if let Some(hw_usage) = response.usage {
-            hw_measurement_acc.accumulate_request(hw_usage);
+            if let Some(hardware) = hw_usage.hardware {
+                hw_measurement_acc.accumulate_request(hardware);
+            }
         }
 
         let hits = response
diff --git a/src/actix/helpers.rs b/src/actix/helpers.rs
@@ -5,7 +5,7 @@ use actix_web::http::header;
 use actix_web::http::header::HeaderMap;
 use actix_web::rt::time::Instant;
 use actix_web::{HttpResponse, ResponseError, http};
-use api::rest::models::{ApiResponse, ApiStatus, HardwareUsage};
+use api::rest::models::{ApiResponse, ApiStatus, HardwareUsage, Usage};
 use collection::operations::types::CollectionError;
 use common::counter::hardware_accumulator::HwMeasurementAcc;
 use serde::Serialize;
@@ -33,7 +33,9 @@ pub fn accepted_response(timing: Instant, hardware_usage: Option<HardwareUsage>)
         result: None,
         status: ApiStatus::Accepted,
         time: timing.elapsed().as_secs_f64(),
-        usage: hardware_usage,
+        usage: Option::from(Usage {
+            hardware: hardware_usage,
+        }),
     })
 }
 
@@ -50,7 +52,9 @@ where
             result: Some(res),
             status: ApiStatus::Ok,
             time: timing.elapsed().as_secs_f64(),
-            usage: hardware_usage,
+            usage: Option::from(Usage {
+                hardware: hardware_usage,
+            }),
         }),
         Err(err) => process_response_error(err, timing, hardware_usage),
     }
@@ -70,7 +74,9 @@ pub fn process_response_error(
         result: None,
         status: ApiStatus::Error(error.to_string()),
         time: timing.elapsed().as_secs_f64(),
-        usage: hardware_usage,
+        usage: Option::from(Usage {
+            hardware: hardware_usage,
+        }),
     };
 
     let mut response_builder = HttpResponse::build(http_code);
diff --git a/src/schema_generator.rs b/src/schema_generator.rs
@@ -1,6 +1,6 @@
 #![allow(dead_code)]
 
-use api::rest::models::{CollectionsResponse, HardwareUsage, VersionInfo};
+use api::rest::models::{CollectionsResponse, Usage, VersionInfo};
 use api::rest::schema::PointInsertOperations;
 use api::rest::{
     FacetRequest, FacetResponse, QueryGroupsRequest, QueryRequest, QueryRequestBatch,
@@ -97,7 +97,7 @@ struct AllDefinitions {
     bk: SearchMatrixPairsResponse,
     bl: FacetRequest,
     bm: FacetResponse,
-    bn: HardwareUsage,
+    bn: Usage,
 }
 
 fn save_schema<T: JsonSchema>() {

Original file line number	Diff line number	Diff line change
`@@ -15225,6 +15225,22 @@`
`15225`	`15225`	`"type": "boolean"`
`15226`	`15226`	`}`
`15227`	`15227`	`]`
	`15228`	`+ },`
	`15229`	`+ "Usage": {`
	`15230`	`+ "description": "Usage of the hardware resources, spent to process the request",`
	`15231`	`+ "type": "object",`
	`15232`	`+ "properties": {`
	`15233`	`+ "hardware": {`
	`15234`	`+ "anyOf": [`
	`15235`	`+ {`
	`15236`	`+ "$ref": "#/components/schemas/HardwareUsage"`
	`15237`	`+ },`
	`15238`	`+ {`
	`15239`	`+ "nullable": true`
	`15240`	`+ }`
	`15241`	`+ ]`
	`15242`	`+ }`
	`15243`	`+ }`
`15228`	`15244`	`}`
`15229`	`15245`	`}`
`15230`	`15246`	`}`