Struct mz_repr::explain_new::PlanTrace
source · pub struct PlanTrace<T> {
find: Option<&'static str>,
path: Mutex<String>,
times: Mutex<Vec<Instant>>,
entries: Mutex<Vec<TraceEntry<T>>>,
}
Expand description
A tracing layer used to accumulate a sequence of explainable plans.
Fields§
§find: Option<&'static str>
A specific concrete path to find in this trace. If present,
PlanTrace::push
will only collect traces if the current path is a
prefix of find.
path: Mutex<String>
A path of segments identifying the spans in the current ancestor-or-self
chain. The current path is used when accumulating new entries
.
times: Mutex<Vec<Instant>>
A path of times at which the spans in the current ancestor-or-self chain
were started. The duration since the last time is used when accumulating
new entries
.
entries: Mutex<Vec<TraceEntry<T>>>
A sequence of entries associating for a specific plan type T
.
Implementations§
source§impl<T: Clone + 'static> PlanTrace<T>
impl<T: Clone + 'static> PlanTrace<T>
sourcepub fn find(path: &'static str) -> Self
pub fn find(path: &'static str) -> Self
Create a new trace for plans of type T
that will only accumulate
TraceEntry
instances along the prefix of the given path
.
sourcepub fn drain_as_vec(&self) -> Vec<TraceEntry<T>> ⓘwhere
T: Debug,
pub fn drain_as_vec(&self) -> Vec<TraceEntry<T>> ⓘwhere
T: Debug,
Drain the trace data collected so far.
Note that this method will mutate the internal state of the enclosing
PlanTrace
even though its receiver is not &mut self
. This quirk is
required because the tracing Dispatch
does not have downcast_mut
method.
sourcefn push(&self, plan: &T)
fn push(&self, plan: &T)
Push a trace entry for the given plan
to the current trace.
This is a noop if (1) the call is within a context without an enclosing
span, or if (2) PlanTrace::find
is set and the current path is not a
prefix of its value.
sourcefn current_path(&self) -> Option<String>
fn current_path(&self) -> Option<String>
Helper method: get a copy of the current path.
If PlanTrace::find
is set, this will also check the current path
against the find
entry and return None
if the former is not a prefix
of the latter.
Trait Implementations§
source§impl<S, T> Layer<S> for PlanTrace<T>where
S: Subscriber + for<'span> LookupSpan<'span>,
T: 'static,
impl<S, T> Layer<S> for PlanTrace<T>where
S: Subscriber + for<'span> LookupSpan<'span>,
T: 'static,
A layer::Layer
implementation for PlanTrace
.
Populates the data
wrapped by the PlanTrace
instance with
TraceEntry
values, one for each span with attached plan in its
extensions map.
source§fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)
fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)
Attributes
and Id
.source§fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)
fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)
source§fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)
fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)
source§fn on_register_dispatch(&self, collector: &Dispatch)
fn on_register_dispatch(&self, collector: &Dispatch)
Subscriber
. Read moresource§fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest
fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest
Subscriber::register_callsite
. Read moresource§fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool
fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool
true
if this layer is interested in a span or event with the
given metadata
in the current Context
, similarly to
Subscriber::enabled
. Read moresource§fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)
fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)
Id
recorded the given
values
.source§fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)
fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)
span
recorded that it
follows from the span with the ID follows
.source§fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool
fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool
on_event
, to determine if on_event
should be called.source§fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)
fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)
source§fn on_close(&self, _id: Id, _ctx: Context<'_, S>)
fn on_close(&self, _id: Id, _ctx: Context<'_, S>)
source§fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)
fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)
source§fn and_then<L>(self, layer: L) -> Layered<L, Self, S>where
L: Layer<S>,
Self: Sized,
fn and_then<L>(self, layer: L) -> Layered<L, Self, S>where
L: Layer<S>,
Self: Sized,
Layer
, returning a Layered
struct implementing Layer
. Read moresource§fn with_subscriber(self, inner: S) -> Layered<Self, S, S>where
Self: Sized,
fn with_subscriber(self, inner: S) -> Layered<Self, S, S>where
Self: Sized,
Layer
with the given Subscriber
, returning a
Layered
struct that implements Subscriber
. Read moreAuto Trait Implementations§
impl<T> RefUnwindSafe for PlanTrace<T>
impl<T> Send for PlanTrace<T>where
T: Send,
impl<T> Sync for PlanTrace<T>where
T: Send,
impl<T> Unpin for PlanTrace<T>where
T: Unpin,
impl<T> UnwindSafe for PlanTrace<T>
Blanket Implementations§
source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
RustType::from_proto
.source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
RustType::into_proto
.