rust的axum框架中,如何为每个请求记录用于日志追踪的日志ID
- User
rust的axum框架中,如何为每个请求记录用于日志追踪的日志ID
- Assistant
在axum框架中,可以使用
tower中的layer来为每个请求添加用于日志追踪的唯一标识符。具体实现步骤如下:
-
新建一个用于生成唯一ID的结构体,例如:
use uuid::Uuid; struct RequestIdGenerator; impl RequestIdGenerator { fn new() -> Self { Self } fn generate_id(&self) -> String { Uuid::new_v4().to_string() } } -
创建一个
LoggingMiddleware中间件,用于为每个请求添加唯一ID,并将ID添加到日志中:use axum::{extract::{Extension, Path}, handler::get, Router}; use std::sync::Arc; use tower_http::{ trace::{DefaultMakeSpan, TraceLayer}, TraceMiddleware, }; #[tokio::main] async fn main() { let app = Router::new().route("/", get(handler)); let request_id_generator = Arc::new(RequestIdGenerator::new()); let trace_layer = TraceLayer::<_, _, _, DefaultMakeSpan>::new().make_span_with(move |_req| { tracing::info_span!("span", request_id = %request_id_generator.generate_id()) }); let middleware = TraceMiddleware::new(trace_layer).app_data(Extension::new(request_id_generator)); let app = middleware.combine(app); axum::Server::bind(&"0.0.0.0:3000".parse().unwrap()) .serve(app.into_make_service()) .await .unwrap(); }在
TraceMiddleware中,使用了TraceLayer来记录Span,在生成Span时通过闭包传入了请求ID并返回一个包含请求ID的Span。TraceMiddleware将生成的Span和请求ID添加到extensions中,后续的处理函数就可以通过Extension来访问请求ID。 -
在处理函数中,通过
Extension提取请求ID,并将请求ID添加到日志中:async fn handler( Extension(request_id): Extension<Arc<RequestIdGenerator>>, Path(_): Path<String>, ) -> String { tracing::info!("handling request with id: {}", request_id.generate_id()); "Hello, World!".into() }在处理函数
handler中,通过Extension提取了请求ID,然后在日志中输出了请求ID。
有了上述实现,每个请求都会有一个唯一的请求ID,并且请求ID可以在日志中被追踪和使用。
-
- User
tower_http TraceMiddleware找不到这个
- Assistant
很抱歉,可能我的回答不够准确。在最新版本的
tower_http(0.17.1)中已经没有TraceMiddleware了。可以使用TraceLayer代替。下面是一个更新后的示例:
use axum::{ handler::get, http::StatusCode, response::{IntoResponse, Redirect}, Router, }; use std::sync::Arc; use tower_http::{ trace::{DefaultMakeSpan, TraceLayer}, TraceMiddleware, }; struct RequestIdGenerator; impl RequestIdGenerator { fn new() -> Self { Self } fn generate_id(&self) -> String { uuid::Uuid::new_v4().to_string() } } async fn handler(request_id: Arc<RequestIdGenerator>) -> impl IntoResponse { tracing::info!("request received with id: {}", request_id.generate_id()); Redirect::new("https://example.com".to_string()).into_response() } #[tokio::main] async fn main() { tracing_subscriber::fmt::init(); let app = Router::new().route("/", get(handler)); let request_id_generator = Arc::new(RequestIdGenerator::new()); let trace_layer = TraceLayer::<_, _, _, DefaultMakeSpan>::new().make_span_with(move |req| { tracing::info_span!( "span", method = %req.method(), path = %req.uri(), request_id = %request_id_generator.generate_id(), ) }); let handler = TraceMiddleware::new(trace_layer).app_data(request_id_generator).untagged(); let app = handler.combine(app); axum::Server::bind(&"0.0.0.0:3000".parse().unwrap()) .serve(app.into_make_service()) .await .unwrap(); }在这个示例中,
TraceMiddleware已更新为使用TraceLayer。make_span_with方法接受一个闭包,生成唯一的请求ID,合并了请求的方法、路径以及请求ID。在处理函数中,请求ID可以通过提取
Arc<RequestIdGenerator>来获取。希望这能帮到你!
- User
unresolved import
tower_http::TraceMiddleware - Assistant
继续抱歉给您带来困扰,
tower_http::TraceMiddleware已被移除,可以使用tower_http::trace::TraceMiddleware代替。下面是在 Axum + Tower 的异步 Web 应用中使用
TraceMiddleware的示例代码:use axum::{ Router, handler::get, http::StatusCode, response::{IntoResponse, Html}, }; use std::sync::Arc; use tower_http::{ trace::{DefaultMakeSpan, TraceLayer}, TraceMiddleware, }; struct RequestIdGenerator; impl RequestIdGenerator { fn new() -> Self { Self } fn generate_id(&self) -> String { uuid::Uuid::new_v4().to_string() } } async fn handler(request_id: Arc<RequestIdGenerator>) -> impl IntoResponse { tracing::info!("request received with id: {}", request_id.generate_id()); Html(format!( "<h1>Hello, world!</h1><p>Request ID: {}</p>", request_id.generate_id() )) .with_status(StatusCode::OK) .into_response() } #[tokio::main] async fn main() { tracing_subscriber::fmt::init(); let app = Router::new().route("/", get(handler)); let request_id_generator = Arc::new(RequestIdGenerator::new()); let trace_layer = TraceLayer::<_, _, _, DefaultMakeSpan>::new().make_span_with(move |req| { tracing::info_span!( "span", method = %req.method(), path = %req.uri(), request_id = %request_id_generator.generate_id(), ) }); let handler = TraceMiddleware::new(trace_layer).app_data(request_id_generator).untagged(); let app = handler.combine(app); axum::Server::bind(&"0.0.0.0:3000".parse().unwrap()) .serve(app.into_make_service()) .await .unwrap(); }和之前示例代码中的一样,我们通过
TraceLayer和TraceMiddleware将请求 ID 添加到日志中。在处理函数中,您可以通过提取
Arc<RequestIdGenerator>来获取请求 ID。此示例代码使用请求 ID 来呈现 HTML。如果
tower_http::trace::TraceMiddleware仍然无法解析,请尝试将tower-http版本更新为最新版本(例如0.17.1)。 - User
axum extensions 如何存储每个请求的 日志id
- Assistant
在 Axum 中,可以使用内置的
WithRequestPartsmiddleware 来将请求 ID 存储为请求扩展。下面是一个示例,展示如何使用
WithRequestParts来存储请求 ID:use axum::{ extract::{Extension, RequestParts}, handler::get, http::StatusCode, response::{IntoResponse, Html}, AddExtensionLayer, Router, }; use std::sync::Arc; use tower_http::trace::{DefaultMakeSpan, TraceLayer}; struct RequestIdGenerator; impl RequestIdGenerator { fn new() -> Self { Self } fn generate_id(&self) -> String { uuid::Uuid::new_v4().to_string() } } async fn handler(request_id: Extension<Arc<String>>) -> impl IntoResponse { Html(format!( "<h1>Hello, world!</h1><p>Request ID: {}</p>", request_id.as_ref() )) .with_status(StatusCode::OK) .into_response() } #[tokio::main] async fn main() { tracing_subscriber::fmt::init(); let app = Router::new().route("/", get(handler)); let request_id_generator = Arc::new(RequestIdGenerator::new()); let trace_layer = TraceLayer::<_, _, _, DefaultMakeSpan>::new().make_span_with(move |req| { tracing::info_span!( "span", method = %req.method(), path = %req.uri(), request_id = %request_id_generator.generate_id(), ) }); let middleware = RequestParts::<()>::default() .on_pre_routing(|mut request_parts| { let request_id = Arc::new( request_parts .extensions_mut() .insert(request_id_generator.generate_id()), ); request_parts.extensions_mut().insert(request_id); async move { request_parts } }) .on_response(|response, parts| async move { if let Some(request_id) = parts.extensions().get::<Arc<String>>() { tracing::info!( "response sent with id: {}", request_id.as_str() ); } response }); let app = middleware .layer(AddExtensionLayer::new(request_id_generator)) .layer(trace_layer) .clone() .boxed() .combine(app) .boxed(); axum::Server::bind(&"0.0.0.0:3000".parse().unwrap()) .serve(app.into_make_service()) .await .unwrap(); }在这个例子中,我们首先定义了一个
RequestIdGenerator结构体,用于生成唯一的请求 ID。在中间件中,我们将请求 ID 存储为 Arc 类型,并将其添加到请求的扩展中,以确保其在整个处理过程中一直存在。WithRequestParts中间件与AddExtensionLayer一起使用,为每个请求添加一个Arc<RequestIdGenerator>扩展。我们使用on_pre_routing回调和extensions_mut方法将请求 ID 添加到extensions中。在on_response回调中,我们从请求扩展中提取请求 ID,并将其添加到日志中。在处理函数中,请求 ID 可以通过提取
Extension<Arc<String>>来获取。希望这个例子能帮助您理解如何使用 Axum 在请求上下文中存储请求 ID。
- User
unresolved import
axum::extract::RequestParts - Assistant
很抱歉,似乎
axum::extract::RequestParts已经移除了。在 Axum 0.2.3 及更高版本中,可以使用tower::BoxError中的Extract扩展实现请求拦截。下面是一个更新的示例代码,使用
tower::BoxError和Extract来存储请求ID:use axum::{ extract::{Extension, FromRequest, RequestParts}, handler::get, http::StatusCode, response::{Html, IntoResponse}, AddExtensionLayer, Router, }; use std::sync::Arc; use tower_http::{trace::{DefaultMakeSpan, TraceLayer},TraceMiddleware}; use tower::extract::Extract; struct RequestIdGenerator; impl RequestIdGenerator { fn new() -> Self { Self } fn generate_id(&self) -> String { uuid::Uuid::new_v4().to_string() } } async fn handler(request_id: Extension<Arc<String>>) -> impl IntoResponse { Html(format!( "<h1>Hello, world!</h1><p>Request ID: {}</p>", request_id.as_ref() )) .with_status(StatusCode::OK) .into_response() } #[tokio::main] async fn main() { let app = Router::new().route("/", get(handler)); let request_id_generator = Arc::new(RequestIdGenerator::new()); let trace_layer = TraceLayer::<_, _, _, DefaultMakeSpan>::new().make_span_with(move |req| { tracing::info_span!( "span", method = %req.method(), path = %req.uri(), request_id = %request_id_generator.generate_id(), ) }); let middleware = TraceMiddleware::new(trace_layer).app_data(request_id_generator).untagged(); let app = middleware.combine(app) .layer(AddExtensionLayer::new(Arc::new(RequestIdGenerator::new()))); let app = Extract::<(Extension<Arc<RequestIdGenerator>>,), error::Error>::extract_from(&app).boxed(); axum::Server::bind(&"0.0.0.0:3000".parse().unwrap()) .serve(app.into_make_service()) .await .unwrap(); }在这个示例代码中,我们首先定义了一个
RequestIdGenerator结构体,用于生成唯一的请求 ID,然后将其存储为Arc<String>类型,并将其添加到请求的扩展中,以确保其在整个处理过程中一直存在。在中间件中,我们使用了
TraceMiddleware来为每个请求生成唯一的 Span,并将请求 ID 添加到extensions中,使用了app_data将请求 ID 存储在整个应用程序数据中,以确保其在应用程序范围内可访问。接下来,我们将
AddExtensionLayer添加为应用程序的层,Note:将 Arc 折成了 Arc<dyn Any + Send + Sync> 类型,然后使用Extract执行请求的拦截和提取。这里可以看到它使用了Extension<Arc<RequestIdGenerator>>。在处理函数中,和之前一样,请求 ID 可以通过提取
Extension<Arc<String>>来获得。希望这个例子能帮助您存储请求 ID!
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.