feat: switch to tracing (#223)

* feat: switch to `tracing`

* chore: get rid of useless dep

* feat: use `log` for binary stuff

* fix: typos in Cargo.toml

Cargo.toml

@@ -10,13 +10,12 @@ repository = "https://github.com/serenity-rs/poise/"
 
 [dependencies]
 tokio = { version = "1.25.1", default-features = false } # for async in general
-futures-core = { version = "0.3.13", default-features = false } # for async in general
 futures-util = { version = "0.3.13", default-features = false } # for async in general
 once_cell = { version = "1.7.2", default-features = false, features = ["std"] } # to store and set user data
 poise_macros = { path = "macros", version = "0.5.7" } # remember to update the version on changes!
 async-trait = { version = "0.1.48", default-features = false } # various traits
 regex = { version = "1.6.0", default-features = false, features = ["std"] } # prefix
-log = { version = "0.4.14", default-features = false } # warning about weird state
+tracing = { version = "0.1.40", features = ["log"] } # warning about weird state
 derivative = "2.2.0"
 parking_lot = "0.12.1"
 
@@ -29,7 +28,7 @@ version = "0.11.5"
 # For the examples
 tokio = { version = "1.25.1", features = ["rt-multi-thread"] }
 futures = { version = "0.3.13", default-features = false }
-env_logger = "0.10.0"
+env_logger = "0.10.1"
 fluent = "0.16.0"
 intl-memoizer = "0.5.1"
 fluent-syntax = "0.11"

examples/fluent_localization/translation.rs

@@ -59,7 +59,7 @@ pub fn get(
         .or_else(|| format(&translations.main, id, attr, args))
         // If this message ID is not present in any translation files whatsoever
         .unwrap_or_else(|| {
-            log::warn!("unknown fluent message identifier `{}`", id);
+            tracing::warn!("unknown fluent message identifier `{}`", id);
             id.to_string()
         })
 }

src/builtins/mod.rs

@@ -16,8 +16,9 @@ pub use paginate::*;
 
 use crate::serenity_prelude as serenity;
 
-/// An error handler that logs errors either via the [`log`] crate or via a Discord message. Set
-/// up a logger (e.g. `env_logger::init()`) to see the logged errors from this method.
+/// An error handler that logs errors either via the [`tracing`] crate or via a Discord message. Set
+/// up a logger (e.g. `env_logger::init()`) or a tracing subscriber
+/// (e.g. `tracing_subscriber::fmt::init()`) to see the logged errors from this method.
 ///
 /// If the user invoked the command wrong ([`crate::FrameworkError::ArgumentParse`]), the command
 /// help is displayed and the user is directed to the help menu.
@@ -27,7 +28,7 @@ use crate::serenity_prelude as serenity;
 /// ```rust,no_run
 /// # async { let error: poise::FrameworkError<'_, (), &str> = todo!();
 /// if let Err(e) = poise::builtins::on_error(error).await {
-///     log::error!("Fatal error while sending error message: {}", e);
+///     tracing::error!("Fatal error while sending error message: {}", e);
 /// }
 /// # };
 /// ```
@@ -38,7 +39,7 @@ pub async fn on_error<U, E: std::fmt::Display + std::fmt::Debug>(
         crate::FrameworkError::Setup { error, .. } => {
             eprintln!("Error in user data setup: {}", error);
         }
-        crate::FrameworkError::EventHandler { error, event, .. } => log::error!(
+        crate::FrameworkError::EventHandler { error, event, .. } => tracing::error!(
             "User event event handler encountered an error on {} event: {}",
             event.name(),
             error
@@ -91,14 +92,14 @@ pub async fn on_error<U, E: std::fmt::Display + std::fmt::Debug>(
             ctx.say(response).await?;
         }
         crate::FrameworkError::CommandStructureMismatch { ctx, description } => {
-            log::error!(
+            tracing::error!(
                 "Error: failed to deserialize interaction arguments for `/{}`: {}",
                 ctx.command.name,
                 description,
             );
         }
         crate::FrameworkError::CommandCheckFailed { ctx, error } => {
-            log::error!(
+            tracing::error!(
                 "A command check failed in command {} for user {}: {:?}",
                 ctx.command().name,
                 ctx.author().name,
@@ -162,7 +163,7 @@ pub async fn on_error<U, E: std::fmt::Display + std::fmt::Debug>(
             ctx.send(|b| b.content(response).ephemeral(true)).await?;
         }
         crate::FrameworkError::DynamicPrefix { error, msg, .. } => {
-            log::error!(
+            tracing::error!(
                 "Dynamic prefix failed for message {:?}: {}",
                 msg.content,
                 error
@@ -173,14 +174,14 @@ pub async fn on_error<U, E: std::fmt::Display + std::fmt::Debug>(
             prefix,
             ..
         } => {
-            log::warn!(
+            tracing::warn!(
                 "Recognized prefix `{}`, but didn't recognize command name in `{}`",
                 prefix,
                 msg_content,
             );
         }
         crate::FrameworkError::UnknownInteraction { interaction, .. } => {
-            log::warn!(
+            tracing::warn!(
                 "received unknown interaction \"{}\"",
                 interaction.data().name
             );

src/builtins/register.rs

@@ -244,7 +244,7 @@ pub async fn register_application_commands_buttons<U, E>(
         "register.guild" => (true, false),
         "unregister.guild" => (false, false),
         other => {
-            log::warn!("unknown register button ID: {:?}", other);
+            tracing::warn!("unknown register button ID: {:?}", other);
             return Ok(());
         }
     };

src/dispatch/common.rs

@@ -21,7 +21,7 @@ async fn user_permissions(
     let channel = match channel_id.to_channel(ctx).await {
         Ok(serenity::Channel::Guild(channel)) => channel,
         Ok(_other_channel) => {
-            log::warn!(
+            tracing::warn!(
                 "guild message was supposedly sent in a non-guild channel. Denying invocation"
             );
             return None;
@@ -97,7 +97,7 @@ async fn check_permissions_and_cooldown_single<'a, U, E>(
         let channel = match ctx.channel_id().to_channel(ctx.serenity_context()).await {
             Ok(channel) => channel,
             Err(e) => {
-                log::warn!("Error when getting channel: {}", e);
+                tracing::warn!("Error when getting channel: {}", e);
 
                 return Err(crate::FrameworkError::NsfwOnly { ctx });
             }

src/dispatch/mod.rs

@@ -124,7 +124,7 @@ pub async fn dispatch_event<U: Send + Sync, E>(
                     .process_message_delete(*deleted_message_id);
                 if let Some(bot_response) = bot_response {
                     if let Err(e) = bot_response.delete(ctx).await {
-                        log::warn!("failed to delete bot response: {}", e);
+                        tracing::warn!("failed to delete bot response: {}", e);
                     }
                 }
             }

src/dispatch/slash.rs

@@ -141,7 +141,7 @@ async fn run_command<U, E>(
             }
         }
         other => {
-            log::warn!("unknown interaction command type: {:?}", other);
+            tracing::warn!("unknown interaction command type: {:?}", other);
             return Ok(());
         }
     };
@@ -194,7 +194,7 @@ async fn run_autocomplete<U, E>(
     let focused_option = match ctx.args.iter().find(|o| o.focused) {
         Some(x) => x,
         None => {
-            log::warn!("no option is focused in autocomplete interaction");
+            tracing::warn!("no option is focused in autocomplete interaction");
             return Ok(());
         }
     };
@@ -232,15 +232,15 @@ async fn run_autocomplete<U, E>(
     let autocomplete_response = match autocomplete_callback(ctx, partial_input).await {
         Ok(x) => x,
         Err(e) => {
-            log::warn!("couldn't generate autocomplete response: {}", e);
+            tracing::warn!("couldn't generate autocomplete response: {}", e);
             return Ok(());
         }
     };
 
     let interaction = match ctx.interaction {
         crate::ApplicationCommandOrAutocompleteInteraction::Autocomplete(x) => x,
         _ => {
-            log::warn!("a non-autocomplete interaction was given to run_autocomplete()");
+            tracing::warn!("a non-autocomplete interaction was given to run_autocomplete()");
             return Ok(());
         }
     };
@@ -253,7 +253,7 @@ async fn run_autocomplete<U, E>(
         })
         .await
     {
-        log::warn!("couldn't send autocomplete response: {}", e);
+        tracing::warn!("couldn't send autocomplete response: {}", e);
     }
 
     Ok(())

src/framework/builder.rs

@@ -211,7 +211,7 @@ and enable MESSAGE_CONTENT in your Discord bot dashboard
         options.commands.extend(self.commands);
         if self.initialize_owners {
             if let Err(e) = super::insert_owners_from_http(&token, &mut options.owners).await {
-                log::warn!("Failed to insert owners from HTTP: {}", e);
+                tracing::warn!("Failed to insert owners from HTTP: {}", e);
             }
         }
 

src/framework/mod.rs

@@ -290,7 +290,9 @@ fn message_content_intent_sanity_check<U, E>(
         || prefix_options.stripped_dynamic_prefix.is_some();
     let can_receive_message_content = intents.contains(serenity::GatewayIntents::MESSAGE_CONTENT);
     if is_prefix_configured && !can_receive_message_content {
-        log::warn!("Warning: MESSAGE_CONTENT intent not set; prefix commands will not be received");
+        tracing::warn!(
+            "Warning: MESSAGE_CONTENT intent not set; prefix commands will not be received"
+        );
     }
 }
 

src/modal.rs

@@ -16,11 +16,11 @@ pub fn find_modal_text(
         let text = match row.components.get_mut(0) {
             Some(serenity::ActionRowComponent::InputText(text)) => text,
             Some(_) => {
-                log::warn!("unexpected non input text component in modal response");
+                tracing::warn!("unexpected non input text component in modal response");
                 continue;
             }
             None => {
-                log::warn!("empty action row in modal response");
+                tracing::warn!("empty action row in modal response");
                 continue;
             }
         };
@@ -30,7 +30,7 @@ pub fn find_modal_text(
             return if value.is_empty() { None } else { Some(value) };
         }
     }
-    log::warn!(
+    tracing::warn!(
         "{} not found in modal response (expected at least blank string)",
         custom_id
     );

src/structs/context.rs

@@ -504,7 +504,7 @@ context_methods! {
         match self.framework().shard_manager.lock().await.runners.lock().await.get(&serenity::ShardId(self.serenity_context().shard_id)) {
             Some(runner) => runner.latency.unwrap_or(std::time::Duration::ZERO),
             None => {
-                log::error!("current shard is not in shard_manager.runners, this shouldn't happen");
+                tracing::error!("current shard is not in shard_manager.runners, this shouldn't happen");
                 std::time::Duration::ZERO
             }
         }