suggest memfault in NCS docs

memfault · Apr 24, 2024 · cd9fdf6 · cd9fdf6
1 parent 658f998
commit cd9fdf6
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 2 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,16 @@ 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 Monitoring with Memfault
+*******************************
+
+The nRF Connect SDK includes out-of-the-box metrics collected with Memfault for monitoring Bluetooth connectivity such as connection time and Bluetooth thread stack usage on nRF52 Series SiPs.
+`Memfault`_ is a cloud-based web application with |NCS| compatibility that monitors devices and allows you to debug issues remotely.
+Memfault integration provides the following features to |NCS|:
+
+* `Remote debugging <Memfault debugging_>`_ - Memfault issues can be efficiently resolved with automatic detection, alerts, deduplication, and actionable insights sent through the cloud.
+* `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 :ref:`ug_memfault` page for more information on how to enable Memfault in your |NCS| project with a nRF91 Series SiP.
diff --git a/doc/nrf/device_guides/working_with_nrf/nrf70/features.rst b/doc/nrf/device_guides/working_with_nrf/nrf70/features.rst
@@ -53,3 +53,15 @@ The nRF70 Series devices also support the following functionalities:
 Peer-to-peer support in the form of Wi-Fi Direct® will be available in the future.
 
 See the :ref:`ug_wifi` documentation for more information related to Wi-Fi modes of operation.
+
+Remote Monitoring with Memfault
+*******************************
+
+`Memfault`_ is a cloud-based web application with |NCS| compatibility that monitors devices and allows you to debug issues remotely.
+Memfault integration provides the following features to |NCS|:
+
+* `Remote debugging <Memfault debugging_>`_ - Memfault issues can be efficiently resolved with automatic detection, alerts, deduplication, and actionable insights sent through the cloud.
+* `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 :ref:`ug_memfault` page for more information on how to enable Memfault in your |NCS| project with a nRF70 Series SiP.
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
@@ -190,6 +190,20 @@ For more information on the implementation of a custom trace backend, see :ref:`
 .. _nrf91_fota:
 .. _nrf9160_fota:
 
+Remote Monitoring with Memfault
+*******************************
+
+The nRF Connect SDK includes out-of-the-box metrics collected with Memfault for monitoring LTE connectivity such as total bytes sent and received, the network operator, frequency band, and signal quality measurements.
+`Memfault`_ is a cloud-based web application with |NCS| compatibility that monitors devices and allows you to debug issues remotely.
+Memfault integration provides the following features to |NCS|:
+
+* `Remote debugging <Memfault debugging_>`_ - Memfault issues can be efficiently resolved with automatic detection, alerts, deduplication, and actionable insights sent through the cloud.
+* `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 :ref:`ug_memfault` page for more information on how to enable Memfault in your |NCS| project with a nRF91 Series SiP.
+
+
 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 example coredumps, metrics, and charts 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.
 
+IoT fleet observability
+  The |NCS| provides a integration with :ref:`Memfault <ug_memfault>`, an observability platform for IoT devices with debugging, monitoring, and OTA.
+  In addition to crash reporting, Memfault provides out-of-the-box metrics for Nordic devices with Bluetooth and Cellular connectivity.
+
 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, 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,15 @@ 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 with Memfault
+******************************
+
+To collect coredumps from a remote device that has been deployed to the field, enable :ref:`Memfault <ug_memfault>`.
+Memfault collects device state at the time of a crash for debugging crashes remotely.
+Additionally, you can use Memfault to collect metrics for monitoring device health, including battery life, memory usage, and CPU usage.
+For more information on enabling Memfault for your project, see :ref:`ug_memfault`.
+
 .. _debugging_tools:
 
 Debugging tools