diff mbox series

[ovs-dev,v3,2/3] docs: Add documention for pmd-rxq-show secs parameter.

Message ID 20221130173954.1043885-2-ktraynor@redhat.com
State Accepted
Headers show
Series [ovs-dev,v3,1/3] dpif-netdev: Make pmd-rxq-show time configurable. | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/intel-ovs-compilation fail test: fail

Commit Message

Kevin Traynor Nov. 30, 2022, 5:39 p.m. UTC
Add description of new '-secs' parameter in docs. Also, add to NEWS as
it is a user facing change.

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
v3:
- My prediction that NEWS would cause a conflict was correct but
  I did not think it would be when submitting the patch :s
- Rebased NEWS entry
---
 Documentation/topics/dpdk/pmd.rst | 23 ++++++++++++++++++-----
 NEWS                              |  3 +++
 2 files changed, 21 insertions(+), 5 deletions(-)

Comments

David Marchand Dec. 2, 2022, 12:29 p.m. UTC | #1
On Wed, Nov 30, 2022 at 6:40 PM Kevin Traynor <ktraynor@redhat.com> wrote:
>
> Add description of new '-secs' parameter in docs. Also, add to NEWS as
> it is a user facing change.
>
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>

Reviewed-by: David Marchand <david.marchand@redhat.com>
diff mbox series

Patch

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
@@ -102,10 +102,18 @@  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.
@@ -116,4 +124,9 @@  core cycles for each Rx queue::
    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::
diff --git a/NEWS b/NEWS
index f6caf1ca7..a2ff388b0 100644
--- a/NEWS
+++ b/NEWS
@@ -31,4 +31,7 @@  Post-v3.0.0
      determined.  Previously it was 10 Mbps.  Values can still be overridden
      by specifying 'max-rate' or '[r]stp-path-cost' accordingly.
+   - Userspace datapath:
+     * Add '-secs' argument to appctl 'dpif-netdev/pmd-rxq-show' to show
+       the pmd usage of an Rx queue over a configurable time period.