feat(volo-http): add CommonStats and ServerStats struct to record lifecycle timings (#649)

* feat(volo-http): add CommonStats struct

* feat(volo-http): record http lifecycle timings

* chore(volo-http): remove debug lines

* fix(volo-http): move handle start recording to correct place

* fix(volo-http): remove Arc and Mutex from ServerStats

* chore(volo-http): update CLAUDE.md to include stat.rs

* fix(volo-http): correct server handle timings

* chore(volo-http): bump crate version

Author: Joshuahoky

Cargo.lock

@@ -12,7 +12,8 @@ volo-http/src/
 ├── response.rs         # Response type alias
 ├── context/            # RPC contexts
 │   ├── client.rs       # ClientContext (target, stats, timeout)
-│   └── server.rs       # ServerContext (RpcInfo, path params, extensions)
+│   ├── server.rs       # ServerContext (RpcInfo, path params, extensions)
+│   └── stat.rs         # CommonStats
 ├── error/
 │   ├── client.rs       # ClientError
 │   └── server.rs       # ExtractBodyError

volo-http/CLAUDE.md

@@ -1,6 +1,6 @@
 [package]
 name = "volo-http"
-version = "0.5.4"
+version = "0.5.5"
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
@@ -117,7 +117,7 @@ client = [
 ] # client core
 server = [
     "hyper-util/server",
-    "dep:ipnet", "dep:matchit", "dep:memchr", "dep:scopeguard", "dep:mime_guess",
+    "dep:ipnet", "dep:matchit", "dep:memchr", "dep:scopeguard", "dep:mime_guess", "dep:chrono",
 ] # server core
 
 __serde = ["dep:serde"] # a private feature for enabling `serde` by `serde_xxx`

volo-http/Cargo.toml

@@ -11,3 +11,6 @@ pub mod server;
 
 #[cfg(feature = "server")]
 pub use self::server::ServerContext;
+
+#[cfg(all(feature = "client", feature = "server"))]
+pub mod stat;

volo-http/src/context/mod.rs

@@ -1,5 +1,6 @@
 //! Context and its utilities of server
 
+use chrono::{DateTime, Local};
 use volo::{
     context::{Context, Reusable, Role, RpcCx, RpcInfo},
     net::Address,
@@ -8,7 +9,7 @@ use volo::{
 
 use crate::{
     server::param::PathParamsVec,
-    utils::macros::{impl_deref_and_deref_mut, impl_getter},
+    utils::macros::{impl_deref_and_deref_mut, impl_getter, stat_impl},
 };
 
 /// RPC context of http server
@@ -44,10 +45,38 @@ pub struct ServerCxInner {
     /// [`PathParamsMap`]: crate::server::param::PathParamsMap
     /// [`PathParams`]: crate::server::param::PathParams
     pub params: PathParamsVec,
+
+    /// Statistics of the request
+    pub stats: ServerStats,
 }
 
 impl ServerCxInner {
     impl_getter!(params, PathParamsVec);
+    impl_getter!(stats, ServerStats);
+}
+
+/// Statistics of server
+#[derive(Debug, Default, Clone)]
+pub struct ServerStats {
+    read_header_start: Option<DateTime<Local>>,
+    read_header_finish: Option<DateTime<Local>>,
+    read_body_start: Option<DateTime<Local>>,
+    read_body_finish: Option<DateTime<Local>>,
+    handle_start: Option<DateTime<Local>>,
+    handle_finish: Option<DateTime<Local>>,
+    write_start: Option<DateTime<Local>>,
+    write_finish: Option<DateTime<Local>>,
+}
+
+impl ServerStats {
+    stat_impl!(read_header_start);
+    stat_impl!(read_header_finish);
+    stat_impl!(read_body_start);
+    stat_impl!(read_body_finish);
+    stat_impl!(handle_start);
+    stat_impl!(handle_finish);
+    stat_impl!(write_start);
+    stat_impl!(write_finish);
 }
 
 /// Configuration of the request

volo-http/src/context/server.rs

@@ -0,0 +1,34 @@
+//! HTTP request and response statistics shared across client and server contexts.
+
+use chrono::{DateTime, Local};
+use http::{method::Method, status::StatusCode, uri::Uri};
+
+/// Shared HTTP statistics captured for every request on both client and server sides
+#[derive(Debug, Default, Clone)]
+pub struct CommonStats {
+    /// The time at which request processing began
+    pub process_start_time: DateTime<Local>,
+
+    /// The time at which request processing completed
+    pub process_end_time: DateTime<Local>,
+
+    /// The HTTP method of the request (e.g. `GET`, `POST`)
+    pub method: Method,
+
+    /// The full URI of the request
+    pub uri: Uri,
+
+    /// The HTTP status code of the response.
+    ///
+    /// Status code may be None if the service failed
+    pub status_code: Option<StatusCode>,
+
+    /// Size of the request body in bytes
+    pub req_size: i64,
+
+    /// Size of the response body in bytes
+    pub resp_size: i64,
+
+    /// Whether the request resulted in an error
+    pub is_error: bool,
+}

volo-http/src/context/stat.rs

@@ -74,7 +74,10 @@ macro_rules! impl_handler {
                     Ok(value) => value,
                     Err(rejection) => return rejection.into_response(),
                 };
-                self($($ty,)* $last).await.into_response()
+                cx.stats.record_handle_start();
+                let result = self($($ty,)* $last).await;
+                cx.stats.record_handle_finish();
+                result.into_response()
             }
         }
     };

volo-http/src/server/handler.rs

@@ -534,7 +534,7 @@ where
                 let mut cx = ServerContext::new(service.peer);
                 cx.rpc_info_mut().set_config(service.config);
                 let span = service.span_provider.on_serve(&cx);
-                let resp = service
+                let resp: http::Response<Body> = service
                     .inner
                     .call(&mut cx, req.map(Body::from_incoming))
                     .instrument(span)

volo-http/src/server/mod.rs

@@ -94,7 +94,7 @@ macro_rules! impl_getter {
 #[cfg(feature = "server")]
 pub(crate) use impl_getter;
 
-#[cfg(feature = "client")]
+#[cfg(any(feature = "client", feature = "server"))]
 macro_rules! stat_impl {
     ($t: ident) => {
         paste::paste! {
@@ -119,5 +119,5 @@ macro_rules! stat_impl {
         }
     };
 }
-#[cfg(feature = "client")]
+#[cfg(any(feature = "client", feature = "server"))]
 pub(crate) use stat_impl;

volo-http/src/utils/macros.rs

@@ -535,7 +535,7 @@ mod tests {
         }
     }
 
-    #[cfg(feature = "shmipc")]
+    #[cfg(all(feature = "shmipc", target_os = "linux"))]
     #[tokio::test]
     async fn test_decode_unexpected_eof_returns_none_when_shmipc_available() {
         let (_env, stream) = ShmipcTestEnv::new().await;
@@ -562,7 +562,7 @@ mod tests {
         assert!(result.unwrap().is_none());
     }
 
-    #[cfg(feature = "shmipc")]
+    #[cfg(all(feature = "shmipc", target_os = "linux"))]
     #[tokio::test]
     async fn test_decode_other_error_returns_error_when_shmipc_available() {
         let (_env, stream) = ShmipcTestEnv::new().await;