use std::fmt; use std::io::Write; use std::pin::Pin; use std::str::FromStr; use std::sync::Arc; use actix_web::web::{Bytes, Data}; use actix_web::{web, HttpRequest, HttpResponse}; use deserr::actix_web::AwebJson; use deserr::Deserr; use futures_util::Stream; use meilisearch_auth::AuthController; use meilisearch_types::deserr::DeserrJsonError; use meilisearch_types::error::deserr_codes::*; use meilisearch_types::error::{Code, ResponseError}; use tokio::sync::mpsc::{self}; use tracing_subscriber::Layer; use crate::error::MeilisearchHttpError; use crate::extractors::authentication::policies::*; use crate::extractors::authentication::GuardedData; use crate::extractors::sequential_extractor::SeqHandler; use crate::LogRouteHandle; pub fn configure(cfg: &mut web::ServiceConfig) { cfg.service( web::resource("") .route(web::post().to(SeqHandler(get_logs))) .route(web::delete().to(SeqHandler(cancel_logs))), ); } #[derive(Debug, Default, Clone, Copy, Deserr)] #[deserr(rename_all = lowercase)] pub enum LogLevel { Error, Warn, #[default] Info, Debug, Trace, } #[derive(Debug, Default, Clone, Copy, Deserr)] #[deserr(rename_all = lowercase)] pub enum LogMode { #[default] Fmt, Profile, } #[derive(Debug, Deserr)] #[deserr(error = DeserrJsonError, rename_all = camelCase, deny_unknown_fields)] pub struct GetLogs { #[deserr(default, error = DeserrJsonError)] pub target: String, #[deserr(default, error = DeserrJsonError)] pub mode: LogMode, } impl fmt::Display for LogLevel { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { LogLevel::Error => f.write_str("error"), LogLevel::Warn => f.write_str("warn"), LogLevel::Info => f.write_str("info"), LogLevel::Debug => f.write_str("debug"), LogLevel::Trace => f.write_str("trace"), } } } struct LogWriter { sender: mpsc::UnboundedSender>, } impl Drop for LogWriter { fn drop(&mut self) { println!("hello"); } } impl Write for LogWriter { fn write(&mut self, buf: &[u8]) -> std::io::Result { self.sender.send(buf.to_vec()).map_err(std::io::Error::other)?; Ok(buf.len()) } fn flush(&mut self) -> std::io::Result<()> { Ok(()) } } struct HandleGuard { /// We need to keep an handle on the logs to make it available again when the streamer is dropped logs: Arc, } impl Drop for HandleGuard { fn drop(&mut self) { println!("log streamer being dropped"); if let Err(e) = self.logs.modify(|layer| *layer.inner_mut() = None) { tracing::error!("Could not free the logs route: {e}"); } } } fn byte_stream( receiver: mpsc::UnboundedReceiver>, guard: HandleGuard, ) -> impl futures_util::Stream> { futures_util::stream::unfold((receiver, guard), move |(mut receiver, guard)| async move { let vec = receiver.recv().await; vec.map(From::from).map(Ok).map(|a| (a, (receiver, guard))) }) } type PinnedByteStream = Pin>>>; fn make_layer< S: tracing::Subscriber + for<'span> tracing_subscriber::registry::LookupSpan<'span>, >( opt: &GetLogs, logs: Data, ) -> (Box + Send + Sync>, PinnedByteStream) { let guard = HandleGuard { logs: logs.into_inner() }; match opt.mode { LogMode::Fmt => { let (sender, receiver) = tokio::sync::mpsc::unbounded_channel(); let fmt_layer = tracing_subscriber::fmt::layer() .with_line_number(true) .with_writer(move || LogWriter { sender: sender.clone() }) .with_span_events(tracing_subscriber::fmt::format::FmtSpan::ACTIVE); let stream = byte_stream(receiver, guard); (Box::new(fmt_layer) as Box + Send + Sync>, Box::pin(stream)) } LogMode::Profile => { let (trace, layer) = tracing_trace::Trace::new(); let stream = entry_stream(trace, guard); (Box::new(layer) as Box + Send + Sync>, Box::pin(stream)) } } } fn entry_stream( trace: tracing_trace::Trace, guard: HandleGuard, ) -> impl Stream> { let receiver = trace.into_receiver(); let entry_buf = Vec::new(); futures_util::stream::unfold( (receiver, entry_buf, guard), move |(mut receiver, mut entry_buf, guard)| async move { let mut bytes = Vec::new(); while bytes.len() < 8192 { entry_buf.clear(); let Ok(count) = tokio::time::timeout( std::time::Duration::from_secs(1), receiver.recv_many(&mut entry_buf, 100), ) .await else { break; }; if count == 0 { // channel closed, exit return None; } for entry in &entry_buf { if let Err(error) = serde_json::to_writer(&mut bytes, entry) { tracing::error!( error = &error as &dyn std::error::Error, "deserializing entry" ); return Some(( Err(ResponseError::from_msg( format!("error deserializing entry: {error}"), Code::Internal, )), (receiver, entry_buf, guard), )); } } } Some((Ok(bytes.into()), (receiver, entry_buf, guard))) }, ) } pub async fn get_logs( _auth_controller: GuardedData, Data>, logs: Data, body: AwebJson, _req: HttpRequest, ) -> Result { let opt = body.into_inner(); let mut stream = None; logs.modify(|layer| match layer.inner_mut() { None => { // there is no one getting logs *layer.filter_mut() = tracing_subscriber::filter::Targets::from_str(&opt.target).unwrap(); let (new_layer, new_stream) = make_layer(&opt, logs.clone()); *layer.inner_mut() = Some(new_layer); stream = Some(new_stream); } Some(_) => { // there is already someone getting logs } }) .unwrap(); if let Some(stream) = stream { Ok(HttpResponse::Ok().streaming(stream)) } else { Err(MeilisearchHttpError::AlreadyUsedLogRoute.into()) } } pub async fn cancel_logs( _auth_controller: GuardedData, Data>, logs: Data, _req: HttpRequest, ) -> Result { if let Err(e) = logs.modify(|layer| *layer.inner_mut() = None) { tracing::error!("Could not free the logs route: {e}"); } Ok(HttpResponse::NoContent().finish()) }