Skip to content

Commit ca2ea0d

Browse files
Damian-Nordicrlubos
authored andcommitted
doc: add logging over RPC documentation
Add RST file that describes logging RPC library. Signed-off-by: Damian Krolik <[email protected]>
1 parent 1e0c098 commit ca2ea0d

File tree

3 files changed

+65
-1
lines changed

3 files changed

+65
-1
lines changed

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@
207207
/doc/nrf/libraries/others/flash_map_pm.rst @nrfconnect/ncs-pluto-doc
208208
/doc/nrf/libraries/others/hw_id.rst @nrfconnect/ncs-cia-doc
209209
/doc/nrf/libraries/others/index.rst @nrfconnect/ncs-doc-leads
210+
/doc/nrf/libraries/others/log_rpc.rst @nrfconnect/ncs-terahertz-doc
210211
/doc/nrf/libraries/others/network_core_monitor.rst @nrfconnect/ncs-si-muffin-doc
211212
/doc/nrf/libraries/others/nrf_compression.rst @nrfconnect/ncs-vestavind-doc
212213
/doc/nrf/libraries/others/nrf_profiler.rst @nrfconnect/ncs-si-bluebagel-doc
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
.. _log_rpc:
2+
3+
Logging Remote Procedure Call
4+
#############################
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
The Logging Remote Procedure Call (RPC) library enables receiving and managing log messages from a remote device or processor.
11+
12+
Overview
13+
********
14+
15+
The library supports the following main features:
16+
17+
* Log streaming, which allows for receiving log messages over RPC in real-time as they are generated by the remote device.
18+
* Log history, which allows for saving log messages in a ring buffer in RAM or persistent memory, and retrieving them over RPC when needed.
19+
20+
The library also supports retrieving a core dump stored in the remote device's memory, and setting the current time used for log timestamping.
21+
22+
Implementation
23+
==============
24+
25+
The logging RPC consists of the following components:
26+
27+
* Zephyr's :ref:`zephyr:logging_api` backend that implements sending log messages using :ref:`nrf_rpc`.
28+
It also accepts RPC commands for managing the logging backend.
29+
* A log forwarder, which implements receiving log messages from a remote device and passing them to the local logging subsystem.
30+
It also implements RPC commands for managing the logging backend on the remote device.
31+
32+
Configuration
33+
*************
34+
35+
To enable the logging RPC backend, set the :kconfig:option:`CONFIG_LOG_BACKEND_RPC` Kconfig option.
36+
37+
To enable the logging RPC forwarder, set the :kconfig:option:`CONFIG_LOG_FORWARDER_RPC` Kconfig option.
38+
39+
Samples using the library
40+
*************************
41+
42+
The following |NCS| samples use this library:
43+
44+
* :ref:`nrf_rpc_protocols_serialization_client`
45+
* :ref:`nrf_rpc_protocols_serialization_server`
46+
47+
Dependencies
48+
************
49+
50+
The library has the following dependencies:
51+
52+
* :ref:`nrf_rpc`
53+
* :ref:`zephyr:logging_api`
54+
55+
.. _log_rpc_api:
56+
57+
API documentation
58+
*****************
59+
60+
| Header file: :file:`include/logging/log_rpc.h`
61+
| Source files: :file:`subsys/logging`
62+
63+
.. doxygengroup:: log_rpc

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -717,4 +717,4 @@ cJSON
717717
Documentation
718718
=============
719719

720-
|no_changes_yet_note|
720+
* Added the :ref:`log_rpc` library documentation page.

0 commit comments

Comments
 (0)