Struct prometheus_http_query::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

A client used to execute queries. It uses a reqwest::Client internally that manages connections for us.

Implementations

source

impl Client

source

pub fn inner(&self) -> &Client

Return a reference to the wrapped reqwest::Client, i.e. to use it for other requests unrelated to the Prometheus API.

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    // An amittedly bad example, but that is not the point.
    let response = client
        .inner()
        .head("http://127.0.0.1:9090")
        .send()
        .await
        .map_err(Error::Client)?;

    // Prometheus does not allow HEAD requests.
    assert_eq!(response.status(), reqwest::StatusCode::METHOD_NOT_ALLOWED);
    Ok(())
}

source

pub fn base_url(&self) -> &str

Return a reference to the base URL that is used in requests to the Prometheus API.

use prometheus_http_query::Client;
use std::str::FromStr;

let client = Client::default();

assert_eq!(client.base_url(), "http://127.0.0.1:9090/api/v1");

let client = Client::from_str("https://proxy.example.com:8443/prometheus").unwrap();

assert_eq!(client.base_url(), "https://proxy.example.com:8443/prometheus/api/v1");

source

pub fn from(client: Client, url: &str) -> Result<Self, Error>

Create a Client from a custom reqwest::Client and URL. This way you can account for all extra parameters (e.g. x509 authentication) that may be needed to connect to Prometheus or an intermediate proxy, by building it into the reqwest::Client.

use prometheus_http_query::{Client, Error};

fn main() -> Result<(), Error> {
    let client = {
        let c = reqwest::Client::builder()
            .no_proxy()
            .build()
            .map_err(Error::Client)?;
        Client::from(c, "https://prometheus.example.com")
    };

    assert!(client.is_ok());
    Ok(())
}

source

pub async fn query(
 &self,
 query: impl ToString,
 time: Option<i64>,
 timeout: Option<i64>
) -> Result<PromqlResult, Error>

Execute an instant query.

Arguments

query - PromQL query to exeute
time - Evaluation timestamp as Unix timestamp (seconds). Optional, defaults to Prometheus server time.
timeout - Evaluation timeout in milliseconds. Optional.

See also: Prometheus API documentation

use prometheus_http_query::{Error, Client};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let q = "prometheus_http_requests_total";

    let response = client.query(q, Some(1648379069), Some(1000)).await?;

    assert!(response.as_instant().is_some());

    Ok(())
}

source

pub async fn query_range(
 &self,
 query: impl ToString,
 start: i64,
 end: i64,
 step: f64,
 timeout: Option<i64>
) -> Result<PromqlResult, Error>

Execute a range query.

Arguments

query - PromQL query to exeute
start - Start timestamp as Unix timestamp (seconds)
end - End timestamp as Unix timestamp (seconds)
step - Query resolution step width as float number of seconds
timeout - Evaluation timeout in milliseconds. Optional.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let q = "prometheus_http_requests_total";

    let response = client.query_range(q, 1648373100, 1648373300, 10.0, None).await?;

    assert!(response.as_range().is_some());

    Ok(())
}

source

pub async fn series(
 &self,
 selectors: &[Selector<'_>],
 start: Option<i64>,
 end: Option<i64>
) -> Result<Vec<HashMap<String, String>>, Error>

Find time series that match certain label sets (Selectors).

Arguments

selectors - List of Selectors that select the series to return. Must not be empty.
start - Start timestamp as Unix timestamp (seconds). Optional.
end - End timestamp as Unix timestamp (seconds). Optional.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Selector, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let s1 = Selector::new()
        .eq("handler", "/api/v1/query");

    let s2 = Selector::new()
        .eq("job", "node")
        .regex_eq("mode", ".+");

    let response = client.series(&[s1, s2], None, None).await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn label_names(
 &self,
 selectors: Option<Vec<Selector<'_>>>,
 start: Option<i64>,
 end: Option<i64>
) -> Result<Vec<String>, Error>

Retrieve label names.

Arguments

selectors - List of Selectors to restrict the set of time series to read the label names from. Optional.
start - Start timestamp as Unix timestamp (seconds). Optional.
end - End timestamp as Unix timestamp (seconds). Optional.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Selector, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    // To retrieve a list of all labels:
    let response = client.label_names(None, None, None).await;

    assert!(response.is_ok());

    // Use a selector to retrieve a list of labels that appear in specific time series:
    let s1 = Selector::new()
        .eq("handler", "/api/v1/query");

    let s2 = Selector::new()
        .eq("job", "node")
        .regex_eq("mode", ".+");

    let set = Some(vec![s1, s2]);

    let response = client.label_names(set, None, None).await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn label_values(
 &self,
 label: &str,
 selectors: Option<Vec<Selector<'_>>>,
 start: Option<i64>,
 end: Option<i64>
) -> Result<Vec<String>, Error>

Retrieve all label values for a specific label name.

Arguments

label - Name of the label to return all occuring label values for.
selectors - List of Selectors to restrict the set of time series to read the label values from. Optional.
start - Start timestamp as Unix timestamp (seconds). Optional.
end - End timestamp as Unix timestamp (seconds). Optional.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Selector, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    // To retrieve a list of all label values for a specific label name:
    let response = client.label_values("job", None, None, None).await;

    assert!(response.is_ok());

    // To retrieve a list of label values of labels that appear in specific time series:
    let s1 = Selector::new()
        .regex_eq("instance", ".+");

    let set = Some(vec![s1]);

    let response = client.label_values("job", set, None, None).await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn targets(&self, state: Option<TargetState>) -> Result<Targets, Error>

Query the current state of target discovery.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error, TargetState};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.targets(None).await;

    assert!(response.is_ok());

    // Filter targets by type:
    let response = client.targets(Some(TargetState::Active)).await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn rules(
&self,
rule_type: Option<RuleType>
) -> Result<Vec<RuleGroup>, Error>

Retrieve a list of rule groups of recording and alerting rules.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error, RuleType};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.rules(None).await;

    assert!(response.is_ok());

    // Filter rules by type:
    let response = client.rules(Some(RuleType::Alert)).await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn alerts(&self) -> Result<Vec<Alert>, Error>

Retrieve a list of active alerts.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.alerts().await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn flags(&self) -> Result<HashMap<String, String>, Error>

Retrieve a list of flags that Prometheus was configured with.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.flags().await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn build_information(&self) -> Result<BuildInformation, Error>

Retrieve Prometheus server build information.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.build_information().await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn runtime_information(&self) -> Result<RuntimeInformation, Error>

Retrieve Prometheus server runtime information.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.runtime_information().await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn tsdb_statistics(&self) -> Result<TsdbStatistics, Error>

Retrieve Prometheus TSDB statistics.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.tsdb_statistics().await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn wal_replay_statistics(&self) -> Result<WalReplayStatistics, Error>

Retrieve WAL replay statistics.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.wal_replay_statistics().await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn alertmanagers(&self) -> Result<Alertmanagers, Error>

Query the current state of alertmanager discovery.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    let response = client.alertmanagers().await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn target_metadata(
 &self,
 metric: Option<&str>,
 match_target: Option<&Selector<'_>>,
 limit: Option<usize>
) -> Result<Vec<TargetMetadata>, Error>

Retrieve metadata about metrics that are currently scraped from targets, along with target information.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error, Selector};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    // Retrieve metadata for a specific metric from all targets.
    let response = client.target_metadata(Some("go_routines"), None, None).await;

    assert!(response.is_ok());

    // Retrieve metric metadata from specific targets.
    let s = Selector::new().eq("job", "prometheus");

    let response = client.target_metadata(None, Some(&s), None).await;

    assert!(response.is_ok());

    // Retrieve metadata for a specific metric from targets that match a specific label set.
    let s = Selector::new().eq("job", "node");

    let response = client.target_metadata(Some("node_cpu_seconds_total"), Some(&s), None).await;

    assert!(response.is_ok());

    Ok(())
}

source

pub async fn metric_metadata(
 &self,
 metric: Option<&str>,
 limit: Option<usize>
) -> Result<HashMap<String, Vec<MetricMetadata>>, Error>

Retrieve metadata about metrics that are currently scraped from targets.

See also: Prometheus API documentation

use prometheus_http_query::{Client, Error};

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let client = Client::default();

    // Retrieve metadata for a all metrics.
    let response = client.metric_metadata(None, None).await;

    assert!(response.is_ok());

    // Limit the number of returned metrics
    let response = client.metric_metadata(None, Some(10)).await;

    assert!(response.is_ok());

    // Retrieve metadata of a specific metric.
    let response = client.metric_metadata(Some("go_routines"), None).await;

    assert!(response.is_ok());

    Ok(())
}

Trait Implementations

source

impl Clone for Client

source

fn clone(&self) -> Client

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

source

impl Default for Client

source

fn default() -> Self

Create a standard Client that sends requests to “http://127.0.0.1:9090/api/v1”.

use prometheus_http_query::Client;

let client = Client::default();

source

impl FromStr for Client

source

fn from_str(url: &str) -> Result<Self, Self::Err>

Create a Client from a custom base URL. Note that the API-specific path segments (like /api/v1/query) are added automatically.

use prometheus_http_query::Client;
use std::str::FromStr;

let client = Client::from_str("http://proxy.example.com/prometheus");
assert!(client.is_ok());

type Err = Error

The associated error which can be returned from parsing.

source

impl TryFrom<&str> for Client

source

fn try_from(url: &str) -> Result<Self, Self::Error>

Create a Client from a custom base URL. Note that the API-specific path segments (like /api/v1/query) are added automatically.

use prometheus_http_query::Client;
use std::convert::TryFrom;

let client = Client::try_from("http://proxy.example.com/prometheus");
assert!(client.is_ok());

type Error = Error

The type returned in the event of a conversion error.

source

impl TryFrom<String> for Client

source

fn try_from(url: String) -> Result<Self, Self::Error>

Create a Client from a custom base URL. Note that the API-specific path segments (like /api/v1/query) are added automatically.

use prometheus_http_query::Client;
use std::convert::TryFrom;

let url = String::from("http://proxy.example.com/prometheus");
let client = Client::try_from(url);
assert!(client.is_ok());

type Error = Error

The type returned in the event of a conversion error.

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Struct prometheus_http_query::Client

Implementations

impl Client

pub fn inner(&self) -> &Client

pub fn base_url(&self) -> &str

pub fn from(client: Client, url: &str) -> Result<Self, Error>

pub async fn query( &self, query: impl ToString, time: Option<i64>, timeout: Option<i64>) -> Result<PromqlResult, Error>

pub async fn query_range( &self, query: impl ToString, start: i64, end: i64, step: f64, timeout: Option<i64>) -> Result<PromqlResult, Error>

pub async fn series( &self, selectors: &[Selector<'_>], start: Option<i64>, end: Option<i64>) -> Result<Vec<HashMap<String, String>>, Error>

pub async fn label_names( &self, selectors: Option<Vec<Selector<'_>>>, start: Option<i64>, end: Option<i64>) -> Result<Vec<String>, Error>

pub async fn label_values( &self, label: &str, selectors: Option<Vec<Selector<'_>>>, start: Option<i64>, end: Option<i64>) -> Result<Vec<String>, Error>

pub async fn targets(&self, state: Option<TargetState>) -> Result<Targets, Error>

pub async fn rules( &self, rule_type: Option<RuleType>) -> Result<Vec<RuleGroup>, Error>

pub async fn alerts(&self) -> Result<Vec<Alert>, Error>

pub async fn flags(&self) -> Result<HashMap<String, String>, Error>

pub async fn build_information(&self) -> Result<BuildInformation, Error>

pub async fn runtime_information(&self) -> Result<RuntimeInformation, Error>

pub async fn tsdb_statistics(&self) -> Result<TsdbStatistics, Error>

pub async fn wal_replay_statistics(&self) -> Result<WalReplayStatistics, Error>

pub async fn alertmanagers(&self) -> Result<Alertmanagers, Error>

pub async fn target_metadata( &self, metric: Option<&str>, match_target: Option<&Selector<'_>>, limit: Option<usize>) -> Result<Vec<TargetMetadata>, Error>

pub async fn metric_metadata( &self, metric: Option<&str>, limit: Option<usize>) -> Result<HashMap<String, Vec<MetricMetadata>>, Error>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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

impl Default for Client

fn default() -> Self

impl FromStr for Client

fn from_str(url: &str) -> Result<Self, Self::Err>

type Err = Error

impl TryFrom<&str> for Client

fn try_from(url: &str) -> Result<Self, Self::Error>

type Error = Error

impl TryFrom<String> for Client

fn try_from(url: String) -> Result<Self, Self::Error>

type Error = Error

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn query(
&self,
query: impl ToString,
time: Option<i64>,
timeout: Option<i64>
) -> Result<PromqlResult, Error>

pub async fn query_range(
&self,
query: impl ToString,
start: i64,
end: i64,
step: f64,
timeout: Option<i64>
) -> Result<PromqlResult, Error>

pub async fn series(
&self,
selectors: &[Selector<'_>],
start: Option<i64>,
end: Option<i64>
) -> Result<Vec<HashMap<String, String>>, Error>

pub async fn label_names(
&self,
selectors: Option<Vec<Selector<'_>>>,
start: Option<i64>,
end: Option<i64>
) -> Result<Vec<String>, Error>

pub async fn label_values(
&self,
label: &str,
selectors: Option<Vec<Selector<'_>>>,
start: Option<i64>,
end: Option<i64>
) -> Result<Vec<String>, Error>

pub async fn rules(
&self,
rule_type: Option<RuleType>
) -> Result<Vec<RuleGroup>, Error>

pub async fn target_metadata(
&self,
metric: Option<&str>,
match_target: Option<&Selector<'_>>,
limit: Option<usize>
) -> Result<Vec<TargetMetadata>, Error>

pub async fn metric_metadata(
&self,
metric: Option<&str>,
limit: Option<usize>
) -> Result<HashMap<String, Vec<MetricMetadata>>, Error>

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

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