fix(api-server): Repair logging setup and enhance observability: (#1695)

Author: LinZhihao-723

components/api-server/src/bin/api_server.rs

@@ -1,7 +1,10 @@
 use anyhow::Context;
 use clap::Parser;
 use clp_rust_utils::{clp_config::package, serde::yaml};
-use tracing_appender::rolling::{RollingFileAppender, Rotation};
+use tracing_appender::{
+    non_blocking::WorkerGuard,
+    rolling::{RollingFileAppender, Rotation},
+};
 use tracing_subscriber::{self, fmt::writer::MakeWriterExt};
 
 #[derive(Parser)]
@@ -39,19 +42,27 @@ fn read_config_and_credentials(
     Ok((config, credentials))
 }
 
-fn set_up_logging() -> anyhow::Result<()> {
+fn set_up_logging() -> anyhow::Result<WorkerGuard> {
     let logs_directory =
         std::env::var("CLP_LOGS_DIR").context("Expect `CLP_LOGS_DIR` environment variable.")?;
     let logs_directory = std::path::Path::new(logs_directory.as_str());
     let file_appender =
         RollingFileAppender::new(Rotation::HOURLY, logs_directory, "api_server.log");
-    let (non_blocking_writer, _guard) = tracing_appender::non_blocking(file_appender);
+    let (non_blocking_writer, guard) = tracing_appender::non_blocking(file_appender);
     tracing_subscriber::fmt()
+        .event_format(
+            tracing_subscriber::fmt::format()
+                .with_level(true)
+                .with_target(false)
+                .with_file(true)
+                .with_line_number(true)
+                .json(),
+        )
         .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
         .with_ansi(false)
         .with_writer(std::io::stdout.and(non_blocking_writer))
         .init();
-    Ok(())
+    Ok(guard)
 }
 
 async fn shutdown_signal() {
@@ -70,7 +81,7 @@ async fn main() -> anyhow::Result<()> {
     let args = Args::parse();
 
     let (config, credentials) = read_config_and_credentials(&args)?;
-    set_up_logging()?;
+    let _guard = set_up_logging()?;
 
     let addr = format!(
         "{}:{}",

components/api-server/src/client.rs

@@ -18,7 +18,7 @@ use utoipa::ToSchema;
 pub use crate::error::ClientError;
 
 /// Defines the request configuration for submitting a search query.
-#[derive(Clone, Serialize, Deserialize, ToSchema)]
+#[derive(Clone, Debug, Serialize, Deserialize, ToSchema)]
 #[serde(deny_unknown_fields)]
 pub struct QueryConfig {
     /// The search query as a KQL string.

components/api-server/src/routes.rs

@@ -98,7 +98,17 @@ async fn query(
     State(client): State<Client>,
     Json(query_config): Json<QueryConfig>,
 ) -> Result<Json<QueryResultsUri>, HandlerError> {
-    let search_job_id = client.submit_query(query_config).await?;
+    tracing::info!("Submitting query: {:?}", query_config);
+    let search_job_id = match client.submit_query(query_config).await {
+        Ok(id) => {
+            tracing::info!("Submitted query with search job ID: {}", id);
+            id
+        }
+        Err(err) => {
+            tracing::error!("Failed to submit query: {:?}", err);
+            return Err(err.into());
+        }
+    };
     let uri = format!("/query_results/{search_job_id}");
     Ok(Json(QueryResultsUri {
         query_results_uri: uri,
@@ -133,11 +143,29 @@ async fn query_results(
     State(client): State<Client>,
     Path(search_job_id): Path<u64>,
 ) -> Result<Sse<impl Stream<Item = Result<Event, HandlerError>>>, HandlerError> {
-    let results_stream = client.fetch_results(search_job_id).await?;
+    tracing::info!("Fetching results for search job ID: {}", search_job_id);
+    let results_stream = match client.fetch_results(search_job_id).await {
+        Ok(stream) => {
+            tracing::info!(
+                "Successfully initiated result stream for search job ID {}",
+                search_job_id
+            );
+            stream
+        }
+        Err(err) => {
+            tracing::error!(
+                "Failed to fetch results for search job ID {}: {:?}",
+                search_job_id,
+                err
+            );
+            return Err(err.into());
+        }
+    };
     let event_stream = results_stream.map(|res| {
         let message = res?;
         let trimmed_message = message.trim();
         if trimmed_message.lines().count() != 1 {
+            tracing::error!("Received malformed log line:\n{}", trimmed_message);
             return Err(HandlerError::InternalServer);
         }
         Ok(Event::default().data(trimmed_message))

tools/deployment/package/docker-compose-all.yaml

@@ -510,7 +510,7 @@ services:
       CLP_LOGS_DIR: "/var/log/api_server"
       CLP_DB_PASS: "${CLP_DB_PASS:?Please set a value.}"
       CLP_DB_USER: "${CLP_DB_USER:?Please set a value.}"
-      RUST_LOG: "DEBUG"
+      RUST_LOG: "INFO"
     ports:
       - host_ip: "${CLP_API_SERVER_HOST:-127.0.0.1}"
         published: "${CLP_API_SERVER_PORT:-3001}"