Use logging filter, remove otel.

notary-server/Cargo.toml

@@ -28,8 +28,7 @@ serde_yaml = "0.9.21"
 sha1 = "0.10"
 structopt = "0.3.26"
 thiserror = "1"
-tlsn-verifier = { path = "../tlsn/tlsn-verifier" }
-tlsn-tls-core = { path = "../components/tls/tls-core" }
+tlsn-verifier = { path = "../tlsn/tlsn-verifier", features = ["tracing"] }
 tokio = { version = "1", features = ["full"] }
 tokio-rustls = { version = "0.24.1" }
 tokio-util = { version = "0.7", features = ["compat"] }
@@ -44,6 +43,7 @@ ws_stream_tungstenite = { version = "0.10.0", features = ["tokio_io"] }
 [dev-dependencies]
 # specify vendored feature to use statically linked copy of OpenSSL
 hyper-tls = { version = "0.5.0", features = ["vendored"] }
+tlsn-prover = { path = "../tlsn/tlsn-prover", features = ["tracing"] }
 tls-server-fixture = { path = "../components/tls/tls-server-fixture" }
-tlsn-prover = { path = "../tlsn/tlsn-prover" }
+tlsn-tls-core = { path = "../components/tls/tls-core" }
 tokio-native-tls = { version = "0.3.1", features = ["vendored"] }

notary-server/README.md

@@ -82,6 +82,18 @@ To perform notarization using the session id (unique id returned upon calling th
 ##### Query Parameter Type
 String
 
+---
+## Debugging
+The default logging of this server is set to `DEBUG` verbosity level for all crates (both internal and external) using tracing crate's [EnvFilter](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html).
+
+To help with debugging, one can use the following environment variable with the command to launch the server (Cargo or Docker)：
+
+`RUST_LOG=notary_server,tlsn_verifier,tls_mpc,tls_client_async=DEBUG`
+
+This effectively reduces the volume of logs by only including DEBUG-level logs from the crates that are useful for most debugging scenarios.
+
+One can always modify this env var to include any crate of interest by following tracing crate's [filter directive syntax](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax).
+
 ---
 ## Architecture
 ### Objective

notary-server/config/config.yaml

@@ -15,9 +15,6 @@ notary-key:
   private-key-pem-path: "./fixture/notary/notary.key"
   public-key-pem-path: "./fixture/notary/notary.pub"
 
-tracing:
-  default-level: DEBUG
-
 authorization:
   enabled: false
   whitelist-csv-path: "./fixture/auth/whitelist.csv"

notary-server/src/config.rs

@@ -11,8 +11,6 @@ pub struct NotaryServerProperties {
     pub tls: TLSProperties,
     /// File path of private key (in PEM format) used to sign the notarization
     pub notary_key: NotarySigningKeyProperties,
-    /// Setting for logging/tracing
-    pub tracing: TracingProperties,
     /// Setting for authorization
     pub authorization: AuthorizationProperties,
 }
@@ -57,10 +55,3 @@ pub struct NotarySigningKeyProperties {
     pub private_key_pem_path: String,
     pub public_key_pem_path: String,
 }
-
-#[derive(Clone, Debug, Deserialize)]
-#[serde(rename_all = "kebab-case")]
-pub struct TracingProperties {
-    /// The minimum logging level, must be either of <https://docs.rs/tracing/latest/tracing/struct.Level.html#implementations>
-    pub default_level: String,
-}

notary-server/src/lib.rs

@@ -9,7 +9,7 @@ mod util;
 
 pub use config::{
     AuthorizationProperties, NotarizationProperties, NotaryServerProperties,
-    NotarySigningKeyProperties, ServerProperties, TLSProperties, TracingProperties,
+    NotarySigningKeyProperties, ServerProperties, TLSProperties,
 };
 pub use domain::{
     cli::CliFields,

notary-server/src/main.rs

@@ -14,7 +14,7 @@ async fn main() -> Result<(), NotaryServerError> {
     let config: NotaryServerProperties = parse_config_file(&cli_fields.config_file)?;
 
     // Set up tracing for logging
-    init_tracing(&config).map_err(|err| eyre!("Failed to set up tracing: {err}"))?;
+    init_tracing().map_err(|err| eyre!("Failed to set up tracing: {err}"))?;
 
     debug!(?config, "Server config loaded");
 

notary-server/src/server_tracing.rs

@@ -1,21 +1,13 @@
 use eyre::Result;
-use opentelemetry::{
-    global,
-    sdk::{export::trace::stdout, propagation::TraceContextPropagator},
-};
+use tracing::metadata::LevelFilter;
 use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt, EnvFilter, Registry};
 
-use crate::config::NotaryServerProperties;
-
-pub fn init_tracing(config: &NotaryServerProperties) -> Result<()> {
-    // Create a new OpenTelemetry pipeline
-    let tracer = stdout::new_pipeline().install_simple();
-
-    // Create a tracing layer with the configured tracer
-    let tracing_layer = tracing_opentelemetry::layer().with_tracer(tracer);
-
-    // Set the log level
-    let env_filter_layer = EnvFilter::new(&config.tracing.default_level);
+pub fn init_tracing() -> Result<()> {
+    // Retrieve log filter logic from RUST_LOG env var
+    let env_filter_layer = EnvFilter::builder()
+        // if RUST_LOG is not set, then set DEBUG level logging for all crates
+        .with_default_directive(LevelFilter::DEBUG.into())
+        .from_env_lossy();
 
     // Format the log
     let format_layer = tracing_subscriber::fmt::layer()
@@ -24,11 +16,7 @@ pub fn init_tracing(config: &NotaryServerProperties) -> Result<()> {
         .with_thread_ids(true)
         .with_thread_names(true);
 
-    // Set up context propagation
-    global::set_text_map_propagator(TraceContextPropagator::default());
-
     Registry::default()
-        .with(tracing_layer)
         .with(env_filter_layer)
         .with(format_layer)
         .try_init()?;

notary-server/tests/integration_test.rs

@@ -29,7 +29,7 @@ use ws_stream_tungstenite::WsStream;
 use notary_server::{
     read_pem_file, run_server, AuthorizationProperties, NotarizationProperties,
     NotarizationSessionRequest, NotarizationSessionResponse, NotaryServerProperties,
-    NotarySigningKeyProperties, ServerProperties, TLSProperties, TracingProperties,
+    NotarySigningKeyProperties, ServerProperties, TLSProperties,
 };
 
 const NOTARY_CA_CERT_PATH: &str = "./fixture/tls/rootCA.crt";
@@ -54,9 +54,6 @@ fn get_server_config(port: u16, tls_enabled: bool) -> NotaryServerProperties {
             private_key_pem_path: "./fixture/notary/notary.key".to_string(),
             public_key_pem_path: "./fixture/notary/notary.pub".to_string(),
         },
-        tracing: TracingProperties {
-            default_level: "DEBUG".to_string(),
-        },
         authorization: AuthorizationProperties {
             enabled: false,
             whitelist_csv_path: "./fixture/auth/whitelist.csv".to_string(),