pub struct RulesQueryBuilder { /* private fields */ }
Expand description

Provides methods to build a query to the rules endpoint and send it to Prometheus.

Implementations§

source§

impl RulesQueryBuilder

Note that Prometheus combines all filters that have been set in the final request and only returns rules that match all filters.
See the official documentation for a thorough explanation on the filters that can be set: Prometheus API documentation.

source

pub fn kind(self, kind: RuleKind) -> Self

Set this to instruct Prometheus to only return a specific type of rule (either recording or alerting rules) instead of both. Calling this repeatedly will replace the current setting.

source

pub fn names<T>(self, names: T) -> Self
where T: IntoIterator, T::Item: Display,

Pass rule names to instruct Prometheus to only return those rules whose names match one of them. This method can be called repeatedly and merge the names with those that have been set before.

source

pub fn name(self, name: impl Display) -> Self

Pass a rule name to instruct Prometheus to return rules that match this name. This method can be called repeatedly to extend the set of rule names that will be sent to Prometheus.

source

pub fn groups<T>(self, groups: T) -> Self
where T: IntoIterator, T::Item: Display,

Pass group names to instruct Prometheus to only return those rules that are part of one of these groups. This method can be called repeatedly and merge the group names with those that have been set before.

source

pub fn group(self, group: impl Display) -> Self

Pass a group name to instruct Prometheus to return rules that are part of this group. This method can be called repeatedly to extend the set of group names that will be sent to Prometheus.

source

pub fn files<T>(self, files: T) -> Self
where T: IntoIterator, T::Item: Display,

Pass file names to instruct Prometheus to only return those rules that are defined in one of those files. This method can be called repeatedly and merge the file names with those that have been set before.

source

pub fn file(self, file: impl Display) -> Self

Pass a file name to instruct Prometheus to return rules that are defined in this file. This method can be called repeatedly to extend the set of file names that will be sent to Prometheus.

source

pub async fn get(self) -> Result<Vec<RuleGroup>, Error>

Execute the rules query (using HTTP GET) and return the RuleGroups sent by Prometheus.

source

pub async fn get_raw(self) -> Result<Response, Error>

Execute the rules query (using HTTP GET) and return the raw response sent by Prometheus.

Trait Implementations§

source§

impl Clone for RulesQueryBuilder

source§

fn clone(&self) -> RulesQueryBuilder

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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<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