Skip to main content

Introduction

Ship hardware products at the speed of software. With Memfault, you can continuously monitor devices, debug firmware issues, and deploy OTA updates to your fleet.

Overview

The Memfault Linux SDK consists of a combination of existing open-source software and a daemon memfaultd that orchestrates and configures it. It also implements additional features such as tracking of reboot reason tracking, and in the future reporting crashes and logs.

Overview of the Memfault Linux SDK
Dotted lines represent runtime configuration, and solid lines represent flow of data. Faded-out elements represent upcoming features.

To provide core Memfault platform features, the Memfault Linux SDK relies on well-established, battle-tested open-source software. The daemon memfaultd implements Memfault-specific features and also acts as a configuration agent.

Prerequisites

Even though support for a broader diversity of setups is planned, this first versions of our SDK makes the following assumptions:

  • Your project uses Yocto as a build system.
  • It uses systemd as an init system.
  • It uses SWUpdate for OTA (optional if you don't plan to integrate with OTA).
  • It uses collectd for metrics (optional if you don't plan to integrate with Metrics).

If your project diverges from these assumptions, please get in touch. It will likely still work without major changes.

Getting Started

Take a look at our getting-started guide to set up your integration.

Documentation and Features

  • Detailed documentation for the Memfault Linux SDK can be found in our online docs: see the getting-started guide.
  • Visit our features overview for a generic introduction to all the major features of the Memfault platform.

An integration example can be found under /meta-memfault-example. The central part of the SDK lives in a Yocto layer in /meta-memfault.

OTA Updates

To provide OTA Updates, the Memfault Cloud implements an API endpoint compatible with the hawkBit DDI API. Various clients are available, but memfaultd supports SWUpdate out of the box and is able to configure it to talk to our hawkBit DDI-compatible endpoint.

Metrics

Use metrics and diagnostic data to measure the success of software updates (OTA) and to proactively diagnose anomalies before users even experience their effect. The SDK ships with a configurable set of plugins for collectd to obtain standard KPIs at the operating system level (e.g. available storage or RAM, CPU utilization, or network status and traffic). You can also use the SDK to collect product-specific custom metrics via statsd.

Crash Reports

Collect coredumps and automatically upload them to the Memfault platform. Use Memfault's rich backtrace and trace analysis view in order to debug issues and keep your fleet's crashes under control. Make use of Memfault's deduplication features as well as advanced Issue management and monitoring.

Reboot Reason Tracking

The Reboot Reason Tracking feature allows one to collect why devices are rebooting in the field (whether it be due to a crash, kernel panic or a firmware update). Summaries and aggregates can then be viewed from the Memfault web application.

These features are fully in the domain of memfaultd.

Get started

Take a look at our getting-started guide to set up your integration.