Allow overriding tracing filter with RUST_LOG env var (informalsyst…

…ems#1896)

Closes: informalsystems#1895

With this PR, one can set the `RUST_LOG` variable to `tendermint_rpc=debug,ibc_relayer=info,ibc_relayer_cli=info` in order to enable debug output for `tendermint-rpc` and info output for the relayer.

```shell
RUST_LOG=tendermint_rpc=debug,ibc_relayer=info,ibc_relayer_cli=info hermes start
```

---

* Allow overriding tracing filter with `RUST_LOG` env var

* Fix warning

* Add changelog entry

* Rename `log_level` to `default_level` as the parameter is ignored if `RUST_LOG` is set

Co-authored-by: Mikhail Zabaluev <mikhail@informal.systems>

* Better log message

Co-authored-by: Mikhail Zabaluev <mikhail@informal.systems>

* Small refactor

Co-authored-by: Mikhail Zabaluev <mikhail@informal.systems>

.changelog/unreleased/features/ibc-relayer-cli/1895-rust-log.md

@@ -0,0 +1,2 @@
+- Allow overriding the tracing filter with `RUST_LOG` environment variable
+  ([#1895](https://github.com/informalsystems/ibc-rs/issues/1895))

relayer-cli/src/commands/start.rs

@@ -33,7 +33,7 @@ impl Runnable for StartCmd {
         let config = (*app_config()).clone();
         let config = Arc::new(RwLock::new(config));
 
-        let supervisor_handle = make_supervisor::<ProdChainHandle>(config.clone(), self.full_scan)
+        let supervisor_handle = make_supervisor::<ProdChainHandle>(config, self.full_scan)
             .unwrap_or_else(|e| {
                 Output::error(format!("Hermes failed to start, last error: {}", e)).exit()
             });

relayer-cli/src/components.rs

@@ -1,10 +1,14 @@
 use abscissa_core::{Component, FrameworkError, FrameworkErrorKind};
 use tracing_subscriber::{filter::EnvFilter, util::SubscriberInitExt, FmtSubscriber};
 
-use ibc_relayer::config::GlobalConfig;
+use ibc_relayer::config::{GlobalConfig, LogLevel};
 
 use crate::config::Error;
 
+/// The name of the environment variable through which one can override
+/// the tracing filter built in [`build_tracing_filter`].
+const HERMES_LOG_VAR: &str = "RUST_LOG";
+
 /// A custom component for parametrizing `tracing` in the relayer.
 /// Primarily used for:
 ///
@@ -17,7 +21,7 @@ pub struct JsonTracing;
 impl JsonTracing {
     /// Creates a new [`JsonTracing`] component
     pub fn new(cfg: GlobalConfig) -> Result<Self, FrameworkError> {
-        let filter = build_tracing_filter(cfg.log_level.to_string())?;
+        let filter = build_tracing_filter(cfg.log_level)?;
         // Note: JSON formatter is un-affected by ANSI 'color' option. Set to 'false'.
         let use_color = false;
 
@@ -43,7 +47,7 @@ pub struct PrettyTracing;
 impl PrettyTracing {
     /// Creates a new [`PrettyTracing`] component
     pub fn new(cfg: GlobalConfig) -> Result<Self, FrameworkError> {
-        let filter = build_tracing_filter(cfg.log_level.to_string())?;
+        let filter = build_tracing_filter(cfg.log_level)?;
 
         // Construct a tracing subscriber with the supplied filter and enable reloading.
         let builder = FmtSubscriber::builder()
@@ -68,30 +72,38 @@ pub fn enable_ansi() -> bool {
     atty::is(atty::Stream::Stdout) && atty::is(atty::Stream::Stderr)
 }
 
-/// Builds a tracing filter based on the input `log_level`.
-/// Enables tracing exclusively for the relayer crates.
-/// Returns error if the filter failed to build.
-fn build_tracing_filter(log_level: String) -> Result<EnvFilter, FrameworkError> {
-    let target_crates = ["ibc_relayer", "ibc_relayer_cli"];
+/// The relayer crates targeted by the default log level.
+const TARGET_CRATES: [&str; 2] = ["ibc_relayer", "ibc_relayer_cli"];
+
+/// Build a tracing directive setting the log level for the relayer crates to the
+/// given `log_level`.
+fn default_directive(log_level: LogLevel) -> String {
+    use itertools::Itertools;
 
-    // SAFETY: unwrap() below works as long as `target_crates` is not empty.
-    let directive_raw = target_crates
+    TARGET_CRATES
         .iter()
         .map(|&c| format!("{}={}", c, log_level))
-        .reduce(|a, b| format!("{},{}", a, b))
-        .unwrap();
+        .join(",")
+}
+
+/// Builds a tracing filter based on the input `log_level`.
+/// Enables tracing exclusively for the relayer crates.
+/// Returns error if the filter failed to build.
+fn build_tracing_filter(default_level: LogLevel) -> Result<EnvFilter, FrameworkError> {
+    let directive =
+        std::env::var(HERMES_LOG_VAR).unwrap_or_else(|_| default_directive(default_level));
 
     // Build the filter directive
-    match EnvFilter::try_new(directive_raw.clone()) {
+    match EnvFilter::try_new(&directive) {
         Ok(out) => Ok(out),
         Err(e) => {
             eprintln!(
-                "Unable to initialize Hermes from filter directive {:?}: {}",
-                directive_raw, e
+                "ERROR: unable to initialize Hermes with log filtering directive {:?}: {}",
+                directive, e
             );
-            let our_err = Error::invalid_log_level(log_level, e);
+
             Err(FrameworkErrorKind::ConfigError
-                .context(format!("{}", our_err))
+                .context(Error::invalid_log_directive(directive, e))
                 .into())
         }
     }

relayer-cli/src/config.rs

@@ -28,12 +28,11 @@ define_error! {
         ZeroChain
             |_| { "config file does not specify any chain" },
 
-        InvalidLogLevel
-            { log_level: String, }
+        InvalidLogDirective
+            { directive: String, }
             [ TraceError<ParseError> ]
             |e| {
-                format!("config file specifies an invalid log level ('{0}'), caused by",
-                    e.log_level)
+                format!("invalid log directive: {0:?}", e.directive)
             },
 
         InvalidMode

relayer/src/config.rs

@@ -265,7 +265,7 @@ impl Default for Packets {
 /// Log levels are wrappers over [`tracing_core::Level`].
 ///
 /// [`tracing_core::Level`]: https://docs.rs/tracing-core/0.1.17/tracing_core/struct.Level.html
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Copy, Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(rename_all = "lowercase")]
 pub enum LogLevel {
     Trace,