From 3a32e28ebed3035f8c8ba72a0d48eedc8a00e478 Mon Sep 17 00:00:00 2001 From: Christian Giese Date: Wed, 2 Nov 2022 14:01:16 +0000 Subject: [PATCH] docu update --- docsrc/sources/configuration/interfaces_lag.rst | 3 +++ docsrc/sources/interfaces.rst | 16 ++++++++-------- docsrc/sources/streams.rst | 16 ++++++++-------- docsrc/sources/troubleshooting.rst | 10 ++++++++-- 4 files changed, 27 insertions(+), 18 deletions(-) diff --git a/docsrc/sources/configuration/interfaces_lag.rst b/docsrc/sources/configuration/interfaces_lag.rst index 13922cad..ecf9a72a 100644 --- a/docsrc/sources/configuration/interfaces_lag.rst +++ b/docsrc/sources/configuration/interfaces_lag.rst @@ -25,6 +25,9 @@ * - `lacp-system-id` - LACP system identifier - 02:ff:ff:ff:ff:00 + * - `lacp-min-active-links` + - Define the minimum number of active links + - 0 * - `lacp-max-active-links` - Limit the maximum number of active links - 255 diff --git a/docsrc/sources/interfaces.rst b/docsrc/sources/interfaces.rst index b53eeaf1..6cb303f7 100644 --- a/docsrc/sources/interfaces.rst +++ b/docsrc/sources/interfaces.rst @@ -130,8 +130,8 @@ Link Aggregation (LAG) ~~~~~~~~~~~~~~~~~~~~~~ The BNG Blaster supports link aggregation (LAG) with and without -LACP. The created LAG interface can be used as link for all kinds -of interface functions. +LACP. The created LAG interface can be used as the parent interface link +for all kinds of interface functions. .. include:: configuration/interfaces_lag.rst @@ -171,16 +171,16 @@ of interface functions. Multithreaded Interfaces ~~~~~~~~~~~~~~~~~~~~~~~~ -The BNG Blaster handles all traffic sent and received (IO) in the main thread per default. +The BNG Blaster handles all traffic sent and received (I/O) in the main thread per default. With this default behavior, you can achieve between 100.000 and 200.000 PPS bidirectional traffic in most environments. Depending on the actual setup, this can be even less or much more, which is primarily driven by the single-thread performance of the given CPU. -Those numbers can be increased by splitting the workload over multiple IO worker threads. -Every IO thread will handle only one interface and direction. It is also possible to start +Those numbers can be increased by splitting the workload over multiple I/O worker threads. +Every I/O thread will handle only one interface and direction. It is also possible to start multiple threads for the same interface and direction. -The number of IO threads can be configured globally for all interfaces or per interface link. +The number of I/O threads can be configured globally for all interfaces or per interface link. .. code-block:: json @@ -215,10 +215,10 @@ at least 4 TX threads to verify all prefixes of a BGP full table for example. The configured traffic streams are automatically balanced over all TX threads of the corresponding interfaces but a single stream can't be split over multiple threads to prevent re-ordering issues. -Enabling multithreaded IO causes some limitations. First of all, it works only on systems with +Enabling multithreaded I/O causes some limitations. First of all, it works only on systems with CPU cache coherence, which should apply to all modern CPU architectures. It is also not possible to bundle (Link Aggregation) multithreaded interfaces. It is also not possible to capture traffic -streams send or received on threaded interfaces. All other traffic is still captured even on threaded +streams send or received on threaded interfaces. All other traffic is still captured on threaded interfaces. .. note:: diff --git a/docsrc/sources/streams.rst b/docsrc/sources/streams.rst index a8a907bd..d8bbf0fa 100644 --- a/docsrc/sources/streams.rst +++ b/docsrc/sources/streams.rst @@ -217,7 +217,7 @@ working. After the first packet is received for a given flow, for every further if there is a gap between the last and new sequence number which is then reported as a loss. The ``rx/tx-accounting-packets`` are all packets that should be counted in the session volume -accounting of the BNG, meaning session rx/tx packets excluding control traffic. +accounting of the BNG, meaning session RX/TX packets excluding control traffic. Each flow can be queried separately using jsonpath expression with name and direction or flow-id. @@ -302,11 +302,11 @@ Alternatively, all the session and stream traffic (including RAW streams) can be started or stopped globally using the ``traffic-start`` and ``traffic-stop`` commands. +.. _bbl_header: + BNG Blaster Traffic ~~~~~~~~~~~~~~~~~~~ -.. _bbl_header: - *Blaster Header and Fast Decode Signature* The 48 Byte fixed size BNG Blaster Header is added to all data packets @@ -319,7 +319,7 @@ IPv4 multicast traffic. Unicast Session Traffic ^^^^^^^^^^^^^^^^^^^^^^^ -The 64 bit session key is used for all traffic from access (upstream) +The 64-bit session key is used for all traffic from access (upstream) and to access (downstream) interfaces to identify the corresponding session which has sent or should receive the packet. @@ -387,7 +387,7 @@ Multicast Traffic BNG Blaster Magic Sequence ^^^^^^^^^^^^^^^^^^^^^^^^^^ -The 64 bit magic sequence is the word ``RtBrick!`` decoded as ASCII: +The 64-bit magic sequence is the word ``RtBrick!`` decoded as ASCII: .. code-block:: none @@ -399,13 +399,13 @@ of blaster traffic. Flow Identifier ^^^^^^^^^^^^^^^ -The 64 bit flow identifier is a globally unique number that identifies +The 64-bit flow identifier is a globally unique number that identifies the flow. Flow Sequence Number ^^^^^^^^^^^^^^^^^^^^ -The 64 bit flow sequence number is a sequential number starting with 1 +The 64-bit flow sequence number is a sequential number starting with 1 and incremented per packet primary used to identify packet loss. This number 0 means that sequencing is disabled. @@ -413,7 +413,7 @@ This number 0 means that sequencing is disabled. Nanosecond Send Timestamps ^^^^^^^^^^^^^^^^^^^^^^^^^^ -The 64 bit nanoseconds send timestamp is used for optional latency and +The 64-bit nanoseconds send timestamp is used for optional latency and jitter calculations. .. code-block:: none diff --git a/docsrc/sources/troubleshooting.rst b/docsrc/sources/troubleshooting.rst index 69103a55..b47ada77 100644 --- a/docsrc/sources/troubleshooting.rst +++ b/docsrc/sources/troubleshooting.rst @@ -6,18 +6,18 @@ Logging The BNG Blaster can log events to the standard output or the logging window of the interactive courses interface. -Those events could be also logged to files using the argument +Those events could be also logged into files using the argument ``-L ``. Per default, only events classified as `info` or `error` are logged. The following list shows all supported logging options. * ``debug``: debug events +* ``info``: informational events * ``error``: error events * ``igmp``: igmp events with join and leave time * ``io``: interface input/output events * ``pppoe``: pppoe events -* ``info``: informational events (enabled per default) * ``pcap``: PCAP related events * ``ip``: log learned IP addresses * ``loss``: log traffic loss with sequence number @@ -26,6 +26,8 @@ The following list shows all supported logging options. * ``isis``: log ISIS events * ``bgp``: log BGP events * ``tcp``: log TCP events +* ``lag``: log link aggregation (LAG) events +* ``dpdk``: log DPDK events .. code-block:: none @@ -56,6 +58,10 @@ include (default behavior) or exclude traffic streams from capture. } } + +Traffic streams send or received on threaded interfaces will be also not captured. +All other traffic is still captured on threaded interfaces. + Wireshark Plugin ~~~~~~~~~~~~~~~~