add CLI flag disable-spans to toggle span trace logging (#481)

Co-authored-by: Orion Bloomfield <[email protected]>

Author: obloomfield

README.md

@@ -290,6 +290,11 @@ Options:
 
           [env: JSON_OUTPUT=]
 
+      --disable-spans
+          Disables the span logging trace
+
+          [env: DISABLE_SPANS=]
+
       --otlp-endpoint <OTLP_ENDPOINT>
           The grpc endpoint for opentelemetry. Telemetry is sent to this endpoint as OTLP over gRPC. e.g. `http://localhost:4317`
 

docs/source/en/cli_arguments.md

@@ -182,6 +182,11 @@ Options:
 
           [env: JSON_OUTPUT=]
 
+      --disable-spans
+          Disables the span logging trace
+
+          [env: DISABLE_SPANS=]
+
       --otlp-endpoint <OTLP_ENDPOINT>
           The grpc endpoint for opentelemetry. Telemetry is sent to this endpoint as OTLP over gRPC. e.g. `http://localhost:4317`
 

router/src/logging.rs

@@ -14,6 +14,7 @@ pub fn init_logging(
     otlp_endpoint: Option<&String>,
     otlp_service_name: String,
     json_output: bool,
+    disable_spans: bool,
 ) -> bool {
     let mut layers = Vec::new();
 
@@ -22,10 +23,15 @@ pub fn init_logging(
         .with_file(true)
         .with_line_number(true);
 
-    let fmt_layer = match json_output {
-        true => fmt_layer.json().flatten_event(true).boxed(),
-        false => fmt_layer.boxed(),
-    };
+        let fmt_layer = match json_output {
+          true => fmt_layer
+              .json()
+              .flatten_event(true)
+              .with_current_span(!disable_spans)
+              .with_span_list(!disable_spans)
+              .boxed(),
+          false => fmt_layer.boxed(),
+      };
     layers.push(fmt_layer);
 
     // OpenTelemetry tracing layer

router/src/main.rs

@@ -150,6 +150,10 @@ struct Args {
     #[clap(long, env)]
     json_output: bool,
 
+    // Whether or not to include the log trace through spans
+    #[clap(long, env)]
+    disable_spans: bool,
+
     /// The grpc endpoint for opentelemetry. Telemetry is sent to this endpoint as OTLP over gRPC.
     /// e.g. `http://localhost:4317`
     #[clap(long, env)]
@@ -175,6 +179,7 @@ async fn main() -> Result<()> {
         args.otlp_endpoint.as_ref(),
         args.otlp_service_name.clone(),
         args.json_output,
+        args.disable_spans,
     );
 
     tracing::info!("{args:?}");