Changes between Version 2 and Version 3 of Software/dOML/z3OML/FAQ

Timestamp:

Feb 1, 2006, 4:23:29 PM (19 years ago)

Author:

pkamat

Comment:

—

Software/dOML/z3OML/FAQ

@@ -2 +2 @@
 
 = FAQ =
-== What is it? ==
+== How do I configure OML measurement collection via nodehandler? ==
+OML supports TIME or SAMPLE based measurement collection. Depending on the the method used, either every ''X'' seconds or every ''Y'' samples, one can apply data filters to the measurements. There are two default filters included with the oml client : sum and mean. OML has the ability to apply user-defined filters to the collected data. (Details on how to do that will be posted soon).
+The collection and filtering of application generated data is defined in the prototypes used in your experiment.
+Let's look at 2 example prototype definitions to see how this works :
+
+Example I:
+
+{{{
+1. otg.addMeasurement('senderport',  Filter::TIME,
+2.   {Filter::SAMPLE_SIZE => 1},
+3.   [
+4.    ['pkt_seqno'],
+5.    ['pkt_size', Filter::SUM]
+6.  ]
+7. )
+}}}
+
+The "Filter" you see here is a nodehandler reference to the OML measurement collection and filtering mechanism. This definition is processed by the nodehandler and based on that it creates an xml file which acts as input to the oml client at runtime.
+
+ * On line 1, we are defining a Time-based filtering scheme on the data being generated by the application. (in this case otg)
+ * Line 2 sets the trigger for this collection in seconds. So 0.5 would indicate 0.5 seconds and so on. In the above example the oml client will collect measurements coming from the application and will process them every 1 seconds.
+ * On line 5 we instruct the oml client through nodehandler to apply the SUM filter on the "pkt_size" data.
+
+To summarize, every one second the oml-client would send the following filtered values to the collection server :
+ * The first seq_no collected in this time period (since no summarizing filter was applied only the first value is sent)
+ * The sum of all pkt_size metrics collected during this timer period.
+
+
+Example II :
+{{{
+1. otg.addMeasurement('senderport',  Filter::SAMPLE,
+2.   {Filter::SAMPLE_SIZE => 20},
+3.   [
+4.    ['pkt_seqno'],
+5.    ['pkt_size', Filter::MEAN]
+6.  ]
+7. )
+}}}
+
+In example II, the trigger for applying the filtering is 20 samples collected from the application. So every 20 samples later a summary will be sent to collection server with pkt_seqno and mean of the 20 pkt_sizes collected. 
+[[BR]]
+
+Take a look at some example prototype definitions here :
+http://www.orbit-lab.org/userdoc/wiki/OTG/ScriptsRepository