Python: module rest_api.swagger_server.controllers.measurements

rest_api.swagger_server.controllers.measurements_controller

index
/var/lib/jenkins/workspace/resmon_monitor_doc/rest_api/swagger_server/controllers/measurements_controller.py

Modules

rest_api.apiUtils.apiUtils.QueryResolver
datetime
common.database.mongoAccess.dbApi
rest_api.swagger_server.util

Functions

get_measurements(start=None, end=None, q=None, limit=None, last=None)
Selected measurements # noqa: E501 :param start: ISO 8601 datetime format with 1s accuracy. Default value is current time subtracted by 1 day :type start: str :param end: ISO 8601 datetime format with 1s accuracy. Default value is current time. :type end: str :param q: Filters out used metrics and hosts according to provided keys. String needs to match the following schema: `KEY1:VAL1,KEY2:VAL2;KEY3:VAL4...`. Comma is used to indicate `AND` operation while semicolon relates to `OR`. When `VAL` paramater is wrapped into slashes then regex mode is activated. For example when we query for `metric_id:cpu,os:/.*nix.*/;metric_id:cpu,os:/.*win.*/` we should receive cpu metric measurements for hosts containing either nix or win as substring in `os` metadata. Note that `AND` operation has higher priority than `OR`. Allowed keys: `metric_id`, `description`, `complex` (metric parameters) and all available host metadata fields. When not provided: No filtering performed - all available metrics and hosts are taken :type q: str :param limit: Number of maximal amount of measurements given as a result of the query :type limit: :param last: If it is set as `TRUE` then the only last measurement meeting the criteria from `q` parameter is returned :type last: bool :rtype: List[Measurement]

Data

TIME_IND = 0
VALUE_IND = 1

Functions
		get_measurements(start=None, end=None, q=None, limit=None, last=None) Selected measurements # noqa: E501 :param start: ISO 8601 datetime format with 1s accuracy. Default value is current time subtracted by 1 day :type start: str :param end: ISO 8601 datetime format with 1s accuracy. Default value is current time. :type end: str :param q: Filters out used metrics and hosts according to provided keys. String needs to match the following schema: `KEY1:VAL1,KEY2:VAL2;KEY3:VAL4...`. Comma is used to indicate `AND` operation while semicolon relates to `OR`. When `VAL` paramater is wrapped into slashes then regex mode is activated. For example when we query for `metric_id:cpu,os:/.nix./;metric_id:cpu,os:/.win./` we should receive cpu metric measurements for hosts containing either nix or win as substring in `os` metadata. Note that `AND` operation has higher priority than `OR`. Allowed keys: `metric_id`, `description`, `complex` (metric parameters) and all available host metadata fields. When not provided: No filtering performed - all available metrics and hosts are taken :type q: str :param limit: Number of maximal amount of measurements given as a result of the query :type limit: :param last: If it is set as `TRUE` then the only last measurement meeting the criteria from `q` parameter is returned :type last: bool :rtype: List[Measurement]