Add support for tokio-vsock

Author: domenkozar

Cargo.lock

@@ -29,6 +29,7 @@ default = ["env-filter"]
 parking_lot = ["dep:parking_lot", "tracing-subscriber/parking_lot"]
 env-filter = ["tracing-subscriber/env-filter"]
 grpc-web = ["dep:tonic-web"]
+vsock = ["dep:tokio-vsock"]
 
 [dependencies]
 crossbeam-utils = "0.8.7"
@@ -56,6 +57,9 @@ crossbeam-channel = "0.5"
 # Only for the web feature:
 tonic-web = { version = "0.12", optional = true }
 
+# Only for the vsock feature:
+tokio-vsock = { version = "0.7", optional = true }
+
 [dev-dependencies]
 tokio = { version = "1.34", features = ["full", "rt-multi-thread"] }
 tower = { version = "0.4.12", default-features = false, features = ["util"] }

console-subscriber/Cargo.toml

@@ -152,10 +152,11 @@ impl Builder {
     /// before falling back on constructing a socket address from those
     /// defaults.
     ///
-    /// The socket address can be either a TCP socket address or a
-    /// [Unix domain socket] (UDS) address. Unix domain sockets are only
-    /// supported on Unix-compatible operating systems, such as Linux, BSDs,
-    /// and macOS.
+    /// The socket address can be either a TCP socket address, a
+    /// [Unix domain socket] (UDS) address, or a [Vsock] address. 
+    /// Unix domain sockets are only supported on Unix-compatible operating systems, 
+    /// such as Linux, BSDs, and macOS. Vsock addresses are only available when the 
+    /// "vsock" feature is enabled and are supported on platforms with vsock capability.
     ///
     /// Each call to this method will overwrite the previously set value.
     ///
@@ -180,9 +181,18 @@ impl Builder {
     /// #[cfg(unix)]
     /// let builder = Builder::default().server_addr(Path::new("/tmp/tokio-console"));
     /// ```
+    /// 
+    /// Connect using a vsock connection (requires the "vsock" feature):
+    ///
+    /// ```
+    /// # use console_subscriber::Builder;
+    /// # #[cfg(feature = "vsock")]
+    /// let builder = Builder::default().server_addr((tokio_vsock::VMADDR_CID_ANY, 6669));
+    /// ```
     ///
     /// [environment variable]: `Builder::with_default_env`
     /// [Unix domain socket]: https://en.wikipedia.org/wiki/Unix_domain_socket
+    /// [Vsock]: https://docs.rs/tokio-vsock/latest/tokio_vsock/
     pub fn server_addr(self, server_addr: impl Into<ServerAddr>) -> Self {
         Self {
             server_addr: server_addr.into(),
@@ -574,6 +584,9 @@ pub enum ServerAddr {
     /// A Unix socket address.
     #[cfg(unix)]
     Unix(PathBuf),
+    /// A vsock address.
+    #[cfg(feature = "vsock")]
+    Vsock(tokio_vsock::VsockAddr),
 }
 
 impl From<SocketAddr> for ServerAddr {
@@ -617,6 +630,13 @@ impl<'a> From<&'a Path> for ServerAddr {
     }
 }
 
+#[cfg(feature = "vsock")]
+impl From<tokio_vsock::VsockAddr> for ServerAddr {
+    fn from(addr: tokio_vsock::VsockAddr) -> ServerAddr {
+        ServerAddr::Vsock(addr)
+    }
+}
+
 /// Initializes the console [tracing `Subscriber`][sub] and starts the console
 /// subscriber [`Server`] on its own background thread.
 ///

console-subscriber/src/builder.rs

@@ -2,6 +2,9 @@
 use console_api as proto;
 use proto::{instrument::instrument_server::InstrumentServer, resources::resource};
 use serde::Serialize;
+#[cfg(feature = "vsock")]
+use tokio_vsock::VsockListener;
+
 use std::{
     cell::RefCell,
     fmt,
@@ -955,6 +958,12 @@ impl Server {
                 let serve = router.serve_with_incoming(UnixListenerStream::new(incoming));
                 spawn_named(serve, "console::serve").await
             }
+            #[cfg(feature = "vsock")]
+            ServerAddr::Vsock(addr) => {
+                let incoming = VsockListener::bind(addr)?.incoming();
+                let serve = router.serve_with_incoming(incoming);
+                spawn_named(serve, "console::serve").await
+            }
         };
         aggregate.abort();
         res?.map_err(Into::into)
@@ -1082,6 +1091,12 @@ impl Server {
                 let serve = router.serve_with_incoming(UnixListenerStream::new(incoming));
                 spawn_named(serve, "console::serve").await
             }
+            #[cfg(feature = "vsock")]
+            ServerAddr::Vsock(addr) => {
+                let incoming = VsockListener::bind(addr)?.incoming();
+                let serve = router.serve_with_incoming(incoming);
+                spawn_named(serve, "console::serve").await
+            }
         };
         aggregate.abort();
         res?.map_err(Into::into)

console-subscriber/src/lib.rs

@@ -32,6 +32,10 @@ path-guid = "3DF6EE78-06E2-42BF-99AA-9A463E328BBD"
 license = false
 eula = false
 
+[features]
+default = []
+vsock = ["dep:tokio-vsock"]
+
 [dependencies]
 console-api = { version = "0.8.1", path = "../console-api", features = ["transport"] }
 clap = { version = "~4.5.4", features = ["wrap_help", "cargo", "derive", "env"] }
@@ -59,6 +63,7 @@ serde = { version = "1.0.145", features = ["derive"] }
 toml = "0.5"
 dirs = "5"
 hyper-util = { version = "0.1.6", features = ["tokio"] }
+tokio-vsock = { version = "0.7.0", optional = true }
 
 [dev-dependencies]
 trycmd = "0.15.4"