Struct polkadot_node_subsystem::gen::tracing::span::EnteredSpan
source · pub struct EnteredSpan { /* private fields */ }
Expand description
An owned version of Entered
, a guard representing a span which has been
entered and is currently executing.
When the guard is dropped, the span will be exited.
This is returned by the Span::entered
function.
Implementations§
Methods from Deref<Target = Span>§
sourcepub fn enter(&self) -> Entered<'_>
pub fn enter(&self) -> Entered<'_>
Enters this span, returning a guard that will exit the span when dropped.
If this span is enabled by the current subscriber, then this function will
call Subscriber::enter
with the span’s Id
, and dropping the guard
will call Subscriber::exit
. If the span is disabled, this does
nothing.
In Asynchronous Code
Warning: in asynchronous code that uses async/await syntax,
Span::enter
should be used very carefully or avoided entirely. Holding
the drop guard returned by Span::enter
across .await
points will
result in incorrect traces. For example,
async fn my_async_function() {
let span = info_span!("my_async_function");
// WARNING: This span will remain entered until this
// guard is dropped...
let _enter = span.enter();
// ...but the `await` keyword may yield, causing the
// runtime to switch to another task, while remaining in
// this span!
some_other_async_function().await
// ...
}
The drop guard returned by Span::enter
exits the span when it is
dropped. When an async function or async block yields at an .await
point, the current scope is exited, but values in that scope are
not dropped (because the async block will eventually resume
execution from that await point). This means that another task will
begin executing while remaining in the entered span. This results in
an incorrect trace.
Instead of using Span::enter
in asynchronous code, prefer the
following:
-
To enter a span for a synchronous section of code within an async block or function, prefer
Span::in_scope
. Sincein_scope
takes a synchronous closure and exits the span when the closure returns, the span will always be exited before the next await point. For example:async fn my_async_function() { let span = info_span!("my_async_function"); let some_value = span.in_scope(|| { // run some synchronous code inside the span... }); // This is okay! The span has already been exited before we reach // the await point. some_other_async_function(some_value).await; // ... }
-
For instrumenting asynchronous code,
tracing
provides theFuture::instrument
combinator for attaching a span to a future (async function or block). This will enter the span every time the future is polled, and exit it whenever the future yields.Instrument
can be used with an async block inside an async function:ⓘuse tracing::Instrument; async fn my_async_function() { let span = info_span!("my_async_function"); async move { // This is correct! If we yield here, the span will be exited, // and re-entered when we resume. some_other_async_function().await; //more asynchronous code inside the span... } // instrument the async block with the span... .instrument(span) // ...and await it. .await }
It can also be used to instrument calls to async functions at the callsite:
ⓘuse tracing::Instrument; async fn my_async_function() { let some_value = some_other_async_function() .instrument(debug_span!("some_other_async_function")) .await; // ... }
-
The
#[instrument]
attribute macro can automatically generate correct code when used on an async function:ⓘ#[tracing::instrument(level = "info")] async fn my_async_function() { // This is correct! If we yield here, the span will be exited, // and re-entered when we resume. some_other_async_function().await; // ... }
Examples
let span = span!(Level::INFO, "my_span");
let guard = span.enter();
// code here is within the span
drop(guard);
// code here is no longer within the span
Guards need not be explicitly dropped:
fn my_function() -> String {
// enter a span for the duration of this function.
let span = trace_span!("my_function");
let _enter = span.enter();
// anything happening in functions we call is still inside the span...
my_other_function();
// returning from the function drops the guard, exiting the span.
return "Hello world".to_owned();
}
fn my_other_function() {
// ...
}
Sub-scopes may be created to limit the duration for which the span is entered:
let span = info_span!("my_great_span");
{
let _enter = span.enter();
// this event occurs inside the span.
info!("i'm in the span!");
// exiting the scope drops the guard, exiting the span.
}
// this event is not inside the span.
info!("i'm outside the span!")
sourcepub fn in_scope<F, T>(&self, f: F) -> Twhere
F: FnOnce() -> T,
pub fn in_scope<F, T>(&self, f: F) -> Twhere F: FnOnce() -> T,
Executes the given function in the context of this span.
If this span is enabled, then this function enters the span, invokes f
and then exits the span. If the span is disabled, f
will still be
invoked, but in the context of the currently-executing span (if there is
one).
Returns the result of evaluating f
.
Examples
let my_span = span!(Level::TRACE, "my_span");
my_span.in_scope(|| {
// this event occurs within the span.
trace!("i'm in the span!");
});
// this event occurs outside the span.
trace!("i'm not in the span!");
Calling a function and returning the result:
fn hello_world() -> String {
"Hello world!".to_owned()
}
let span = info_span!("hello_world");
// the span will be entered for the duration of the call to
// `hello_world`.
let a_string = span.in_scope(hello_world);
sourcepub fn field<Q>(&self, field: &Q) -> Option<Field>where
Q: AsField + ?Sized,
pub fn field<Q>(&self, field: &Q) -> Option<Field>where Q: AsField + ?Sized,
Returns a Field
for the field with the
given name
, if one exists,
sourcepub fn has_field<Q>(&self, field: &Q) -> boolwhere
Q: AsField + ?Sized,
pub fn has_field<Q>(&self, field: &Q) -> boolwhere Q: AsField + ?Sized,
Returns true if this Span
has a field for the given
Field
or field name.
sourcepub fn record<Q, V>(&self, field: &Q, value: V) -> &Spanwhere
Q: AsField + ?Sized,
V: Value,
pub fn record<Q, V>(&self, field: &Q, value: V) -> &Spanwhere Q: AsField + ?Sized, V: Value,
Records that the field described by field
has the value value
.
This may be used with field::Empty
to declare fields whose values
are not known when the span is created, and record them later:
use tracing::{trace_span, field};
// Create a span with two fields: `greeting`, with the value "hello world", and
// `parting`, without a value.
let span = trace_span!("my_span", greeting = "hello world", parting = field::Empty);
// ...
// Now, record a value for parting as well.
// (note that the field name is passed as a string slice)
span.record("parting", "goodbye world!");
However, it may also be used to record a new value for a field whose value was already recorded:
use tracing::info_span;
// Initially, let's assume that our attempt to do something is going okay...
let span = info_span!("doing_something", is_okay = true);
let _e = span.enter();
match do_something() {
Ok(something) => {
// ...
}
Err(_) => {
// Things are no longer okay!
span.record("is_okay", false);
}
}
Note: The fields associated with a span are part of itsMetadata
. TheMetadata
describing a particular span is constructed statically when the span is created and cannot be extended later to add new fields. Therefore, you cannot record a value for a field that was not specified when the span was created:
use tracing::{trace_span, field};
// Create a span with two fields: `greeting`, with the value "hello world", and
// `parting`, without a value.
let span = trace_span!("my_span", greeting = "hello world", parting = field::Empty);
// ...
// Now, you try to record a value for a new field, `new_field`, which was not
// declared as `Empty` or populated when you created `span`.
// You won't get any error, but the assignment will have no effect!
span.record("new_field", "interesting_value_you_really_need");
// Instead, all fields that may be recorded after span creation should be declared up front,
// using field::Empty when a value is not known, as we did for `parting`.
// This `record` call will indeed replace field::Empty with "you will be remembered".
span.record("parting", "you will be remembered");
sourcepub fn record_all(&self, values: &ValueSet<'_>) -> &Span
pub fn record_all(&self, values: &ValueSet<'_>) -> &Span
Records all the fields in the provided ValueSet
.
sourcepub fn is_disabled(&self) -> bool
pub fn is_disabled(&self) -> bool
Returns true
if this span was disabled by the subscriber and does not
exist.
See also is_none
.
sourcepub fn is_none(&self) -> bool
pub fn is_none(&self) -> bool
Returns true
if this span was constructed by Span::none
and is
empty.
If is_none
returns true
for a given span, then is_disabled
will
also return true
. However, when a span is disabled by the subscriber
rather than constructed by Span::none
, this method will return
false
, while is_disabled
will return true
.
sourcepub fn follows_from(&self, from: impl Into<Option<Id>>) -> &Span
pub fn follows_from(&self, from: impl Into<Option<Id>>) -> &Span
Indicates that the span with the given ID has an indirect causal relationship with this span.
This relationship differs somewhat from the parent-child relationship: a span may have any number of prior spans, rather than a single one; and spans are not considered to be executing inside of the spans they follow from. This means that a span may close even if subsequent spans that follow from it are still open, and time spent inside of a subsequent span should not be included in the time its precedents were executing. This is used to model causal relationships such as when a single future spawns several related background tasks, et cetera.
If this span is disabled, or the resulting follows-from relationship would be invalid, this function will do nothing.
Examples
Setting a follows_from
relationship with a Span
:
let span1 = span!(Level::INFO, "span_1");
let span2 = span!(Level::DEBUG, "span_2");
span2.follows_from(span1);
Setting a follows_from
relationship with the current span:
let span = span!(Level::INFO, "hello!");
span.follows_from(Span::current());
Setting a follows_from
relationship with a Span
reference:
let span = span!(Level::INFO, "hello!");
let curr = Span::current();
span.follows_from(&curr);
Setting a follows_from
relationship with an Id
:
let span = span!(Level::INFO, "hello!");
let id = span.id();
span.follows_from(id);
sourcepub fn metadata(&self) -> Option<&'static Metadata<'static>>
pub fn metadata(&self) -> Option<&'static Metadata<'static>>
Returns this span’s Metadata
, if it is enabled.
sourcepub fn with_subscriber<T>(
&self,
f: impl FnOnce((&Id, &Dispatch)) -> T
) -> Option<T>
pub fn with_subscriber<T>( &self, f: impl FnOnce((&Id, &Dispatch)) -> T ) -> Option<T>
Invokes a function with a reference to this span’s ID and subscriber.
if this span is enabled, the provided function is called, and the result is returned.
If the span is disabled, the function is not called, and this method returns None
instead.
Trait Implementations§
source§impl Debug for EnteredSpan
impl Debug for EnteredSpan
source§impl Deref for EnteredSpan
impl Deref for EnteredSpan
source§impl Drop for EnteredSpan
impl Drop for EnteredSpan
Auto Trait Implementations§
impl !RefUnwindSafe for EnteredSpan
impl !Send for EnteredSpan
impl Sync for EnteredSpan
impl Unpin for EnteredSpan
impl !UnwindSafe for EnteredSpan
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,
source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,
T
. Read moresource§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.source§impl<T, S> UniqueSaturatedInto<T> for Swhere
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,
source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.