Struct coord::coord::prometheus::Scraper

pub struct Scraper {
    interval: Option<Duration>,
    retain_for: u64,
    registry: MetricsRegistry,
    metadata: HashMap<Row, u64>,
}

Scrapes the prometheus registry when asked and produces a batch of metric data that can be inserted into the built-in mz_metrics table.

Fields

interval: Option<Duration>

retain_for: u64

registry: MetricsRegistry

metadata: HashMap<Row, u64>

Implementations

impl Scraper

pub fn new(
    logging_config: Option<&LoggingConfig>,
    registry: MetricsRegistry
) -> Result<Scraper, Error>

Constructs a new metrics scraper for the specified registry.

The logging configuration specifies what metrics to scrape and how long to retain them for. If the logging configuration is none, scraping is disabled.

pub fn tick_stream(&self) -> Pin<Box<dyn Stream<Item = Message> + Send>>

Produces a stream that yields a Message::ScrapeMetrics at the desired scrape frequency.

If the scraper is disabled, this stream will yield no items.

pub fn scrape_once(&mut self) -> Vec<TimestampedUpdate>

Scrapes the metrics once, producing a batch of updates that should be inserted into the mz_metrics table.