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