cd1f886b206ceea262f4ab37a7879703288116d5
[nfvbench.git] / docs / testing / user / userguide / examples.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. (c) Cisco Systems, Inc
4
5 Example of Results
6 ******************
7 Example run for fixed rate
8
9 .. code-block:: bash
10     nfvbench -c /nfvbench/nfvbenchconfig.json --rate 1%
11
12 .. code-block:: bash
13     ========== NFVBench Summary ==========
14     Date: 2017-09-21 23:57:44
15     NFVBench version 1.0.9
16     Openstack Neutron:
17       vSwitch: BASIC
18       Encapsulation: BASIC
19     Benchmarks:
20     > Networks:
21       > Components:
22         > TOR:
23             Type: None
24         > Traffic Generator:
25             Profile: trex-local
26             Tool: TRex
27         > Versions:
28           > TOR:
29           > Traffic Generator:
30               build_date: Aug 30 2017
31               version: v2.29
32               built_by: hhaim
33               build_time: 16:43:55
34       > Service chain:
35         > PVP:
36           > Traffic:
37               Profile: traffic_profile_64B
38               Bidirectional: True
39               Flow count: 10000
40               Service chains count: 1
41               Compute nodes: []
42
43                 Run Summary:
44
45                   +-----------------+-------------+----------------------+----------------------+----------------------+
46                   |   L2 Frame Size |  Drop Rate  |   Avg Latency (usec) |   Min Latency (usec) |   Max Latency (usec) |
47                   +=================+=============+======================+======================+======================+
48                   |              64 |   0.0000%   |                   53 |                   20 |                  211 |
49                   +-----------------+-------------+----------------------+----------------------+----------------------+
50
51
52                 L2 frame size: 64
53                 Chain analysis duration: 60.076 seconds
54
55                 Run Config:
56
57                   +-------------+---------------------------+------------------------+-----------------+---------------------------+------------------------+-----------------+
58                   |  Direction  |  Requested TX Rate (bps)  |  Actual TX Rate (bps)  |  RX Rate (bps)  |  Requested TX Rate (pps)  |  Actual TX Rate (pps)  |  RX Rate (pps)  |
59                   +=============+===========================+========================+=================+===========================+========================+=================+
60                   |   Forward   |       100.0000 Mbps       |      95.4546 Mbps      |  95.4546 Mbps   |        148,809 pps        |      142,045 pps       |   142,045 pps   |
61                   +-------------+---------------------------+------------------------+-----------------+---------------------------+------------------------+-----------------+
62                   |   Reverse   |       100.0000 Mbps       |      95.4546 Mbps      |  95.4546 Mbps   |        148,809 pps        |      142,045 pps       |   142,045 pps   |
63                   +-------------+---------------------------+------------------------+-----------------+---------------------------+------------------------+-----------------+
64                   |    Total    |       200.0000 Mbps       |     190.9091 Mbps      |  190.9091 Mbps  |        297,618 pps        |      284,090 pps       |   284,090 pps   |
65                   +-------------+---------------------------+------------------------+-----------------+---------------------------+------------------------+-----------------+
66
67                 Chain Analysis:
68
69                   +-------------------+----------+-----------------+---------------+---------------+-----------------+---------------+---------------+
70                   |     Interface     |  Device  |  Packets (fwd)  |   Drops (fwd) |  Drop% (fwd)  |  Packets (rev)  |   Drops (rev) |  Drop% (rev)  |
71                   +===================+==========+=================+===============+===============+=================+===============+===============+
72                   | traffic-generator |   trex   |    8,522,729    |               |               |    8,522,729    |             0 |    0.0000%    |
73                   +-------------------+----------+-----------------+---------------+---------------+-----------------+---------------+---------------+
74                   | traffic-generator |   trex   |    8,522,729    |             0 |    0.0000%    |    8,522,729    |               |               |
75                   +-------------------+----------+-----------------+---------------+---------------+-----------------+---------------+---------------+
76
77 Example run for NDR/PDR with package size 1518B
78
79 .. code-block:: bash
80     nfvbench -c /nfvbench/nfvbenchconfig.json -fs 1518
81
82 .. code-block:: bash
83     ========== NFVBench Summary ==========
84     Date: 2017-09-22 00:02:07
85     NFVBench version 1.0.9
86     Openstack Neutron:
87       vSwitch: BASIC
88       Encapsulation: BASIC
89     Benchmarks:
90     > Networks:
91       > Components:
92         > TOR:
93             Type: None
94         > Traffic Generator:
95             Profile: trex-local
96             Tool: TRex
97         > Versions:
98           > TOR:
99           > Traffic Generator:
100               build_date: Aug 30 2017
101               version: v2.29
102               built_by: hhaim
103               build_time: 16:43:55
104       > Measurement Parameters:
105           NDR: 0.001
106           PDR: 0.1
107       > Service chain:
108         > PVP:
109           > Traffic:
110               Profile: custom_traffic_profile
111               Bidirectional: True
112               Flow count: 10000
113               Service chains count: 1
114               Compute nodes: []
115
116                 Run Summary:
117
118                   +-----+-----------------+------------------+------------------+-----------------+----------------------+----------------------+----------------------+
119                   |  -  |   L2 Frame Size |  Rate (fwd+rev)  |  Rate (fwd+rev)  |  Avg Drop Rate  |   Avg Latency (usec) |   Min Latency (usec) |  Max Latency (usec)  |
120                   +=====+=================+==================+==================+=================+======================+======================+======================+
121                   | NDR |            1518 |   19.9805 Gbps   |  1,623,900 pps   |     0.0001%     |                  342 |                   30 |         704          |
122                   +-----+-----------------+------------------+------------------+-----------------+----------------------+----------------------+----------------------+
123                   | PDR |            1518 |   20.0000 Gbps   |  1,625,486 pps   |     0.0022%     |                  469 |                   40 |        1,266         |
124                   +-----+-----------------+------------------+------------------+-----------------+----------------------+----------------------+----------------------+
125
126
127                 L2 frame size: 1518
128                 Chain analysis duration: 660.442 seconds
129                 NDR search duration: 660 seconds
130                 PDR search duration: 0 seconds