Quickstart Installer

Memfault provides an installer script for memfaultd designed to enable quickly testing Memfault on a running Linux system without significant code or configuration changes.

Upon successful completion of the script, memfaultd will be running on the device and metrics and logs from it will be visible in the Memfault app.

note

This installer script is intended to be used for evaluation purposes. As it downloads memfaultd release binaries hosted by Memfault, it is not a recommended tool for installing memfaultd across your fleet at scale.

Create a Memfault Project

Go to app.memfault.com and from the "Select a Project" dropdown, click on "Create Project". Once you're done, you can find a Project Key, referenced as YOUR_PROJECT_KEY in this document, in the Project settings page.

Running the script

In a shell on the device, run the following command (replacing YOUR_PROJECT_KEY with the Memfault Project Key from the previous step).

curl -sSf https://app.memfault.com/static/scripts/linux-quickstart.sh | MEMFAULT_PROJECT_KEY=YOUR_PROJECT_KEY sh

Since this script installs memfaultd in the rootfs, the filesystem must be mounted as read-write.

Viewing Device Data in Memfault

You can view data from your device by navigating to Fleet → Devices in your Memfault project and selecting it from the list.

The installer script will trigger a sync upon completion and memfaultd will upload data to Memfault on an hourly interval thereafter.

The script will install a default configuration file at /etc/memfaultd.conf. See Reference: memfaultd Configuration for a full list of configuration options.

tip

memfaultd will use /etc/machine-id as the Device ID by default and populate the Hardware Version, Software Version, and Software Type automatically with values from /etc/os-release. These default values can be overridden via the memfault-device-info script.