Struct prometheus_http_query::Selector

pub struct Selector<'a> { /* private fields */ }

A time series selector that is gradually built from a metric name and/or a set of label matchers.

For final validation and further processing the selector is then converted to either a crate::InstantVector or crate::RangeVector.

Implementations

impl<'a> Selector<'a>

pub fn new() -> Self

Simply return an empty Selector to build on. A selector “must either specify a metric name or at least one label matcher that does not match the empty string” as per the Prometheus documentation.

use prometheus_http_query::Selector;
use prometheus_http_query::InstantVector;
use prometheus_http_query::Error;
use std::convert::TryInto;

let v: Result<InstantVector, Error> = Selector::new().try_into();

assert!(v.is_err());

pub fn metric(self, metric: &'a str) -> Self where
    Self: Sized, 

Select a metric name for this Selector.

use prometheus_http_query::Selector;

let s = Selector::new().metric("http_requests_total");

pub fn with(self, label: &'a str, value: &'a str) -> Self where
    Self: Sized, 

Append a label matcher to the set of matchers of Selector that selects labels that match the provided string.
PromQL equivalent: http_requests_total{job="apiserver"}

use prometheus_http_query::Selector;
use prometheus_http_query::InstantVector;
use prometheus_http_query::Error;
use std::convert::TryInto;

let v: Result<InstantVector, Error> = Selector::new()
    .metric("http_requests_total")
    .with("job", "apiserver")
    .try_into();

assert!(v.is_ok());

pub fn without(self, label: &'a str, value: &'a str) -> Self where
    Self: Sized, 

Append a label matcher to the set of matchers of Selector that selects labels that do not match the provided string.
PromQL equivalent: http_requests_total{job!="apiserver"}

use prometheus_http_query::Selector;
use prometheus_http_query::InstantVector;
use prometheus_http_query::Error;
use std::convert::TryInto;

let v: Result<InstantVector, Error> = Selector::new()
    .metric("http_requests_total")
    .without("job", "apiserver")
    .try_into();

assert!(v.is_ok());

pub fn regex_match(self, label: &'a str, value: &'a str) -> Self where
    Self: Sized, 

Append a label matcher to the set of matchers of Selector that selects labels that regex-match the provided string. PromQL equivalent: http_requests_total{job=~"apiserver"}

use prometheus_http_query::Selector;
use prometheus_http_query::InstantVector;
use prometheus_http_query::Error;
use std::convert::TryInto;

let v: Result<InstantVector, Error> = Selector::new()
    .metric("http_requests_total")
    .regex_match("job", "apiserver")
    .try_into();

assert!(v.is_ok());

pub fn no_regex_match(self, label: &'a str, value: &'a str) -> Self where
    Self: Sized, 

Append a label matcher to the set of matchers of Selector that selects labels that do not regex-match the provided string.
PromQL equivalent: http_requests_total{job!~"apiserver"}

use prometheus_http_query::Selector;
use prometheus_http_query::InstantVector;
use prometheus_http_query::Error;
use std::convert::TryInto;

let v: Result<InstantVector, Error> = Selector::new()
    .metric("http_requests_total")
    .no_regex_match("job", "apiserver")
    .try_into();

assert!(v.is_ok());

pub fn range(self, duration: &'a str) -> Result<Self, Error>

Add a time range to this Selector (effectively priming this Selector to be converted to a crate::RangeVector).
See the Prometheus reference for the correct time duration syntax.

use prometheus_http_query::Selector;

let s = Selector::new().metric("some_metric").range("1m30s");

assert!(s.is_ok());

Providing invalid time durations will lead to an error.

use prometheus_http_query::Selector;

let s = Selector::new().metric("some_metric").range("30s1m");

assert!(s.is_err());

pub fn offset(self, duration: &'a str) -> Result<Self, Error>

Add a time offset to this Selector.
See the Prometheus reference regarding time durations and offsets for the correct time duration syntax.

use prometheus_http_query::Selector;

let s = Selector::new().metric("some_metric").offset("1m30s");
assert!(s.is_ok());

// Negative offsets are allowed.
let s = Selector::new().metric("some_metric").offset("-1h30m");
assert!(s.is_ok());

// Providing invalid time durations will lead to an error.
let s = Selector::new().metric("some_metric").offset("30s1m");
assert!(s.is_err());

pub fn at(self, time: i64) -> Self

Add a @ modifier to this Selector.
See the Prometheus reference regarding time durations and @ modifiers for details.

use prometheus_http_query::{Selector, InstantVector};
use std::convert::TryInto;

let s: Result<InstantVector, _> = Selector::new().metric("some_metric").at(1623855855).try_into();

assert!(s.is_ok());

Trait Implementations

impl<'a> Clone for Selector<'a>

fn clone(&self) -> Selector<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Selector<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Selector<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for Selector<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Selector<'a>> for Selector<'a>

fn eq(&self, other: &Selector<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Selector<'a>) -> bool

This method tests for !=.

impl TryFrom<Selector<'_>> for InstantVector

fn try_from(selector: Selector<'_>) -> Result<Self, Self::Error>

Convert a Selector to an InstantVector.

use prometheus_http_query::{Selector, InstantVector, Error};
use std::convert::TryInto;

fn main() -> Result<(), Error> {
    let v: Result<InstantVector, Error> = Selector::new()
        .metric("some_metric")
        .try_into();

    assert!(v.is_ok());

    Ok(())
}

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Selector<'_>> for RangeVector

fn try_from(selector: Selector<'_>) -> Result<RangeVector, Self::Error>

Convert a Selector to a RangeVector.

use prometheus_http_query::{Selector, RangeVector, Error};
use std::convert::TryInto;

fn main() -> Result<(), Error> {
    let v: Result<RangeVector, Error> = Selector::new()
        .metric("some_metric")
        .range("1m30s")?
        .try_into();

    assert!(v.is_ok());

    Ok(())
}

type Error = Error

The type returned in the event of a conversion error.

impl<'a> StructuralPartialEq for Selector<'a>