From f93e19276e1874dd0e89a88801019da72c51a455 Mon Sep 17 00:00:00 2001 From: Jukka Rissanen Date: Mon, 12 Aug 2024 10:45:06 +0300 Subject: [PATCH] doc: tracing: net: Add information for network tracing Add a simple documentation page that describes the network tracing support. Signed-off-by: Jukka Rissanen --- doc/connectivity/networking/index.rst | 1 + .../networking/network_tracing.rst | 26 +++++++++++++++++++ doc/services/tracing/index.rst | 10 +++++++ 3 files changed, 37 insertions(+) create mode 100644 doc/connectivity/networking/network_tracing.rst diff --git a/doc/connectivity/networking/index.rst b/doc/connectivity/networking/index.rst index 26dfbb141472..2a34c1330eca 100644 --- a/doc/connectivity/networking/index.rst +++ b/doc/connectivity/networking/index.rst @@ -15,5 +15,6 @@ operation of the stacks and how they were implemented. net_config_guide.rst networking_with_host.rst network_monitoring.rst + network_tracing.rst api/index.rst conn_mgr/index.rst diff --git a/doc/connectivity/networking/network_tracing.rst b/doc/connectivity/networking/network_tracing.rst new file mode 100644 index 000000000000..d3655ee037c2 --- /dev/null +++ b/doc/connectivity/networking/network_tracing.rst @@ -0,0 +1,26 @@ +.. _network_tracing: + +Network Tracing +############### + +.. contents:: + :local: + :depth: 2 + +User can enable network core stack and socket API calls tracing. + +The :kconfig:option:`CONFIG_TRACING_NET_CORE` option contols the core network +stack tracing. This option is enabled by default if tracing and networking +are enabled. The system will start to collect the receiving and sending call +verdicts i.e., whether the network packet was successfully sent or received. +It will also collect packet sending or receiving timings i.e., how long +it took to deliver the network packet, and the network interface, priority +and traffic class used. + +The :kconfig:option:`CONFIG_TRACING_NET_SOCKETS` option can be used to track +BSD socket call usage in the system. It is enabled if tracing and BSD socket +API support are enabled. The system will start to collect what BSD socket +API calls are made and what parameters the API calls are using and returning. + +See the :ref:`tracing documentation ` for how to use the tracing +service. diff --git a/doc/services/tracing/index.rst b/doc/services/tracing/index.rst index bc0b938fc2f9..51ed14e5e5b0 100644 --- a/doc/services/tracing/index.rst +++ b/doc/services/tracing/index.rst @@ -740,3 +740,13 @@ Syscalls ======== .. doxygengroup:: subsys_tracing_apis_syscall + +Network tracing +=============== + +.. doxygengroup:: subsys_tracing_apis_net + +Network socket tracing +====================== + +.. doxygengroup:: subsys_tracing_apis_socket