make tracing init consistent across examples

greenwoodcm · greenwoodcm · commit 60554fc0e02d · 2023-02-28T10:08:13.000-08:00
this just copies the code across examples so that we're initializing
the tracing subscriber in a consistent way.  we want to set a max
level, disable printing the name of the module every time, disable
ANSI color codes (because CloudWatch prints them in a non-readable
way), and disable logging the time at this layer because CloudWatch
is going to add the ingestion time itself.
diff --git a/examples/advanced-sqs-partial-batch-failures/src/main.rs b/examples/advanced-sqs-partial-batch-failures/src/main.rs
@@ -28,10 +28,14 @@ async fn data_handler(data: Data) -> Result<(), Error> {
 /// Main function for the lambda executable.
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
         // disable printing the name of the module in every log line.
         .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/basic-error-handling/src/main.rs b/examples/basic-error-handling/src/main.rs
@@ -49,10 +49,14 @@ impl std::fmt::Display for CustomError {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/basic-lambda/src/main.rs b/examples/basic-lambda/src/main.rs
@@ -24,8 +24,14 @@ struct Response {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/basic-shared-resource/src/main.rs b/examples/basic-shared-resource/src/main.rs
@@ -47,6 +47,11 @@ async fn main() -> Result<(), Error> {
     // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/basic-sqs/src/main.rs b/examples/basic-sqs/src/main.rs
@@ -20,10 +20,14 @@ async fn function_handler(event: LambdaEvent<SqsEventObj<Data>>) -> Result<(), E
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
         // disable printing the name of the module in every log line.
         .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/extension-basic/src/main.rs b/examples/extension-basic/src/main.rs
@@ -14,10 +14,14 @@ async fn my_extension(event: LambdaEvent) -> Result<(), Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/extension-combined/src/main.rs b/examples/extension-combined/src/main.rs
@@ -29,10 +29,14 @@ async fn my_log_processor(logs: Vec<LambdaLog>) -> Result<(), Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/extension-custom-events/src/main.rs b/examples/extension-custom-events/src/main.rs
@@ -16,10 +16,14 @@ async fn my_extension(event: LambdaEvent) -> Result<(), Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/extension-custom-service/src/main.rs b/examples/extension-custom-service/src/main.rs
@@ -33,10 +33,14 @@ impl Service<LambdaEvent> for MyExtension {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/extension-logs-basic/src/main.rs b/examples/extension-logs-basic/src/main.rs
@@ -15,10 +15,14 @@ async fn handler(logs: Vec<LambdaLog>) -> Result<(), Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/extension-logs-custom-service/src/main.rs b/examples/extension-logs-custom-service/src/main.rs
@@ -56,10 +56,14 @@ impl Service<Vec<LambdaLog>> for MyLogsProcessor {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/extension-logs-kinesis-firehose/src/main.rs b/examples/extension-logs-kinesis-firehose/src/main.rs
@@ -53,6 +53,18 @@ impl Service<Vec<LambdaLog>> for FirehoseLogsProcessor {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
+    tracing_subscriber::fmt()
+        .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
+        // disabling time is handy because CloudWatch will add the ingestion time.
+        .without_time()
+        .init();
+
     let config = aws_config::load_from_env().await;
     let logs_processor = SharedService::new(FirehoseLogsProcessor::new(Client::new(&config)));
 
diff --git a/examples/extension-telemetry-basic/src/main.rs b/examples/extension-telemetry-basic/src/main.rs
@@ -40,10 +40,14 @@ async fn handler(events: Vec<LambdaTelemetry>) -> Result<(), Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-axum/src/main.rs b/examples/http-axum/src/main.rs
@@ -37,8 +37,14 @@ async fn post_foo_name(Path(name): Path<String>) -> Json<Value> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-basic-lambda/src/main.rs b/examples/http-basic-lambda/src/main.rs
@@ -19,8 +19,14 @@ async fn function_handler(_event: Request) -> Result<Response<Body>, Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-cors/src/main.rs b/examples/http-cors/src/main.rs
@@ -5,10 +5,14 @@ use tower_http::cors::{Any, CorsLayer};
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-dynamodb/src/main.rs b/examples/http-dynamodb/src/main.rs
@@ -54,8 +54,14 @@ async fn handle_request(db_client: &Client, event: Request) -> Result<Response<B
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-query-parameters/src/main.rs b/examples/http-query-parameters/src/main.rs
@@ -17,8 +17,14 @@ async fn function_handler(event: Request) -> Result<impl IntoResponse, Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-raw-path/src/main.rs b/examples/http-raw-path/src/main.rs
@@ -2,10 +2,14 @@ use lambda_http::{service_fn, Error, IntoResponse, Request, RequestExt};
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-shared-resource/src/main.rs b/examples/http-shared-resource/src/main.rs
@@ -12,10 +12,14 @@ impl SharedClient {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    // The runtime logging can be enabled here by initializing `tracing` with `tracing-subscriber`
-    // While `tracing` is used internally, `log` can be used as well if preferred.
+    // required to enable CloudWatch error logging by the runtime
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();
diff --git a/examples/http-tower-trace/src/main.rs b/examples/http-tower-trace/src/main.rs
@@ -9,7 +9,17 @@ async fn handler(_req: Request) -> Result<Response<String>, Error> {
 
 #[tokio::main]
 async fn main() -> Result<(), Error> {
-    tracing_subscriber::fmt().without_time().init();
+    // required to enable CloudWatch error logging by the runtime
+    tracing_subscriber::fmt()
+        .with_max_level(tracing::Level::INFO)
+        // disable printing the name of the module in every log line.
+        .with_target(false)
+        // this needs to be set to false, otherwise ANSI color codes will
+        // show up in a confusing manner in CloudWatch logs.
+        .with_ansi(false)
+        // disabling time is handy because CloudWatch will add the ingestion time.
+        .without_time()
+        .init();
 
     let layer = TraceLayer::new_for_http()
         .on_request(DefaultOnRequest::new().level(Level::INFO))
