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.
30 logstash_prefix nfvbench
36 To receive results, and forward to a storage server:
38 In the example below resultnfvbench is the tag name for results (which should be matched with result_tag
39 under NFVbench configuration), and storage backend is elasticsearch which is
40 running at localhost:9200.
43 <match resultnfvbench.**>
50 logstash_prefix resultnfvbench
56 Configuring NFVbench to connect Fluentd
57 ---------------------------------------
59 To configure NFVbench to connect Fluentd, fill following configuration parameters in the
62 +------------------------------------------------------+------------------------------------------------------+
63 | Configuration | Description |
64 +======================================================+======================================================+
65 | logging_tag | Tag for NFVbench logs, it should be the same tag |
66 | | defined in Fluentd configuration |
67 +------------------------------------------------------+------------------------------------------------------+
68 | result_tag | Tag for NFVbench results, it should be the same tag |
69 | | defined in Fluentd configuration |
70 +------------------------------------------------------+------------------------------------------------------+
71 | ip | ip address of Fluentd server |
72 +------------------------------------------------------+------------------------------------------------------+
73 | port | port number of Fluentd serverd |
74 +------------------------------------------------------+------------------------------------------------------+
76 An example of configuration for Fluentd working at 127.0.0.1:24224 and tags for logging is nfvbench
77 and result is resultnfvbench
81 # by default (logging_tag is empty) nfvbench log messages are not sent to fluentd
82 # to enable logging to fluents, specify a valid fluentd tag name to be used for the
86 # by default (result_tag is empty) nfvbench results are not sent to fluentd
87 # to enable sending nfvbench results to fluentd, specify a valid fluentd tag name
88 # to be used for the results records, which is different than logging_tag
89 result_tag: resultnfvbench
91 # IP address of the server, defaults to loopback
94 # port # to use, by default, use the default fluentd forward port
97 Example of logs and results
98 ---------------------------
100 An example of log obtained from fluentd by elasticsearch:
105 "_index": "nfvbench-2017.10.17",
107 "_id": "AV8rhnCjTgGF_dX8DiKK",
112 "message": "Service chain 'PVP' run completed.",
113 "@timestamp": "2017-10-17T18:09:09.516897+0000",
114 "runlogdate": "2017-10-17T18:08:51.851253+0000"
125 For each packet size and rate a result record is sent. Users can label those results by passing
126 --user-label parameter to NFVbench run
129 nfvbench --rate 1% --user-label nfvbench-label
131 And the results of this command obtained from fluentd by elasticsearch:
136 "_index": "resultnfvbench-2017.10.17",
138 "_id": "AV8rjYlbTgGF_dX8Drl1",
145 "total_orig_rate_bps": 200000000,
146 "@timestamp": "2017-10-17T18:16:43.755240+0000",
148 "forward_orig_rate_pps": 148809,
150 "avg_delay_usec": 6271,
151 "total_tx_rate_pps": 283169,
152 "total_tx_rate_bps": 190289668,
153 "forward_tx_rate_bps": 95143832,
154 "reverse_tx_rate_bps": 95145836,
155 "forward_tx_rate_pps": 141583,
156 "chain_analysis_duration": "60.091",
157 "service_chain": "PVP",
158 "version": "1.0.10.dev1",
159 "runlogdate": "2017-10-17T18:10:12.134260+0000",
160 "Encapsulation": "VLAN",
161 "user_label": "nfvbench-label",
162 "min_delay_usec": 70,
163 "profile": "traffic_profile_64B",
164 "reverse_rx_rate_pps": 68479,
165 "reverse_rx_rate_bps": 46018044,
166 "reverse_orig_rate_pps": 148809,
167 "total_rx_rate_bps": 92030085,
168 "drop_rate_percent": 51.6368455626846,
169 "forward_orig_rate_bps": 100000000,
170 "bidirectional": true,
171 "vSwitch": "OPENVSWITCH",
173 "total_orig_rate_pps": 297618,
174 "type": "single_run",
175 "reverse_orig_rate_bps": 100000000,
176 "total_rx_rate_pps": 136949,
177 "max_delay_usec": 106850,
178 "forward_rx_rate_pps": 68470,
179 "forward_rx_rate_bps": 46012041,
180 "reverse_tx_rate_pps": 141586