Struct mz_ore::metrics::ExecTimeFuture

source ·
pub struct ExecTimeFuture<F, Metric> {
    fut: F,
    metric: Metric,
    running_duration: Duration,
    filter: Option<Box<dyn FnMut(Duration) -> bool + Send + Sync>>,
}
Available on crate feature metrics only.
Expand description

Future returned by MetricsFutureExt::exec_time.

Fields§

§fut: F

The inner Future that we’re recording the wall time for.

§metric: Metric

Prometheus metric that we’ll report to.

§running_duration: Duration

Total Duration for which this Future has been executing.

§filter: Option<Box<dyn FnMut(Duration) -> bool + Send + Sync>>

Optional filter that determines if we observe the execution time of this Future.

Implementations§

source§

impl<F, Metric> ExecTimeFuture<F, Metric>

source

pub(crate) fn project<'pin>( self: Pin<&'pin mut Self>, ) -> __ExecTimeFutureProjection<'pin, F, Metric>

source

pub(crate) fn project_ref<'pin>( self: Pin<&'pin Self>, ) -> __ExecTimeFutureProjectionRef<'pin, F, Metric>

source§

impl<F> ExecTimeFuture<F, UnspecifiedMetric>

source

pub fn observe(self, histogram: Histogram) -> ExecTimeFuture<F, Histogram>

Sets the recored metric to be a prometheus::Histogram.

my_future
    .exec_time()
    .observe(metrics.slow_queries_hist.with_label_values(&["select"]))
source

pub fn inc_by(self, counter: Counter) -> ExecTimeFuture<F, Counter>

Sets the recored metric to be a prometheus::Counter.

my_future
    .exec_time()
    .inc_by(metrics.slow_queries.with_label_values(&["select"]))
source§

impl<F, M> ExecTimeFuture<F, M>

source

pub fn with_filter( self, filter: impl FnMut(Duration) -> bool + Send + Sync + 'static, ) -> Self

Specifies a filter which much return true for the execution time to be recorded.

Trait Implementations§

source§

impl<F: Debug, M: Debug> Debug for ExecTimeFuture<F, M>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<F: Future, M: DurationMetric> Future for ExecTimeFuture<F, M>

§

type Output = <F as Future>::Output

The type of value produced on completion.
source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
source§

impl<'pin, F, Metric> Unpin for ExecTimeFuture<F, Metric>
where __ExecTimeFuture<'pin, F, Metric>: Unpin,

Auto Trait Implementations§

§

impl<F, Metric> Freeze for ExecTimeFuture<F, Metric>
where F: Freeze, Metric: Freeze,

§

impl<F, Metric> !RefUnwindSafe for ExecTimeFuture<F, Metric>

§

impl<F, Metric> Send for ExecTimeFuture<F, Metric>
where F: Send, Metric: Send,

§

impl<F, Metric> Sync for ExecTimeFuture<F, Metric>
where F: Sync, Metric: Sync,

§

impl<F, Metric> !UnwindSafe for ExecTimeFuture<F, Metric>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, U> CastInto<U> for T
where U: CastFrom<T>,

source§

fn cast_into(self) -> U

Performs the cast.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FutureExt for T
where T: Future + ?Sized,

source§

fn map<U, F>(self, f: F) -> Map<Self, F>
where F: FnOnce(Self::Output) -> U, Self: Sized,

Map this future’s output to a different type, returning a new future of the resulting type. Read more
source§

fn map_into<U>(self) -> MapInto<Self, U>
where Self::Output: Into<U>, Self: Sized,

Map this future’s output to a different type, returning a new future of the resulting type. Read more
source§

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>
where F: FnOnce(Self::Output) -> Fut, Fut: Future, Self: Sized,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more
source§

fn left_future<B>(self) -> Either<Self, B>
where B: Future<Output = Self::Output>, Self: Sized,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more
source§

fn right_future<A>(self) -> Either<A, Self>
where A: Future<Output = Self::Output>, Self: Sized,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more
source§

fn into_stream(self) -> IntoStream<Self>
where Self: Sized,

Convert this future into a single element stream. Read more
source§

fn flatten(self) -> Flatten<Self>
where Self::Output: Future, Self: Sized,

Flatten the execution of this future when the output of this future is itself another future. Read more
source§

fn flatten_stream(self) -> FlattenStream<Self>
where Self::Output: Stream, Self: Sized,

Flatten the execution of this future when the successful result of this future is a stream. Read more
source§

fn fuse(self) -> Fuse<Self>
where Self: Sized,

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more
source§

fn inspect<F>(self, f: F) -> Inspect<Self, F>
where F: FnOnce(&Self::Output), Self: Sized,

Do something with the output of a future before passing it on. Read more
source§

fn catch_unwind(self) -> CatchUnwind<Self>
where Self: Sized + UnwindSafe,

Catches unwinding panics while polling the future. Read more
source§

fn shared(self) -> Shared<Self>
where Self: Sized, Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more
source§

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
where Self: Sized,

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more
source§

fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a>>
where Self: Sized + Send + 'a,

Wrap the future in a Box, pinning it. Read more
source§

fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>>
where Self: Sized + 'a,

Wrap the future in a Box, pinning it. Read more
source§

fn unit_error(self) -> UnitError<Self>
where Self: Sized,

source§

fn never_error(self) -> NeverError<Self>
where Self: Sized,

source§

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>
where Self: Unpin,

A convenience for calling Future::poll on Unpin future types.
source§

fn now_or_never(self) -> Option<Self::Output>
where Self: Sized,

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more
source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<F> IntoFuture for F
where F: Future,

§

type Output = <F as Future>::Output

The output that the future will produce on completion.
§

type IntoFuture = F

Which kind of future are we turning this into?
source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<F> MetricsFutureExt<F> for F
where F: Future,

source§

fn wall_time(self) -> WallTimeFuture<F, UnspecifiedMetric>

Available on crate feature metrics only.
Records the number of seconds it takes a Future to complete according to “the clock on the wall”. Read more
source§

fn exec_time(self) -> ExecTimeFuture<F, UnspecifiedMetric>

Available on crate feature metrics only.
Records the total number of seconds for which a Future was executing. Read more
source§

impl<T> OreFutureExt for T
where T: Future,

source§

fn spawn_if_canceled<Name, NameClosure>( self, nc: NameClosure, ) -> SpawnIfCanceled<<T as Future>::Output, Name, NameClosure>
where Name: AsRef<str>, NameClosure: FnOnce() -> Name + Unpin, T: Send + 'static, <T as Future>::Output: Send + 'static,

Available on crate feature async only.
Wraps a future in a SpawnIfCanceled future, which will spawn a task to poll the inner future to completion if it is dropped.
source§

fn run_in_task<'async_trait, Name, NameClosure>( self, nc: NameClosure, ) -> Pin<Box<dyn Future<Output = <T as Future>::Output> + Send + 'async_trait>>
where Name: AsRef<str> + 'async_trait, NameClosure: FnOnce() -> Name + Unpin + Send + 'async_trait, T: Send + 'static + 'async_trait, <T as Future>::Output: Send + 'static,

Available on crate feature async only.
Run a 'static future in a Tokio task, naming that task, using a convenient postfix call notation. Read more
source§

fn run_in_task_if<'async_trait, Name, NameClosure>( self, in_task: InTask, nc: NameClosure, ) -> Pin<Box<dyn Future<Output = <T as Future>::Output> + Send + 'async_trait>>
where Name: AsRef<str> + 'async_trait, NameClosure: FnOnce() -> Name + Unpin + Send + 'async_trait, T: Future + Send + 'static + 'async_trait, <T as Future>::Output: Send + 'static,

Available on crate feature async only.
The same as run_in_task, but allows the callee to dynamically choose whether or not the future is polled into a Tokio task.
source§

fn ore_catch_unwind(self) -> OreCatchUnwind<T>
where T: UnwindSafe,

Available on crate feature async only.
Like FutureExt::catch_unwind, but can unwind panics even if panic::install_enhanced_handler has been called.
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<F> SentryFutureExt for F
where F: Future,

source§

fn bind_hub<H>(self, hub: H) -> SentryFuture<Self>
where H: Into<Arc<Hub>>,

Binds a hub to the execution of this future. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<F, T, E> TryFuture for F
where F: Future<Output = Result<T, E>> + ?Sized,

§

type Ok = T

The type of successful values yielded by this future
§

type Error = E

The type of failures yielded by this future
source§

fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>, ) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more
source§

impl<Fut> TryFutureExt for Fut
where Fut: TryFuture + ?Sized,

source§

fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok>
where Self::Ok: Sink<Item, Error = Self::Error>, Self: Sized,

Flattens the execution of this future when the successful result of this future is a Sink. Read more
source§

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>
where F: FnOnce(Self::Ok) -> T, Self: Sized,

Maps this future’s success value to a different value. Read more
source§

fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E>
where F: FnOnce(Self::Ok) -> T, E: FnOnce(Self::Error) -> T, Self: Sized,

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more
source§

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>
where F: FnOnce(Self::Error) -> E, Self: Sized,

Maps this future’s error value to a different value. Read more
source§

fn err_into<E>(self) -> ErrInto<Self, E>
where Self: Sized, Self::Error: Into<E>,

Maps this future’s Error to a new error type using the Into trait. Read more
source§

fn ok_into<U>(self) -> OkInto<Self, U>
where Self: Sized, Self::Ok: Into<U>,

Maps this future’s Ok to a new type using the Into trait.
source§

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>
where F: FnOnce(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>, Self: Sized,

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more
source§

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>
where F: FnOnce(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>, Self: Sized,

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more
source§

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>
where F: FnOnce(&Self::Ok), Self: Sized,

Do something with the success value of a future before passing it on. Read more
source§

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>
where F: FnOnce(&Self::Error), Self: Sized,

Do something with the error value of a future before passing it on. Read more
source§

fn try_flatten(self) -> TryFlatten<Self, Self::Ok>
where Self::Ok: TryFuture<Error = Self::Error>, Self: Sized,

Flatten the execution of this future when the successful result of this future is another future. Read more
source§

fn try_flatten_stream(self) -> TryFlattenStream<Self>
where Self::Ok: TryStream<Error = Self::Error>, Self: Sized,

Flatten the execution of this future when the successful result of this future is a stream. Read more
source§

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>
where Self: Sized, F: FnOnce(Self::Error) -> Self::Ok,

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more
source§

fn into_future(self) -> IntoFuture<Self>
where Self: Sized,

Wraps a TryFuture into a type that implements Future. Read more
source§

fn try_poll_unpin( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Self::Ok, Self::Error>>
where Self: Unpin,

A convenience method for calling TryFuture::try_poll on Unpin future types.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more