1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
//! Actix ActorFuture instrumentation for use with [`tracing`]
//!
//! # Example
//!
//! ```rust
//! use actix::prelude::*;
//! use actix::fut::{ready, ActorFuture};
//! use tracing::{span, event, Level};
//! use tracing_actix::ActorInstrument;
//! #
//! # // The response type returned by the actor future
//! # type OriginalActorResponse = ();
//! # // The error type returned by the actor future
//! # type MessageError = ();
//! # // This is the needed result for the DeferredWork message
//! # // It's a result that combine both Response and Error from the future response.
//! # type DeferredWorkResult = Result<OriginalActorResponse, MessageError>;
//! #
//! # struct ActorState {}
//! #
//! # impl ActorState {
//! # fn update_from(&mut self, _result: ()) {}
//! # }
//! #
//! # struct OtherActor {}
//! #
//! # impl Actor for OtherActor {
//! # type Context = Context<Self>;
//! # }
//! #
//! # impl Handler<OtherMessage> for OtherActor {
//! # type Result = ();
//! #
//! # fn handle(&mut self, _msg: OtherMessage, _ctx: &mut Context<Self>) -> Self::Result {
//! # }
//! # }
//! #
//! # struct OriginalActor{
//! # other_actor: Addr<OtherActor>,
//! # inner_state: ActorState
//! # }
//! #
//! # impl Actor for OriginalActor{
//! # type Context = Context<Self>;
//! # }
//! #
//! # #[derive(Message)]
//! # #[rtype(result = "Result<(), MessageError>")]
//! # struct DeferredWork{}
//! #
//! # #[derive(Message)]
//! # #[rtype(result = "()")]
//! # struct OtherMessage{}
//!
//! /// This example is modified from the actix::fut module and intended to show how
//! /// the `ActorInstrument` trait may be used to integrate tracing `Span`s within
//! /// asynchronous message handlers.
//! impl Handler<DeferredWork> for OriginalActor {
//! type Result = ResponseActFuture<Self, Result<OriginalActorResponse, MessageError>>;
//!
//! fn handle(
//! &mut self,
//! _msg: DeferredWork,
//! _ctx: &mut Context<Self>,
//! ) -> Self::Result {
//! // this creates a `Future` representing the `.send` and subsequent `Result` from
//! // `other_actor`
//! let span = span!(Level::INFO, "deferred work context");
//! // Addr<A>::send returns `actix::prelude::Request`, which implements Unpin, so we can wrap
//! // into_actor within an ActorInstrument.
//! Box::pin(
//! self.other_actor
//! .send(OtherMessage {})
//! .into_actor(self)
//! .actor_instrument(span)
//! .map(|result, actor, _ctx| {
//! // Actor's state updated here
//! match result {
//! Ok(v) => {
//! event!(Level::INFO, "I'm within deferred work context");
//! actor.inner_state.update_from(v);
//! Ok(())
//! }
//! // Failed to send message to other_actor
//! Err(e) => {
//! event!(Level::ERROR, "Error from deferred work: {:?}", e);
//! Err(())
//! }
//! }
//! }),
//! )
//! }
//! }
//! #
//! # #[derive(Message)]
//! # #[rtype(result = "Pong")]
//! # struct Ping;
//! #
//! # struct Pong;
//!
//! /// In this example, there isn't an `actix::prelude::Request` in our `ActorFuture`.
//! /// Since `ActorInstrument` needs to wrap `ActorFuture + Unpin`, we can't use
//! /// `async {}.into_actor(self)` because `async {}` doesn't implement `Unpin`.
//! impl Handler<Ping> for OriginalActor {
//! type Result = ResponseActFuture<Self, Pong>;
//!
//! fn handle(
//! &mut self,
//! _msg: Ping,
//! _ctx: &mut Context<Self>,
//! ) -> Self::Result {
//! // `async {}` doesn't implement Unpin, so it can't be used.
//! // `actix::fut::Ready` ActorFutures work fine though.
//! let span = span!(Level::INFO, "ping");
//! Box::pin(
//! ready::<Pong>(Pong {})
//! .actor_instrument(span)
//! .map(|pong, _this, _ctx| {
//! // the pong event occurs in the ping span, even though this is async.
//! event!(Level::INFO, "pong");
//! pong
//! }),
//! )
//! }
//! }
//! ```
use actix::{Actor, ActorFuture};
use pin_project_lite::pin_project;
use std::{
pin::Pin,
task::{Context, Poll},
};
use tracing::Span;
/// Extension trait allowing actor futures to be instrumented with
/// a `tracing` `Span`.
pub trait ActorInstrument: Sized {
/// Instruments this type with the provided `Span`, returning an
/// `ActorInstrumented` wrapper.
///
/// When the wrapped actor future is polled, the attached `Span`
/// will be entered for the duration of the poll.
fn actor_instrument(self, span: Span) -> ActorInstrumented<Self> {
ActorInstrumented { inner: self, span }
}
#[inline]
fn in_current_actor_span(self) -> ActorInstrumented<Self> {
self.actor_instrument(Span::current())
}
}
impl<T: Sized> ActorInstrument for T {}
pin_project! {
/// An actor future that has been instrumented with a `tracing` span.
#[derive(Debug, Clone)]
pub struct ActorInstrumented<T>
{
#[pin]
inner: T,
span: Span,
}
}
impl<T: ActorFuture<U>, U: Actor> ActorFuture<U> for ActorInstrumented<T> {
type Output = <T as ActorFuture<U>>::Output;
fn poll(
self: Pin<&mut Self>,
srv: &mut U,
ctx: &mut U::Context,
task: &mut Context<'_>,
) -> Poll<Self::Output> {
let this = self.project();
let _enter = this.span.enter();
this.inner.poll(srv, ctx, task)
}
}
impl<T> ActorInstrumented<T> {
/// Borrows the `Span` that this type is instrumented by.
pub fn span(&self) -> &Span {
&self.span
}
/// Mutably borrows the `Span` that this type is instrumented by.
pub fn span_mut(&mut self) -> &mut Span {
&mut self.span
}
/// Borrows the wrapped type.
pub fn inner(&self) -> &T {
&self.inner
}
/// Mutably borrows the wrapped type.
pub fn inner_mut(&mut self) -> &mut T {
&mut self.inner
}
/// Get a pinned reference to the wrapped type.
pub fn inner_pin_ref(self: Pin<&Self>) -> Pin<&T> {
self.project_ref().inner
}
/// Get a pinned mutable reference to the wrapped type.
pub fn inner_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T> {
self.project().inner
}
/// Consumes the `Instrumented`, returning the wrapped type.
///
/// Note that this drops the span.
pub fn into_inner(self) -> T {
self.inner
}
}