Struct AlgoliaMonitoring

pub struct AlgoliaMonitoring { /* private fields */ }

Implementations

impl AlgoliaMonitoring

pub fn new(api_key: Option<String>, app_id: Option<String>) -> Self

pub async fn get_status( &self, servers: Option<Vec<String>>, ) -> Result<Status, Error>

Get the status of the Algolia servers servers is an optional list of servers to get the status of, if None, all servers are returned

pub async fn get_incidents( &self, servers: Option<Vec<String>>, ) -> Result<Incidents, Error>

Get the incidents of the Algolia servers servers is an optional list of servers to get the incidents of, if None, all servers are returned

pub async fn get_inventory(&self) -> Result<Inventory, Error>

Get the inventory of the Algolia servers

pub async fn get_latency(&self, servers: Vec<String>) -> Result<Metrics, Error>

Get the latency of the Algolia servers servers is a list of servers to get the latency of

pub async fn get_reachability( &self, servers: Vec<String>, ) -> Result<Metrics, Error>

This method gets the reachability for the servers passed in the URL servers is a list of servers to get the reachability of

pub async fn get_infrastructure_metrics( &self, metric: String, period: String, ) -> Result<Metrics, Error>

This method gets a metric over a period of time metric is the metric to get

• avg_build_time: Average build time of the indices in seconds
• ssd_usage: proportion of SSD vs RAM usage in % (0% means no SSD utilization, 32 GB storage used on 64 GB RAM system is 50%)
• ram_search_usage: RAM usage for the search in MB
• ram_indexing_usage: RAM usage for the indexing in MB
• cpu_usage: proportion of CPU idleness in % (0% means the CPU isn’t idle)
• *: All of the above period is the period of time to get the metric over
• minute: 1 minute ago, 1 point per 10 seconds (10 points)
• hour: 1 hour ago, 1 point per 1 minute (60 points)
• day: 1 day ago, 1 point per 10 minutes (144 points)
• week: 1 week ago, 1 point per 1 hour (168 points)
• month: 1 month ago, 1 point per 1 day (30 points)