docs: add remote observability details

Highlight remote observability features in NCS and how Memfault can be leveraged to implement best practices. Signed-off-by: Gillian Minnehan <[email protected]>
memfault · May 17, 2024 · 8198151 · 8198151
1 parent 658f998
commit 8198151
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 3 deletions.
diff --git a/doc/nrf/device_guides/working_with_nrf/nrf52/features.rst b/doc/nrf/device_guides/working_with_nrf/nrf52/features.rst
@@ -150,3 +150,14 @@ The nRF52 Series devices support running another protocol in parallel with the S
 See the :ref:`ug_multiprotocol_support` user guide on how to enable multiprotocol support for Thread or Zigbee in combination with Bluetooth.
 
 The :ref:`nrfxlib:mpsl` library provides services for multiprotocol applications.
+
+Remote observability using Memfault
+***********************************
+
+The |NCS| bundles support for remotely monitoring and debugging device fleets.
+This support enables quicker identification and triage of issues in the field and optimizes connection quality and battery life for global deployments.
+The collection system has been optimized to work in intermittent connectivity environments and has extremely low overhead.
+
+The |NCS| includes out-of-the-box metrics collected for monitoring Bluetooth connectivity, such as connection time and Bluetooth thread stack usage on nRF52 Series SoCs as well as a GATT profile and example apps for easily sending the data through a mobile phone gateway.
+
+See the :ref:`ug_memfault` page for more information on how to enable Memfault in your |NCS| project on an nRF52 Series device and visualize the data across the fleet and by device.
diff --git a/doc/nrf/device_guides/working_with_nrf/nrf91/nrf91_features.rst b/doc/nrf/device_guides/working_with_nrf/nrf91/nrf91_features.rst
@@ -165,7 +165,6 @@ The :ref:`nrfxlib:nrf_modem` is released as an OS-independent binary library in
 
 The Modem library integration layer fulfills the integration requirements of the Modem library in |NCS|.
 For more information on the integration, see :ref:`nrf_modem_lib_readme`.
-
 .. nrf91_modem_lib_end
 
 .. _modem_trace:
@@ -190,6 +189,23 @@ For more information on the implementation of a custom trace backend, see :ref:`
 .. _nrf91_fota:
 .. _nrf9160_fota:
 
+Remote observability using Memfault
+***********************************
+
+The |NCS| bundles support for remotely monitoring and debugging device fleets.
+This support enables quicker identification and triage of issues in the field, and optimizes connection quality and battery life for global deployments.
+The collection system has been optimized to work in intermittent connectivity environments and has extremely low overhead.
+
+The cellular stack consists of out-of-the-box collection of the following key connectivity health vitals:
+* Total bytes sent and received
+* The network operator
+* Frequency band
+* Signal quality measurements
+
+For debugging, any system crashes and modem traces can be remotely collected for further analysis.
+
+See the :ref:`ug_memfault` page for more information on how to enable Memfault in your |NCS| project on an nRF91 Series SiP to visualize the data across the fleet and by device.
+
 FOTA updates
 ************
 

diff --git a/doc/nrf/external_comp/memfault.rst b/doc/nrf/external_comp/memfault.rst
@@ -15,7 +15,7 @@ Memfault integration provides the following features to |NCS|:
 * `Continuous monitoring <Memfault monitoring_>`_ - Monitors device and fleet-level metrics like connectivity and low power state in real-time dashboards and displays prepopulated metrics for your devices.
   You can access device level data to resolve bugs faster.
 
-See the `Memfault documentation <Memfault introduction_>`_ for more details.
+See the `Memfault sandbox <Memfault Sandbox_>`_ for a self guided tour of the platform as well as the `Memfault documentation <Memfault introduction_>`_ for more details.
 
 .. note::
    Memfault has been integrated in |NCS| since the v1.6.0 release.

diff --git a/doc/nrf/index.rst b/doc/nrf/index.rst
@@ -24,11 +24,15 @@ Robust connectivity support
   The |NCS| supports a wide range of connectivity technologies.
   In addition to connectivity technologies :ref:`provided by Zephyr <zephyr:connectivity>`, such as Bluetooth® Low Energy, IPv6, TCP/IP, UDP, LoRa and LoRaWAN, the |NCS| supports ANT, Bluetooth Mesh, Apple Find My, LTE-M/NB-IoT/GPS, Matter, Amazon Sidewalk, Thread, and Wi-Fi®, among others.
 
+Remote observability
+  The |NCS| provides remote observability support to maintain optimal device performance and reliability in ever-changing device ecosystems after devices are deployed.
+  Once devices are in the field, you can implement device reliability best practices such as remote debug, monitoring, and FOTA support.
+
 Scalable and extensible
   The |NCS| is out-of-tree ready and can be used for projects and applications of all sizes and levels of complexity.
 
 Third-party integrations
-  The |NCS| provides integrations with third-party and Nordic products within the SDK, such as AWS, nRF Cloud, Memfault, and more.
+  The |NCS| provides integrations with third-party and Nordic products within the SDK, such as AWS, nRF Cloud, :ref:`Memfault (Remote Observability) <ug_memfault>` and more.
 
 Varied reference designs
   The |NCS| comes with advanced hardware reference designs for different use cases, ranging from nRF Desktop for Human Interface Devices to nRF5340 Audio for audio devices based on Bluetooth LE Audio specifications.

diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt
@@ -1110,6 +1110,7 @@
 .. _`Memfault MCU Guide`: https://docs.memfault.com/docs/mcu/introduction
 .. _`Memfault: Reboot tracking`: https://docs.memfault.com/docs/mcu/reboot-reason-tracking
 .. _`Memfault: Coredumps`: https://docs.memfault.com/docs/mcu/coredumps
+.. _`Memfault Sandbox`: https://mflt.io/demo
 
 .. ### Source: *.nrfcloud.com
 

diff --git a/doc/nrf/test_and_optimize/debugging.rst b/doc/nrf/test_and_optimize/debugging.rst
@@ -133,6 +133,17 @@ Use the following steps to enable monitor-mode debugging in the |NCS|:
 
 For more information about monitor-mode debugging, see Zephyr's :ref:`zephyr:debugmon` documentation and SEGGER's `Monitor-mode Debugging <Monitor-mode Debugging_>`_ documentation.
 
+
+Remote debugging using Memfault
+*******************************
+
+The |NCS| provides remote observability support to maintain optimal device performance and reliability in ever-changing device ecosystems.
+As you start to rollout a fleet, you can debug and monitor devices remotely.
+
+This functionality allows you to efficiently collect crash information and get the same data from remote devices as you would when using a debugger.
+
+For more information on enabling remote debugging with the |NCS| see :ref:`ug_memfault`.
+
 .. _debugging_tools:
 
 Debugging tools