Merge "Results: Default latency-histrogram with Spirent TestCenter"

2 files changed, 26 insertions, 1 deletions

diff --git a/docs/testing/developer/devguide/design/vswitchperf_design.rst b/docs/testing/developer/devguide/design/vswitchperf_design.rst
index b8a3ba19..bc54476c 100644
--- a/docs/testing/developer/devguide/design/vswitchperf_design.rst
+++ b/docs/testing/developer/devguide/design/vswitchperf_design.rst
@@ -472,6 +472,11 @@ Detailed description of ``TRAFFIC`` dictionary items follows:
                                      'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
                                      'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
                                      '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
+    'latency_histogram'
+                     - A dictionary with definition of a latency histogram provision in results.
+         'enabled'   - Specifies if the histogram provisioning is enabled or not.
+         'type'      - Defines how histogram is provided. Currenty only 'Default' is defined.
+                         'Default' - Default histogram as provided by the Traffic-generator.
 
 .. _configuration-of-guest-options:
 
diff --git a/docs/testing/user/configguide/trafficgen.rst b/docs/testing/user/configguide/trafficgen.rst
index 2636626a..ae745543 100644
--- a/docs/testing/user/configguide/trafficgen.rst
+++ b/docs/testing/user/configguide/trafficgen.rst
@@ -86,7 +86,11 @@ and is configured as follows:
                   'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
                   'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
                   '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
-        }
+        },
+        'latency_histogram': {
+            'enabled': False,
+            'type': 'Default',
+        },
     }
 
 A detailed description of the ``TRAFFIC`` dictionary can be found at
@@ -566,6 +570,22 @@ Note that 'FORWARDING_RATE_FPS', 'CACHING_CAPACITY_ADDRS',
 'ADDR_LEARNED_PERCENT' and 'OPTIMAL_LEARNING_RATE_FPS' are the new
 result-constants added to support RFC2889 tests.
 
+4. Latency Histogram. To enable latency histogram as in results,
+enable latency_histogram in conf/03_traffic.conf.
+
+.. code-block:: python
+
+    'Latency_hisotgram':
+    {
+        "enabled": True,
+        "tpe": "Default,
+    }
+
+Once, enabled, a 'Histogram.csv' file will be generated in the results folder.
+The Histogram.csv will include latency histogram in the following order.
+(a) Packet size (b) Ranges in 10ns (c) Packet counts. These set of 3 lines,
+will be repeated for every packet-sizes.
+
 .. _`Xena Networks`:
 
 Xena Networks