From: Sebastian Harl <sh@tokkee.org>
Date: Fri, 22 Aug 2014 05:01:13 +0000 (-0700)
Subject: sysdbql(7): Documented the ‘TIMESERIES’ command.
X-Git-Tag: sysdb-0.4.0~12
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=de8b8b6500558f199ad115a55ac764d0d5b92192;p=sysdb.git

sysdbql(7): Documented the ‘TIMESERIES’ command.
---

diff --git a/doc/sysdbql.7.txt b/doc/sysdbql.7.txt
index aa3add3..5c3c291 100644
--- a/doc/sysdbql.7.txt
+++ b/doc/sysdbql.7.txt
@@ -58,6 +58,14 @@ matching that filter will be included in the reply. See the sections "MATCHING
 clause" and "FILTER clause" for more details about how to specify the search
 and filter conditions.
 
+*TIMESERIES* '<hostname>'.'<metric>' [START '<datetime>'] [END '<datetime>']::
+Retrieve a time-series for the specified host's metric. The data is retrieved
+from a backend data-store based on information provided by the respective
+query plugin. The return value includes the actual start and end time of the
+time-series and one or multiple sequences of time-stamp / value pairs. If the
+metric does not exist or if the backend data-store is not supported, an error
+is returned.
+
 MATCHING clause
 ~~~~~~~~~~~~~~~
 The *MATCHING* clause in a query specifies a boolean expression which is used