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
5 NFVbench Fluentd Integration
6 ============================================
8 NFVbench has an optional fluentd integration to save logs and results.
10 Configuring Fluentd to receive NFVbench logs and results
11 --------------------------------------------------------
13 The following configurations should be added to Fluentd configuration file to enable logs or results.
15 To receive logs, and forward to a storage server:
17 In the example below nfvbench is the tag name for logs (which should be matched with logging_tag
18 under NFVbench configuration), and storage backend is elasticsearch which is
19 running at localhost:9200.
31 logstash_prefix nfvbench
37 To receive results, and forward to a storage server:
39 In the example below resultnfvbench is the tag name for results (which should be matched with result_tag
40 under NFVbench configuration), and storage backend is elasticsearch which is
41 running at localhost:9200.
45 <match resultnfvbench.**>
52 logstash_prefix resultnfvbench
58 Configuring NFVbench to connect Fluentd
59 ---------------------------------------
61 To configure NFVbench to connect Fluentd, fill following configuration parameters in the
64 +------------------------------------------------------+------------------------------------------------------+
65 | Configuration | Description |
66 +======================================================+======================================================+
67 | logging_tag | Tag for NFVbench logs, it should be the same tag |
68 | | defined in Fluentd configuration |
69 +------------------------------------------------------+------------------------------------------------------+
70 | result_tag | Tag for NFVbench results, it should be the same tag |
71 | | defined in Fluentd configuration |
72 +------------------------------------------------------+------------------------------------------------------+
73 | ip | ip address of Fluentd server |
74 +------------------------------------------------------+------------------------------------------------------+
75 | port | port number of Fluentd serverd |
76 +------------------------------------------------------+------------------------------------------------------+
78 An example of configuration for Fluentd working at 127.0.0.1:24224 and tags for logging is nfvbench
79 and result is resultnfvbench
84 # by default (logging_tag is empty) nfvbench log messages are not sent to fluentd
85 # to enable logging to fluents, specify a valid fluentd tag name to be used for the
89 # by default (result_tag is empty) nfvbench results are not sent to fluentd
90 # to enable sending nfvbench results to fluentd, specify a valid fluentd tag name
91 # to be used for the results records, which is different than logging_tag
92 result_tag: resultnfvbench
94 # IP address of the server, defaults to loopback
97 # port # to use, by default, use the default fluentd forward port
100 Example of logs and results
101 ---------------------------
103 An example of log obtained from fluentd by elasticsearch:
108 "_index": "nfvbench-2017.10.17",
110 "_id": "AV8rhnCjTgGF_dX8DiKK",
115 "message": "Service chain 'PVP' run completed.",
116 "@timestamp": "2017-10-17T18:09:09.516897+0000",
117 "runlogdate": "2017-10-17T18:08:51.851253+0000"
128 For each packet size and rate a result record is sent. Users can label those results by passing
129 --user-label parameter to NFVbench run
133 nfvbench --rate 1% --user-label nfvbench-label
135 And the results of this command obtained from fluentd by elasticsearch:
140 "_index": "resultnfvbench-2017.10.17",
142 "_id": "AV8rjYlbTgGF_dX8Drl1",
149 "total_orig_rate_bps": 200000000,
150 "@timestamp": "2017-10-17T18:16:43.755240+0000",
152 "forward_orig_rate_pps": 148809,
154 "avg_delay_usec": 6271,
155 "total_tx_rate_pps": 283169,
156 "total_tx_rate_bps": 190289668,
157 "forward_tx_rate_bps": 95143832,
158 "reverse_tx_rate_bps": 95145836,
159 "forward_tx_rate_pps": 141583,
160 "chain_analysis_duration": "60.091",
161 "service_chain": "PVP",
162 "version": "1.0.10.dev1",
163 "runlogdate": "2017-10-17T18:10:12.134260+0000",
164 "Encapsulation": "VLAN",
165 "user_label": "nfvbench-label",
166 "min_delay_usec": 70,
167 "profile": "traffic_profile_64B",
168 "reverse_rx_rate_pps": 68479,
169 "reverse_rx_rate_bps": 46018044,
170 "reverse_orig_rate_pps": 148809,
171 "total_rx_rate_bps": 92030085,
172 "drop_rate_percent": 51.6368455626846,
173 "forward_orig_rate_bps": 100000000,
174 "bidirectional": true,
175 "vSwitch": "OPENVSWITCH",
177 "total_orig_rate_pps": 297618,
178 "type": "single_run",
179 "reverse_orig_rate_bps": 100000000,
180 "total_rx_rate_pps": 136949,
181 "max_delay_usec": 106850,
182 "forward_rx_rate_pps": 68470,
183 "forward_rx_rate_bps": 46012041,
184 "reverse_tx_rate_pps": 141586