Struct Client

pub struct Client { /* private fields */ }

The core of the kairosdb client, owns a HTTP connection.

Implementations

impl Client

pub fn new(host: &str, port: u32) -> Client

Constructs a new KairosDB Client

Example

use kairosdb::Client;
let client = Client::new("localhost", 8080);

pub fn version(&self) -> Result<String, KairoError>

Returns the version string of the KairosDB Server

Example

use kairosdb::Client;
let client = Client::new("localhost", 8080);
assert!(client.version().unwrap().starts_with("KairosDB"));

pub fn health(&self) -> Result<Vec<String>, KairoError>

Returns the health status of the KairosDB Server

Example

use kairosdb::Client;
let client = Client::new("localhost", 8080);
let response = client.health();

pub fn add(&self, datapoints: &Datapoints) -> Result<(), KairoError>

Method to add datapoints to the time series database

Example

use kairosdb::Client;
use kairosdb::datapoints::Datapoints;

let client = Client::new("localhost", 8080);
let mut datapoints = Datapoints::new("first", 0);
datapoints.add_ms(1475513259000, 11.0);
datapoints.add_ms(1475513259001, 12.0);
datapoints.add_tag("test", "first");
let result = client.add(&datapoints);
assert!(result.is_ok())

pub fn query(&self, query: &Query) -> Result<ResultMap, KairoError>

Runs a query on the database.

Example

use kairosdb::Client;
use kairosdb::query::{Query, Time, TimeUnit};

let client = Client::new("localhost", 8080);
let query = Query::new(
   Time::Nanoseconds(1),
   Time::Relative{value: 1, unit: TimeUnit::WEEKS});
let result = client.query(&query);
assert!(result.is_ok())

pub fn delete(&self, query: &Query) -> Result<(), KairoError>

Runs a delete query on the database. View the query structure to understand more about.

Example

use kairosdb::Client;
use kairosdb::query::{Query, Time, TimeUnit};

let client = Client::new("localhost", 8080);
let query = Query::new(
   Time::Nanoseconds(1),
   Time::Relative{value: 1, unit: TimeUnit::WEEKS});
let result = client.delete(&query);
assert!(result.is_ok())

pub fn list_metrics(&self) -> Result<Vec<String>, KairoError>

Returns a list with all metric names

Example

use kairosdb::Client;
let client = Client::new("localhost", 8080);

let result = client.list_metrics();
assert!(result.is_ok());
assert!(result.unwrap().contains(&"first".to_string()));

pub fn delete_metric(&self, metric: &str) -> Result<(), KairoError>

Deleting a metric

Example

use kairosdb::Client;
let client = Client::new("localhost", 8080);

let result = client.delete_metric(&"first");
assert!(result.is_ok());

pub fn tagnames(&self) -> Result<Vec<String>, KairoError>

Returns a list of all tagnames

Example

use kairosdb::Client;
let client = Client::new("localhost", 8080);

let result = client.tagnames();
assert!(result.is_ok());
assert!(result.unwrap().contains(&"test".to_string()));

pub fn tagvalues(&self) -> Result<Vec<String>, KairoError>

Returns a list of all tagvalues

Example

use kairosdb::Client;
let client = Client::new("localhost", 8080);

let result = client.tagvalues();
assert!(result.is_ok());
assert!(result.unwrap().contains(&"first".to_string()));

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.