Add options to the script to print out totals at the end of each line, and to print each line replacing the previous one, saving the output scrolling up the screen constantly.
Signed-off-by: Bruce Richardson <[email protected]> Acked-by: Stephen Hemminger <[email protected]> --- doc/guides/tools/telemetrywatcher.rst | 27 +++++++++++++++++++++++++++ usertools/dpdk-telemetry-watcher.py | 27 ++++++++++++++++++++++++++- 2 files changed, 53 insertions(+), 1 deletion(-) diff --git a/doc/guides/tools/telemetrywatcher.rst b/doc/guides/tools/telemetrywatcher.rst index 137a4803b2..3d22818260 100644 --- a/doc/guides/tools/telemetrywatcher.rst +++ b/doc/guides/tools/telemetrywatcher.rst @@ -56,6 +56,15 @@ Options This shows the change in statistics since the last iteration, which is useful for monitoring rates of change. +.. option:: -T, --total + + Display a total column at the end of each row that sums all monitored statistics. + +.. option:: -1, --single-line + + Display output on a single line, replacing the previous output. + This is useful for reducing scrolling and keeping the display compact. + .. option:: stat Statistics to monitor in format ``command.field``. @@ -107,6 +116,24 @@ List all running DPDK applications:: dpdk-telemetry-watcher.py -l +Output Format +------------- + +The tool displays statistics in a tabular format with: + +* **Time column** - Current timestamp (HH:MM:SS) +* **Statistics columns** - One column per specified statistic +* **Total column** - Optional sum of all statistics (when ``-T`` is used) + +Values are formatted with locale-specific number formatting (e.g., comma separators). + +When ``--delta`` mode is enabled, the tool displays the change in each statistic +since the last iteration, which typically represents the rate per second. + +When ``--single-line`` mode is enabled, each new output line replaces the previous one, +similar to tools like ``top``. + + Dependencies ------------ diff --git a/usertools/dpdk-telemetry-watcher.py b/usertools/dpdk-telemetry-watcher.py index 5f4aa05431..e4cd292515 100755 --- a/usertools/dpdk-telemetry-watcher.py +++ b/usertools/dpdk-telemetry-watcher.py @@ -210,10 +210,13 @@ def monitor_stats(process, args): header = "Time".ljust(10) for spec, _, _ in parsed_specs: header += spec.rjust(25) + if args.total: + header += "Total".rjust(25) print(header) # Monitor loop - once per second count = 0 + line_ending = "\r" if args.single_line else "\n" try: while args.timeout is None or count < args.timeout: time.sleep(1) @@ -223,6 +226,7 @@ def monitor_stats(process, args): row = timestamp.ljust(10) current_values = [] + total = 0 for i, (spec, command, field) in enumerate(parsed_specs): data = query_telemetry(process, command) current_value = data[field] @@ -233,11 +237,17 @@ def monitor_stats(process, args): else: display_value = current_value + total += display_value row += str(display_value).rjust(25) - print(row) + if args.total: + row += str(total).rjust(25) + + print(row, end=line_ending, flush=True) prev_values = current_values except KeyboardInterrupt: + if args.single_line: + print() # Add newline before exit message print("\nMonitoring stopped") @@ -282,6 +292,21 @@ def main(): default=False, help="Display delta values instead of absolute values", ) + parser.add_argument( + "-T", + "--total", + action="store_true", + default=False, + help="Display a total column at the end of each row", + ) + parser.add_argument( + "-1", + "--single-line", + action="store_true", + default=False, + dest="single_line", + help="Display output on a single line, replacing the previous output", + ) parser.add_argument( "stats", nargs="*", -- 2.51.0
