Skip to content

Commit 0d059f8

Browse files
committed
docs: Add more information on Memfault use
Add some more information on Memfault use in the troubleshooting section of the docs. Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>
1 parent b0c75a1 commit 0d059f8

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

docs/common/tooling_troubleshooting.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ For more knowledge on debugging and troubleshooting [nRF Connect SDK](https://gi
2727
- [Hardfaults](#hardfaults)
2828
- [State Inspection Script](#state-inspection-script)
2929
- [Memfault Remote Debugging](#memfault-remote-debugging)
30-
- [Recommended Prerequisites](#recommended-prerequisites)
30+
- [When to Use Memfault](#when-to-use-memfault)
31+
- [Prerequisites](#prerequisites)
3132
- [Test shell commands](#test-shell-commands)
3233
- [Modem Tracing](#modem-tracing)
3334
- [UART Tracing](#uart-tracing)
@@ -467,7 +468,46 @@ For more information see the following documenation:
467468
- [Memfault Sample](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/debug/memfault/README.html)
468469
- [Memfault Integration](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/debug/memfault_ncs.html)
469470
470-
### Recommended Prerequisites
471+
### When to Use Memfault
472+
473+
Memfault is a device observability platform that complements traditional debugging tools by providing remote diagnostics and fleet-wide insights. It is particularly valuable in the following scenarios:
474+
475+
**Field debugging:**
476+
477+
- Capture crashes and diagnostics from devices deployed in remote locations where physical access is limited or impossible
478+
- Investigate issues that only occur in production environments with real network conditions
479+
480+
**Intermittent issues:**
481+
482+
- Debug problems that occur sporadically and are difficult to reproduce in a development environment
483+
- Collect crash data over time to identify patterns and root causes
484+
485+
**Fleet monitoring:**
486+
487+
- Track device health metrics across multiple deployed units
488+
- Identify systemic issues affecting specific firmware versions, hardware batches, or network configurations
489+
- Monitor LTE connectivity metrics, stack usage, and memory statistics across your device fleet
490+
491+
**Post-mortem analysis:**
492+
493+
- Analyze crashes after they occur without requiring device physical access or live debugging sessions
494+
- Capture full coredumps with register state, stack traces, and memory contents
495+
- Include modem traces for in-depth cellular connectivity analysis
496+
497+
**Use Memfault alongside other debugging tools:**
498+
499+
- **GDB**: Use for interactive development debugging with breakpoints and step-through execution
500+
- **Crash analysis**: Use for immediate crash investigation during development with serial connection
501+
- **Memfault**: Use for remote, asynchronous crash collection, fleet-wide analysis, and field diagnostics
502+
503+
**Symbol file management:**
504+
505+
- Upload symbol files for each firmware version you deploy
506+
- The CI pipeline automatically uploads symbols for release builds
507+
- For local development builds, manually upload using the `memfault` CLI tool
508+
- Symbol files enable Memfault to decode crash addresses into meaningful function names and line numbers
509+
510+
### Prerequisites
471511
472512
1. Register at [Memfault](https://app.memfault.com/register-nordic)
473513
2. Complete the [Remote Debugging with Memfault](https://academy.nordicsemi.com/courses/nrf-connect-sdk-intermediate/lessons/lesson-2-debugging/topic/exercise-4-remote-debugging-with-memfault/) exercise.

0 commit comments

Comments
 (0)