diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/man/kxdpgun.8 (renamed from doc/man/kxdpgun.8in) | 31 |
1 files changed, 26 insertions, 5 deletions
diff --git a/doc/man/kxdpgun.8in b/doc/man/kxdpgun.8 index f93872b..d7892eb 100644 --- a/doc/man/kxdpgun.8in +++ b/doc/man/kxdpgun.8 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "KXDPGUN" "8" "@RELEASE_DATE@" "@VERSION@" "Knot DNS" +.TH "KXDPGUN" "8" "2024-09-02" "3.4.0" "Knot DNS" .SH NAME kxdpgun \- XDP-powered DNS benchmarking tool .SH SYNOPSIS @@ -47,10 +47,10 @@ configured for the network interface. .SS Parameters .INDENT 0.0 .TP -\fIfilename\fP +.B \fIfilename\fP Path to the queries file. See the description below regarding the file format. .TP -\fItarget\fP +.B \fItarget\fP Either the domain name, IPv4 or IPv6 address of a remote target. .UNINDENT .SS Options @@ -90,6 +90,11 @@ CPU ID increment for next thread (default is 0s1). \fB\-i\fP, \fB\-\-infile\fP \fIfilename\fP Path to a file with query templates. .TP +\fB\-B\fP, \fB\-\-binary\fP +Specify that input file is in binary format. This format is similar to the +TCP DNS message format. The file contains records formated as 2\-octet length +(network order) followed by a message in DNS wire format. +.TP \fB\-I\fP, \fB\-\-interface\fP \fIinterface\fP Network interface for outgoing communication. This can be useful in situations when the interfaces are in a bond for example. @@ -136,11 +141,20 @@ has to exist. This option is ignored if not in the QUIC mode. The recommended usage is with \fB\-\-quic=R\fP or with low QPS. Otherwise, too many files are generated. .TP +\fB\-j\fP, \fB\-\-json\fP +Print statistics formatted as json. +.TP +\fB\-S\fP, \fB\-\-stats\-period\fP \fIperiod\fP +Report statistics automatically every \fIperiod\fP milliseconds. +.sp +These reports contain only metrics collected in the given period. +.TP \fB\-h\fP, \fB\-\-help\fP Print the program help. .TP \fB\-V\fP, \fB\-\-version\fP -Print the program version. +Print the program version. The option \fB\-VV\fP makes the program +print the compile time configuration summary. .UNINDENT .SS Queries file format .sp @@ -187,7 +201,8 @@ Instead of opening a connection for each query, reuse connections. .SS Signals .sp Sending USR1 signal to a running process triggers current statistics dump -to the standard output. +to the standard output. In combination with \fB\-S\fP may cause erratic printout +timing. .SH NOTES .sp Linux kernel 4.18+ is required. @@ -197,6 +212,12 @@ CAP_NET_RAW, CAP_NET_ADMIN, CAP_SYS_ADMIN, CAP_IPC_LOCK, and CAP_SYS_RESOURCE (Linux < 5.11). .sp The utility allocates source UDP/TCP ports from the range 2000\-65535. +.sp +Due to the multi\-threaded program structure there are slight discrepancies in +the timespan during which metrics are collected for any given thread. The +statistics printouts ignore this and are thus ever\-so\-slightly inaccurate. The +error margin decreases proportionally to the volume of data & timespan over +which they are collected. .SH EXIT VALUES .sp Exit status of 0 means successful operation. Any other exit status indicates |