From: Sebastien GODARD <sysstat@users.noreply.github.com>
Date: Sat, 29 Oct 2016 15:06:12 +0000 (+0200)
Subject: sar: Add softnet statistics (part 8): Update documentation
X-Git-Tag: v11.5.2~4
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=14d9ccadaf2def1271c7309097de179d28e490a8;p=sysstat

sar: Add softnet statistics (part 8): Update documentation

Update sar's manual page to document softnet metrics.

Signed-off-by: Sebastien GODARD <sysstat@users.noreply.github.com>
---

diff --git a/man/sar.in b/man/sar.in
index b19629c..a71f350 100644
--- a/man/sar.in
+++ b/man/sar.in
@@ -1,4 +1,4 @@
-.TH SAR 1 "JUNE 2016" Linux "Linux User's Manual" -*- nroff -*-
+.TH SAR 1 "OCTOBER 2016" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 sar \- Collect, report, or save system activity information.
 .SH SYNOPSIS
@@ -641,9 +641,10 @@ Possible keywords are
 .BR EIP6 ,
 .BR ICMP6 ,
 .BR EICMP6 ,
-.BR UDP6
+.BR UDP6 ,
+.BR FC
 and
-.BR FC .
+.BR SOFT .
 
 With the
 .B DEV
@@ -1788,6 +1789,44 @@ The total number of transmission words received per second.
 The total number of transmission words transmitted per second.
 .RE
 
+With the
+.B SOFT
+keyword, statistics about software-based network processing are reported.
+The following values are displayed:
+
+.B total/s
+.RS
+The total number of network frames processed per second.
+.RE
+
+.B dropd/s
+.RS
+The total number of network frames dropped per second because there
+was no room on the processing queue.
+.RE
+
+.B squeezd/s
+.RS
+The number of times the softirq handler function terminated per second
+because its budget was consumed or the time limit was reached, but more
+work could have been done.
+.RE
+
+.B rx_rps/s
+.RS
+The number of times the CPU has been woken up per second
+to process packets via an inter-processor interrupt.
+.RE
+
+.B flw_lim/s
+.RS
+The number of times the flow limit has been reached per second.
+Flow limiting is an optional RPS feature that can be used to limit the number of
+packets queued to the backlog for each flow to a certain amount.
+This can help ensure that smaller flows are processed even though
+much larger flows are pushing packets in.
+.RE
+
 The
 .B ALL
 keyword is equivalent to specifying all the keywords above and therefore all the network