Timeseries driver documentation.

scripts/lua/modules/timeseries/drivers/sample.lua

@@ -0,0 +1,56 @@
+--
+-- (C) 2018 - ntop.org
+--
+
+-- A sample timeseries driver
+local driver = {}
+
+-- ##############################################
+
+--! @brief Driver constructor.
+--! @param options global options.
+--! @return the newly created driver.
+function driver:new(options)
+end
+
+--! @brief Append a new data point to the timeseries.
+--! @param schema the schema object.
+--! @param timestamp the data point timestamp.
+--! @param tags map tag_name->tag_value. It contains exactly the tags defined in the schema.
+--! @param metrics map metric_name->metric_value. It contains exactly the metrics defined in the schema.
+--! @return the true on success, false otherwise.
+function driver:append(schema, timestamp, tags, metrics)
+end
+
+--! @brief Append a new data point to the timeseries.
+--! @param schema the schema object.
+--! @param tstart lower time bound for the query.
+--! @param tend upper time bound for the query.
+--! @param tags a list of filter tags. It contains exactly the tags defined in the schema.
+--! @param options query options.
+function driver:query(schema, tstart, tend, tags, options)
+end
+
+--! @brief List all available timeseries for the specified schema, tags and time.
+--! @param schema the schema object.
+--! @param tags_filter a list of filter tags.
+--! @param wildcard_tags the remaining tags of the schema which are considered wildcard.
+--! @param start_time time filter. Only timeseries updated after start_time will be returned.
+--! @return a (possibly empty) list of tags values for the matching timeseries on success, nil on error.
+function driver:listSeries(schema, tags_filter, wildcard_tags, start_time)
+end
+
+--! @brief Get top k items information.
+--! @param schema the schema object.
+--! @param tags a list of filter tags.
+--! @param tstart lower time bound for the query.
+--! @param tend upper time bound for the query.
+--! @param options query options.
+--! @param top_tags the remaining tags of the schema, on which top k calculation is taking place.
+--! @return a topk result on success, nil on error.
+function driver:topk(schema, tags, tstart, tend, options, top_tags)
+end
+
+-- ##############################################
+
+return driver