kairosdb – KairosDB REST API Interface¶

class kairosdb.KairosDBAPI(*args, **kwargs)[source]¶

KairosDB API interface

version¶

KairosDB version from API.

See also

https://kairosdb.github.io/docs/build/html/restapi/Version.html

health_status¶

KairosDB health status from API.

See also

https://kairosdb.github.io/docs/build/html/restapi/Health.html

health_check¶

KairosDB health check from API.

See also

https://kairosdb.github.io/docs/build/html/restapi/Health.html

metricnames¶

KairosDB metric names from API.

See also

https://kairosdb.github.io/docs/build/html/restapi/ListMetricNames.html

tagnames¶

KairosDB tag names from API.

See also

https://kairosdb.github.io/docs/build/html/restapi/ListTagNames.html

tagvalues¶

KairosDB tag values from API.

See also

https://kairosdb.github.io/docs/build/html/restapi/ListTagValues.html

search_metrics(matches, exclude_matches=None)[source]¶

Search KairosDB metrics using glob matches

Parameters:

matches (list) – List of glob matches

exclude_matches (list) – List of glob matches for exclusions

Returns:
Matched metric names as list()

query_metrics(data)[source]¶

Get metrics data points

Parameters: data (dict) – Data to post for query

Returns: Metric data points as dict

See also

https://kairosdb.github.io/docs/build/html/restapi/QueryMetrics.html

delete_metric(metric_name)[source]¶

Delete a metric and all data points associated with the metric

Parameters: metric_name (str) – Name of the metric to delete

See also

https://kairosdb.github.io/docs/build/html/restapi/DeleteMetric.html

delete_datapoints(data)[source]¶

Delete metric data points

Parameters: data (dict) – Data to post for query

See also

https://kairosdb.github.io/docs/build/html/restapi/DeleteDataPoints.html