History

Wrapper for KairosDB to access history data about checks.

history(url=None, check_id='', entities=None, oauth2=False)

Methods of History

result(time_from=ONE_WEEK_AND_5MIN, time_to=ONE_WEEK)

Return query result.

Parameters:
  • time_from – Relative time from in seconds. Default is ONE_WEEK_AND_5MIN.
  • time_to – Relative time to in seconds. Default is ONE_WEEK.
Returns:

Json result
Return type:

dict
get_one(time_from=ONE_WEEK_AND_5MIN, time_to=ONE_WEEK)

Return first result values.

Parameters:
  • time_from – Relative time from in seconds. Default is ONE_WEEK_AND_5MIN.
  • time_to – Relative time to in seconds. Default is ONE_WEEK.
Returns:

List of values
Return type:

list
get_aggregated(key, aggregator, time_from=ONE_WEEK_AND_5MIN, time_to=ONE_WEEK)

Return first result values. If no key filtering matches, empty list is returned.

Parameters:
  • key (str) – Tag key used in filtering the results.
  • aggregator (str) – Aggregator used in query. (e.g ‘avg’)
  • time_from – Relative time from in seconds. Default is ONE_WEEK_AND_5MIN.
  • time_to – Relative time to in seconds. Default is ONE_WEEK.
Returns:

List of values
Return type:

list
get_avg(key, time_from=ONE_WEEK_AND_5MIN, time_to=ONE_WEEK)

Return aggregated average.

Parameters:
  • key (str) – Tag key used in filtering the results.
  • time_from – Relative time from in seconds. Default is ONE_WEEK_AND_5MIN.
  • time_to – Relative time to in seconds. Default is ONE_WEEK.
Returns:

List of values
Return type:

list
get_std_dev(key, time_from=ONE_WEEK_AND_5MIN, time_to=ONE_WEEK)

Return aggregated standard deviation.

Parameters:
  • key (str) – Tag key used in filtering the results.
  • time_from – Relative time from in seconds. Default is ONE_WEEK_AND_5MIN.
  • time_to – Relative time to in seconds. Default is ONE_WEEK.
Returns:

List of values
Return type:

list
distance(self, weeks=4, snap_to_bin=True, bin_size='1h', dict_extractor_path='')

For detailed docs on distance function please see History distance functionality .