From 47b97a504ea5c16d8b571ecdfab74eabbb920056 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Tue, 8 Sep 2015 16:28:01 -0700 Subject: [PATCH] [Telemetry] Document TelemetryRequest Document TelemetryRequest to record new parameters in support of the time conductor, WTD-1515 --- platform/telemetry/src/TelemetryAggregator.js | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/platform/telemetry/src/TelemetryAggregator.js b/platform/telemetry/src/TelemetryAggregator.js index fb4cf81fe0..86257befb7 100644 --- a/platform/telemetry/src/TelemetryAggregator.js +++ b/platform/telemetry/src/TelemetryAggregator.js @@ -31,6 +31,30 @@ define( function () { "use strict"; + /** + * Describes a request for telemetry data. Note that responses + * may contain either a sub- or superset of the requested data. + * @typedef TelemetryRequest + * @property {string} source an identifier for the relevant + * source of telemetry data + * @property {string} key an identifier for the specific + * series of telemetry data provided by that source + * @property {number} [start] the earliest domain value of + * interest for that telemetry data; for time-based + * domains, this is in milliseconds since the start + * of 1970 + * @property {number} [end] the latest domain value of interest + * for that telemetry data; for time-based domains, + * this is in milliseconds since 1970 + * @property {string} [domain] the domain for the query; if + * omitted, this will be whatever the "normal" + * domain is for a given telemetry series (the + * first domain from its metadata) + * @property {number} [size] if set, indicates the maximum number + * of data points of interest for this request (more + * recent domain values will be preferred) + */ + /** * Request telemetry data. * @param {TelemetryRequest[]} requests and array of