log: add tokio-console support

examples/watch_pods.rs

@@ -12,17 +12,8 @@ use tracing::Instrument;
 #[derive(Parser)]
 #[clap(version)]
 struct Args {
-    /// The tracing filter used for logs
-    #[clap(
-        long,
-        env = "KUBERT_EXAMPLE_LOG",
-        default_value = "watch_pods=info,warn"
-    )]
-    log_level: kubert::LogFilter,
-
-    /// The logging format
-    #[clap(long, default_value = "plain")]
-    log_format: kubert::LogFormat,
+    #[clap(flatten)]
+    log: kubert::LogArgs,
 
     #[clap(flatten)]
     client: kubert::ClientArgs,
@@ -46,8 +37,7 @@ struct Args {
 #[tokio::main]
 async fn main() -> Result<()> {
     let Args {
-        log_level,
-        log_format,
+        log,
         client,
         admin,
         exit,
@@ -62,7 +52,7 @@ async fn main() -> Result<()> {
     // - an admin server with /live and /ready endpoints
     // - a tracing (logging) subscriber
     let rt = kubert::Runtime::builder()
-        .with_log(log_level, log_format)
+        .with_log_args(log)
         .with_admin(admin)
         .with_client(client);
     let mut runtime = match time::timeout_at(deadline, rt.build()).await {

kubert/Cargo.toml

@@ -23,7 +23,8 @@ index = [
     "tracing",
 ]
 initialized = ["futures-core", "futures-util", "pin-project-lite", "tokio/sync"]
-log = ["thiserror", "tracing", "tracing-subscriber"]
+log = ["thiserror", "tracing", "tracing-subscriber", "once_cell"]
+tokio-console = ["tracing-subscriber", "console-subscriber"]
 requeue = ["futures-core", "tokio/macros", "tokio/sync", "tokio-util/time", "tracing"]
 runtime = [
     "admin",
@@ -80,6 +81,7 @@ features = [
 
 [dependencies]
 ahash = { version = "0.7", optional = true }
+console-subscriber = { version = "0.1", optional = true }
 drain = { version = "0.1.1", optional = true, default-features = false }
 futures-core = { version = "0.3", optional = true, default-features = false }
 futures-util = { version = "0.3", optional = true, default-features = false }
@@ -94,12 +96,13 @@ tokio-util = { version = "0.7", optional = true, default-features = false }
 tokio-rustls = { version = "0.23.2", optional = true, default-features = false }
 tower-service = { version = "0.3.1", optional = true }
 tracing = { version = "0.1.31", optional = true }
+once_cell = { version = "1.10", optional = true }
 
 [dependencies.clap]
 version = "3.1.0"
 optional = true
 default-features = false
-features = ["derive", "std"]
+features = ["derive", "std", "env"]
 
 # Not used directly, but required to ensure that the k8s-openapi dependency is considered part of
 # the "deps" graph rather than just the "dev-deps" graph
@@ -125,7 +128,7 @@ optional = true
 default-features = false
 
 [dependencies.tracing-subscriber]
-version = "0.3.9"
+version = "0.3.11"
 optional = true
 default-features = false
 features = [
@@ -146,4 +149,4 @@ tracing-subscriber = { version = "0.3", features = ["ansi"] }
 [dev-dependencies.tokio]
 version = "1.17"
 default-features = false
-features = ["macros", "test-util"]
+features = ["macros", "test-util", "rt-multi-thread"]

kubert/src/admin.rs

@@ -150,7 +150,8 @@ impl Bound {
                 ))
             }));
 
-        let task = tokio::spawn(
+        let task = crate::spawn_named(
+            "kubert::admin",
             async move {
                 debug!("Serving");
                 server.await

kubert/src/lib.rs

@@ -56,10 +56,34 @@ pub use self::client::ClientArgs;
 pub use self::initialized::Initialized;
 
 #[cfg(all(feature = "log"))]
-pub use self::log::{LogFilter, LogFormat, LogInitError};
+pub use self::log::{LogArgs, LogFilter, LogFormat, LogInitError};
 
 #[cfg(all(feature = "runtime"))]
 pub use self::runtime::Runtime;
 
 #[cfg(all(feature = "server"))]
 pub use self::server::ServerArgs;
+
+#[cfg(all(tokio_unstable, feature = "tokio-console"))]
+#[track_caller]
+pub(crate) fn spawn_named<T>(
+    name: &'static str,
+    f: impl std::future::Future<Output = T> + Send + 'static,
+) -> tokio::task::JoinHandle<T>
+where
+    T: Send + 'static,
+{
+    tokio::task::Builder::new().name(name).spawn(f)
+}
+
+#[cfg(not(all(tokio_unstable, feature = "tokio-console")))]
+#[track_caller]
+pub(crate) fn spawn_named<T>(
+    _: &'static str,
+    f: impl std::future::Future<Output = T> + Send + 'static,
+) -> tokio::task::JoinHandle<T>
+where
+    T: Send + 'static,
+{
+    tokio::spawn(f)
+}