Package cm_api :: Package endpoints :: Module timeseries

[frames] | no frames]

Module timeseries

Classes

ApiTimeSeriesData

ApiTimeSeriesMetadata

ApiTimeSeries

ApiTimeSeriesResponse

ApiMetricSchema

Functions

query_timeseries(resource_root, query, from_time=None, to_time=None)
Query for time series data from the CM time series data store.

source code

get_metric_schema(resource_root)
Get the schema for all of the metrics.

source code

Variables

TIME_SERIES_PATH = '/timeseries'

METRIC_SCHEMA_PATH = '/timeseries/schema'

LOG = logging.getLogger(__name__)

__package__ = 'cm_api.endpoints'

Function Details

query_timeseries(resource_root, query, from_time=None, to_time=None)


Query for time series data from the CM time series data store.
@param query: Query string.
@param from_time: Start of the period to query (optional).
                  This may be an ISO format string, or a datetime object.
@param to_time: End of the period to query (default = now).
                This may be an ISO format string, or a datetime object.
@return List of ApiTimeSeriesResponse

get_metric_schema(resource_root)

Get the schema for all of the metrics. @return List of metric schema.