From 9bc152dd251cfdf3b975dbf1c0fa411bc9dea3c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= Date: Mon, 27 May 2024 15:03:18 +0200 Subject: [PATCH 1/3] Document TCP4Clients/TCP6Clients Commit abc47f5ce4a50ab2d3b23505914e9c65f856262b added two new statistics counters without documenting them. Add the missing counter descriptions to the ARM. (cherry picked from commit cb7924009152a4b8b1ec82a50bdb112541e9ec74) --- doc/arm/reference.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index cf1ba1b12c..9b14b0cf00 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -8404,3 +8404,6 @@ exceptions are noted in the descriptions. ``RecvErr`` This indicates the number of errors in socket receive operations, including errors of send operations on a connected UDP socket, notified by an ICMP error message. + +``TCP4Clients``/``TCP6Clients`` + This indicates the number of IPv4/IPv6 clients currently connected over TCP. From 3be2d25e54286a284e00d1d033e79c25478bc84a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ayd=C4=B1n=20Mercan?= Date: Fri, 31 May 2024 18:12:08 +0300 Subject: [PATCH 2/3] alphabetically sort socket i/o counters --- doc/arm/reference.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 9b14b0cf00..bb4d90d0d8 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -8375,35 +8375,35 @@ Socket I/O statistics counters are defined per socket type, which are a socket type. Not all counters are available for all socket types; exceptions are noted in the descriptions. -``Open`` - This indicates the number of sockets opened successfully. +``Accept`` + This indicates the number of incoming connections successfully accepted. This counter does not apply to the ``UDP`` type. -``OpenFail`` - This indicates the number of failures to open sockets. - -``Close`` - This indicates the number of closed sockets. +``AcceptFail`` + This indicates the number of failures to accept incoming connection requests. This counter does not apply to the ``UDP`` type. ``BindFail`` This indicates the number of failures to bind sockets. +``Close`` + This indicates the number of closed sockets. + ``ConnFail`` This indicates the number of failures to connect sockets. ``Conn`` This indicates the number of connections established successfully. -``AcceptFail`` - This indicates the number of failures to accept incoming connection requests. This counter does not apply to the ``UDP`` type. +``Open`` + This indicates the number of sockets opened successfully. -``Accept`` - This indicates the number of incoming connections successfully accepted. This counter does not apply to the ``UDP`` type. - -``SendErr`` - This indicates the number of errors in socket send operations. +``OpenFail`` + This indicates the number of failures to open sockets. ``RecvErr`` This indicates the number of errors in socket receive operations, including errors of send operations on a connected UDP socket, notified by an ICMP error message. +``SendErr`` + This indicates the number of errors in socket send operations. + ``TCP4Clients``/``TCP6Clients`` This indicates the number of IPv4/IPv6 clients currently connected over TCP. From c62b6c82c0dc10c90a29890c5e32c701811a2bba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ayd=C4=B1n=20Mercan?= Date: Fri, 31 May 2024 18:14:31 +0300 Subject: [PATCH 3/3] make the tcp client counter documentation consistent with others --- doc/arm/reference.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index bb4d90d0d8..4519d20944 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -8384,6 +8384,9 @@ exceptions are noted in the descriptions. ``BindFail`` This indicates the number of failures to bind sockets. +``Clients`` + This indicates the number of currently conencted clients. This counter does not apply to the ``UDP`` type. + ``Close`` This indicates the number of closed sockets. @@ -8404,6 +8407,3 @@ exceptions are noted in the descriptions. ``SendErr`` This indicates the number of errors in socket send operations. - -``TCP4Clients``/``TCP6Clients`` - This indicates the number of IPv4/IPv6 clients currently connected over TCP.