summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorKevin Traynor <ktraynor@redhat.com>2022-11-30 17:39:53 +0000
committerIlya Maximets <i.maximets@ovn.org>2022-12-21 20:58:10 +0100
commite9ab15f4f82330e0d7bc33e57d3357fa52f76749 (patch)
tree5fef7b31d008d84ab5dd498652d099357380a4aa /Documentation
parent526230bfab09095cf0214c7033382463b9d506cf (diff)
downloadopenvswitch-e9ab15f4f82330e0d7bc33e57d3357fa52f76749.tar.gz
docs: Add documentation for pmd-rxq-show secs parameter.
Add description of new '-secs' parameter in docs. Also, add to NEWS as it is a user facing change. Reviewed-by: David Marchand <david.marchand@redhat.com> Signed-off-by: Kevin Traynor <ktraynor@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/topics/dpdk/pmd.rst23
1 files changed, 18 insertions, 5 deletions
diff --git a/Documentation/topics/dpdk/pmd.rst b/Documentation/topics/dpdk/pmd.rst
index b259cc8b3..88457f366 100644
--- a/Documentation/topics/dpdk/pmd.rst
+++ b/Documentation/topics/dpdk/pmd.rst
@@ -101,12 +101,20 @@ core cycles for each Rx queue::
.. note::
- A history of one minute is recorded and shown for each Rx queue to allow for
- traffic pattern spikes. Any changes in the Rx queue's PMD core cycles usage,
- due to traffic pattern or reconfig changes, will take one minute to be fully
- reflected in the stats.
+ By default a history of one minute is recorded and shown for each Rx queue
+ to allow for traffic pattern spikes. Any changes in the Rx queue's PMD core
+ cycles usage, due to traffic pattern or reconfig changes, will take one
+ minute to be fully reflected in the stats by default.
- .. versionchanged:: 2.6.0
+PMD thread usage of an Rx queue can be displayed for a shorter period of time,
+from the last 5 seconds up to the default 60 seconds in 5 second steps.
+
+To see the port/Rx queue assignment and the last 5 secs of measured usage
+history of PMD core cycles for each Rx queue::
+
+ $ ovs-appctl dpif-netdev/pmd-rxq-show -secs 5
+
+.. versionchanged:: 2.6.0
The ``pmd-rxq-show`` command was added in OVS 2.6.0.
@@ -115,6 +123,11 @@ core cycles for each Rx queue::
A ``overhead`` statistics is shown per PMD: it represents the number of
cycles inherently consumed by the OVS PMD processing loop.
+.. versionchanged:: 3.1.0
+
+ The ``-secs`` parameter was added to the dpif-netdev/pmd-rxq-show
+ command.
+
Rx queue to PMD assignment takes place whenever there are configuration changes
or can be triggered by using::