Memfault

https://docs.memfault.com
Admin
Memfault is a device-centric fleet observability and OTA platform for monitoring and debugging...
Tokens:766,034
Snippets:6,770
Trust Score:9.3
Update:5 days ago
Show doc for...
Tokens:
Raw
### Install Quickstart APK on Windows

Source: https://docs.memfault.com/docs/android/bort-lite

Run the install script on Windows Command Prompt. Replace <project-key> with your Memfault project key.

```batch
install-bort-lite.bat <project-key>
```

--------------------------------

### Run the Memfault quickstart installer script

Source: https://docs.memfault.com/docs/linux/quickstart-installer

Execute this command in a shell on your device to install memfaultd. Replace YOUR_PROJECT_KEY with the key from your Memfault project settings. The filesystem must be mounted as read-write for the installation to succeed.

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

--------------------------------

### Install Quickstart APK on macOS

Source: https://docs.memfault.com/docs/android/bort-lite

Run the install script on macOS. Replace <project-key> with your Memfault project key and optionally use -s to specify a custom device identifier.

```bash
./install-bort-lite.sh -k <project-key> -s <device-identifier>
```

--------------------------------

### SemVer 2.0 Build Metadata Example

Source: https://docs.memfault.com/docs/platform/software-version-hardware-version

Example of a version number with appended build metadata.

```text
1.0.0+092ced197518c8e304232239315c611af6ff2404
```

--------------------------------

### Example output of memfault-device-info

Source: https://docs.memfault.com/docs/linux/reference-memfault-device-info

A concrete example of the expected output format for the device identifier and hardware version.

```text
MEMFAULT_DEVICE_ID=1234-example-serial

MEMFAULT_HARDWARE_VERSION=thingy-evt2
```

--------------------------------

### GET /api/v0/organizations/:organization_slug/projects/:project_slug/installs

Source: https://docs.memfault.com/api/list-installs

Lists all installs for a given project. This endpoint returns a list of Install Schemas.

```APIDOC
## GET /api/v0/organizations/:organization_slug/projects/:project_slug/installs

### Description
List all Installs for a given Project.

### Method
GET

### Endpoint
/api/v0/organizations/:organization_slug/projects/:project_slug/installs

### Parameters
#### Path Parameters
- **organization_slug** (string) - Required - The slug of the organization.
- **project_slug** (string) - Required - The slug of the project.

### Response
#### Success Response (200)
Returns a list of Install Schemas.

```

--------------------------------

### GET /api/v0/organizations/:organization_slug/projects/:project_slug/installs/:install_id

Source: https://docs.memfault.com/api/retrieve-an-install

Retrieves a single Install for the specified organization and project. The response contains the Install schema.

```APIDOC
## GET /api/v0/organizations/:organization_slug/projects/:project_slug/installs/:install_id

### Description
Retrieve a single Install.

### Method
GET

### Endpoint
/api/v0/organizations/:organization_slug/projects/:project_slug/installs/:install_id

### Parameters
#### Path Parameters
- **organization_slug** (string) - Required - The slug of the organization.
- **project_slug** (string) - Required - The slug of the project.
- **install_id** (string) - Required - The ID of the install to retrieve.

### Response
#### Success Response (200)
Returns an Install schema.

```

--------------------------------

### Run the image with QEMU

Source: https://docs.memfault.com/docs/linux/qemu-example

Use the provided shortcut to start the QEMU emulator and boot the built image.

```bash
$ q # Run image in QEMU

// Linux boots



login: root
```

--------------------------------

### Example kernel build .config path

Source: https://docs.memfault.com/docs/linux/coredumps

Example path to the kernel build configuration file to verify kernel options are enabled.

```text
tmp/work/raspberrypi3-poky-linux/linux-yocto/5.15.62+gitAUTOINC+59c8898d45_7cb30c5e95-r0/linux-raspberrypi3-standard-build/.config
```

--------------------------------

### Example Test Start Output

Source: https://docs.memfault.com/docs/mcu/self-test

Expected output when starting the Reboot Reason test. It informs that the device will reboot and that the reboot_verify argument should be run after reboot.

```text
MFLT:[INFO] =============================

MFLT:[INFO] Reboot Reason Test

MFLT:[INFO] =============================

MFLT:[INFO] This test will now reboot the device to test reboot reason tracking

MFLT:[INFO] After the device reboots, please run with reboot_verify argument

MFLT:[INFO] =============================
```

--------------------------------

### Run the Server

Source: https://docs.memfault.com/docs/legacy-nrfcloud/receiving-messages

Start the webhook server.

```bash
node server.js
```

--------------------------------

### GET /proxy

Source: https://docs.memfault.com/docs/legacy-nrfcloud/coap-endpoints

Download files over COAP instead of HTTP (for example, firmware binaries). Set the full URL to the proxyUri request option, including the protocol.

```APIDOC
## GET /proxy

### Description
Download files over COAP instead of HTTP (for example, firmware binaries). Set the full URL to the `proxyUri` request option, including the protocol. Proxying is limited to the following hosts: https://pgps.nrfcloud.com, https://firmware.nrfcloud.com, https://static.api.nrfcloud.com, https://bundles.nrfcloud.com. The default block size is 1024, but can be defined in the CoAP request block size option.

### Method
GET

### Endpoint
/proxy

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - Number of bytes from the start of the file to skip before beginning block transfer; defaults to 0.

### Request Example
```
coap send --proxy-uri https://pgps.nrfcloud.com/public/16096-14400.bin GET "coaps://coap.nrfcloud.com/proxy" > 16096-14400.bin
```

```
coap send -b 512 --proxy-uri https://pgps.nrfcloud.com/public/16096-14400.bin GET "coaps://coap.nrfcloud.com/proxy" > 16096-14400.bin
```

```
coap send --proxy-uri https://firmware.nrfcloud.com/e07f25b0-a92b-4043-af5e-d556700daeee/APP9ad65d992.6.99/app_update.bin GET "coaps:///coap.nrfcloud.com/proxy?offset=10475760" > app_update-remainder.bin
```

### Response
Returns the requested file content.

```

--------------------------------

### Build and Flash via Command Line

Source: https://docs.memfault.com/docs/mcu/quickstart-bluetooth

Use the west tool to build the firmware with sysbuild enabled and flash it to the connected device.

```bash
west build --sysbuild --pristine=always --board nrf5340dk/nrf5340/cpuapp nrf/samples/bluetooth/peripheral_mds

west flash --erase
```

--------------------------------

### Example ARM Cortex-A/R vector table with Memfault fault handlers

Source: https://docs.memfault.com/docs/mcu/arm-cortex-r-guide

Assembly code for an interrupt vector table that installs the Memfault fault handlers (UndefinedInstruction_Handler, DataAbort_Handler, PrefetchAbort_Handler) into the exception vectors. This is used to integrate Memfault fault handling on ARMv7-A/R devices.

```assembly
/*-------------------------------------------------------------------------------*/

@ import reference for interrupt routines



    .extern _c_int00

    .extern phantomInterrupt

    .weak resetEntry



    @ Memfault Fault Handlers used in the interrupt vector table below

    .extern UndefinedInstruction_Handler

    .extern DataAbort_Handler

    .extern PrefetchAbort_Handler



/*-------------------------------------------------------------------------------*/

@ interrupt vectors



resetEntry:

        ldr pc, =_c_int00

        ldr pc, =UndefinedInstruction_Handler  /* Memfault handler */

svcEntry:

        b   svcEntry

        ldr pc, =PrefetchAbort_Handler  /* Memfault handler */

        ldr pc, =DataAbort_Handler  /* Memfault handler */

        b   phantomInterrupt

        ldr pc,[pc,#-0x1b0]

        ldr pc,[pc,#-0x1b0]
```

--------------------------------

### Create and run the Docker container

Source: https://docs.memfault.com/docs/linux/qemu-example

Navigate to the docker directory and start the container with your project key.

```bash
$ cd /path/to/memfault-linux-sdk/docker

$ MEMFAULT_PROJECT_KEY=<YOUR_PROJECT_KEY> ./run.sh -b
```

--------------------------------

### memfault_platform_port.c: Battery metrics platform dependency

Source: https://docs.memfault.com/docs/platform/memfault-core-metrics?platform=MCU

Placeholder battery driver functions and the required Memfault platform function. The battery_* functions are examples to be replaced with your own driver. The charge-state-change callback is edge-triggered and calls memfault_metrics_battery_stopped_discharging() when charging starts. memfault_platform_get_stateofcharge() is called by the SDK at each Heartbeat interval end and returns the state-of-charge scaled by 100f to match MEMFAULT_METRICS_BATTERY_SOC_PCT_SCALE_VALUE.

```c
// The following battery_* functions are placeholders for your own battery  
// driver. Replace them with the equivalent calls for your hardware.  
  
// note: tracking battery state via a static variable is not required. It is  
// added here to demonstrate that a charge-state-change callback is  
// edge-triggered  
static bool s_battery_is_discharging = false;  
  
// Example: called once on system initialization, to record the initial  
// discharging state  
void battery_set_initial_discharging_state(void) {  
  s_battery_is_discharging = battery_is_discharging();  
}  
  
// Example: called by your battery driver when the discharging state changes,  
// i.e.: CHARGING → DISCHARGING or DISCHARGING → CHARGING  
void battery_charge_state_changed_callback(void) {  
  const bool discharging = battery_is_discharging();  
  if (discharging != s_battery_is_discharging) {  
    // update the state of the battery  
    s_battery_is_discharging = discharging;  
  
    if(!discharging) {  
      // signal the Memfault SDK that the battery has stopped discharging  
      memfault_metrics_battery_stopped_discharging();  
    }  
  }  
}  
  
// Required Memfault platform dependency: called by the Memfault SDK at each  
// Heartbeat interval end, to get the current battery state-of-charge and  
// discharging state.  
int memfault_platform_get_stateofcharge(sMfltPlatformBatterySoc *soc) {  
  float soc_percentage;  
  
  // get the battery level  
  int err = battery_get_soc_percent(&soc_percentage);  
  if (err) {  
    MEMFAULT_LOG_ERROR("Failed to get battery level: %d", err);  
    return -1;  
  }  
  
  // for rechargeable batteries, check if the battery is discharging (i.e. not  
  // charging)  
  const bool discharging = battery_is_discharging();  
  
  // set the output data  
  *soc = (sMfltPlatformBatterySoc){  
    // scale up the floating-point percentage to be an integer with 2 decimal  
    // places of precision, matching the selection of MEMFAULT_METRICS_BATTERY_SOC_PCT_SCALE_VALUE  
    .soc = soc_percentage * 100f,  
    .discharging = discharging,  
  };  
  return 0;  
}  
```

--------------------------------

### Verify Memfault Startup Output

Source: https://docs.memfault.com/docs/mcu/arm-nxp-mcuxpresso-guide

Example of the expected startup text in the serial console after successful initialization.

```text
[I] MFLT: GNU Build ID: 63a58c3567c22fd6786adbc4cc186d258e66efe7

[I] MFLT: S/N: DEMOSERIAL

[I] MFLT: SW type: app-fw

[I] MFLT: SW version: 1.0.0

[I] MFLT: HW version: dvt1

[I] MFLT: Memfault Initialized!
```

--------------------------------

### Delete an Install

Source: https://docs.memfault.com/llms.txt

Deletes a single Install.

```APIDOC
## Delete an Install

### Description
Deletes a single Install.

### Endpoint
/api/delete-an-install.md
```

--------------------------------

### List Installs

Source: https://docs.memfault.com/llms.txt

Lists all Installs for a given Project.

```APIDOC
## List Installs

### Description
Lists all Installs for a given Project.

### Endpoint
/api/list-installs.md
```

--------------------------------

### Verify Memfault Console Output

Source: https://docs.memfault.com/docs/mcu/quickstart-esp32

Example output showing device info at boot and the available Memfault console commands.

```text
I (694) mflt: Memfault Build ID: 4115098dbf8ea90c802ae21b2e757e033866bd1b

I (704) mflt: S/N: C4DEE25A6118

I (704) mflt: SW type: esp32-main

I (704) mflt: SW version: 1.0.0-dev

Memfault provides some default console commands. Check for their availability withhelp

esp32> help

assert  assert type

  Trigger an assert; optional arg of 1=assert(), 2=MEMFAULT_ASSERT(),

  3=ESP_ERROR_CHECK(-1)



crash  crash type

  Trigger a crash



esp_crash

  Trigger a timer isr crash



leak

  Allocate the specified number of bytes without freeing



test_log

  Writes test logs to log buffer



trigger_logs

  Trigger capture of current log buffer contents

...
```

--------------------------------

### Build and Verify Application

Source: https://docs.memfault.com/docs/mcu/quickstart-esp32

Commands to reset the build state, set the target, build the application, and flash/monitor the device.

```bash
rm sdkconfig && idf.py set-target <your_esp32_target>
```

```bash
idf.py build
```

```bash
idf.py flash monitor
```

--------------------------------

### Install Dependencies

Source: https://docs.memfault.com/docs/legacy-nrfcloud/receiving-messages

Install the required Node.js packages.

```bash
npm i
```

--------------------------------

### Get Task Status

Source: https://docs.memfault.com/llms.txt

Gets the status of the given Task.

```APIDOC
## Get Task Status

### Description
Gets the status of the given Task.

### Endpoint
/api/get-task-status.md
```

--------------------------------

### Example Memfault CLI boot output

Source: https://docs.memfault.com/docs/mcu/arm-infineon-modustoolbox-guide

Expected console output upon successful initialization of the Memfault CLI.

```text
[I] Memfault Build ID: 7726fbc695f4c50db091746118ad69468e152341

[I] S/N: DEMOSERIAL

[I] SW type: app-fw

[I] SW version: 1.0.0-dev

[I] HW version: dvt1

[I] Reset Reason, Cy_SysLib_GetResetReason=0x10

[I] Reset Cause:

[I]  Software Reset

[I] Memfault Initialized!



mflt>

mflt>

help>

clear_core: Clear an existing coredump

drain_chunks: Flushes queued Memfault data. To upload data see https://mflt.io/posting-chunks-with-gdb

export: Export base64-encoded chunks. To upload data see https://mflt.io/chunk-data-export

get_core: Get coredump info

get_device_info: Get device info

test_assert: Trigger memfault assert

test_busfault: Trigger a busfault

test_hardfault: Trigger a hardfault

test_memmanage: Trigger a memory management fault

test_usagefault: Trigger a usage fault

test_log: Writes test logs to log buffer

test_log_capture: Trigger capture of current log buffer contents

test_reboot: Force system reset and track it with a Trace Event

test_trace: Capture an example Trace Event

help: Lists all commands
```

--------------------------------

### Install Memfault Dependencies

Source: https://docs.memfault.com/docs/mcu/platformio-esp-idf-guide

Install the required Python packages for Memfault integration.

```bash
pip install -r third-party/memfault-firmware-sdk/requirements.txt

pip install memfault-cli

pip install mflt_build_id
```

--------------------------------

### memfault post-chunk --help output and usage examples

Source: https://docs.memfault.com/changelog/2020/07/31

Shows the help output for the memfault post-chunk command and four usage examples for sending chunks encoded as hex string, base64 string, binary file, or memfault-firmware-sdk data export.

```bash
$  memfault post-chunk --help  

  Usage: memfault post-chunk [OPTIONS] DATA  

  

  Sends data generated by the memfault-firmware-sdk ("chunks") to the  

  Memfault cloud.  

  

  The command can operate on binary data encoded in the following formats:  

  

  1. Hex String:  

    memfault --project-key ${YOUR_PROJECT_KEY} post-chunk --encoding hex 0802a702010301076a5445535453455249414c0a6d746573742d736f667477617265096a312e302e302d74657374066d746573742d686172647761726504a101a1726368756e6b5f746573745f737563636573730131e4  

  

  1. Base64 Encoded String  

    memfault --project-key ${YOUR_PROJECT_KEY} post-chunk --encoding base64 CAKnAgEDAQdqVEVTVFNFUklBTAptdGVzdC1zb2Z0d2FyZQlqMS4wLjAtdGVzdAZtdGVzdC1oYXJkd2FyZQShAaFyY2h1bmtfdGVzdF9zdWNjZXNzATHk  

  

  1. Binary File  

    memfault --project-key ${YOUR_PROJECT_KEY} post-chunk --encoding bin chunk_v2_single_chunk_msg.bin  

  

  1. memfault-firmware-sdk data export  

    memfault --project-key ${YOUR_PROJECT_KEY} post-chunk --encoding sdk_data_export data_export.txt  


```

--------------------------------

### Generate a sample project using project-creator-cli

Source: https://docs.memfault.com/docs/mcu/arm-infineon-modustoolbox-guide

Use the project-creator-cli binary to generate a sample application from the ModusToolbox™ SDK.

```bash
project-creator-cli --board-id CY8CKIT-062S2-43012 \

    --app-id  mtb-example-anycloud-udp-server      \

    --user-app-name my_example_app
```

--------------------------------

### Trimmed shadow response example

Source: https://docs.memfault.com/docs/legacy-nrfcloud/mqtt-topics

An example of a JSON response for a trimmed shadow request.

```json
{

    "desired": {

      "pairing": {

        "state": "paired",

        "topics": {

          "d2c": "prod/63ae73c3-9918-4b03-a1a8-132174824392/m/d/nrf-352656101397613/d2c",

          "c2d": "prod/63ae73c3-9918-4b03-a1a8-132174824392/m/d/nrf-352656101397613/c2d"

        }

      },

      "nrfcloud_mqtt_topic_prefix": "prod/63ae73c3-9918-4b03-a1a8-132174824392/"

    },

    "reported": {

      "control": {

        "alertsEn": true,

        "logLvl": 3

        },

      "config": {

        "GPS": {

          "enable": false

          }

      }

   }

}
```

--------------------------------

### Example /etc/memfaultd.conf configuration

Source: https://docs.memfault.com/docs/linux/reference-memfaultd-configuration

A full example of the JSON configuration file used to configure memfaultd. Settings added here extend the built-in configuration.

```json
{

  "persist_dir": "/media/memfault",

  "tmp_dir": null,

  "tmp_dir_min_headroom_kib": 10240,

  "tmp_dir_min_inodes": 100,

  "tmp_dir_max_usage_kib": 102400,

  "upload_interval_seconds": 3600,

  "heartbeat_interval_seconds": 3600,

  "enable_data_collection": false,

  "enable_dev_mode": false,

  "software_version": "<YOUR_SOFTWARE_VERSION>",

  "software_type": "<YOUR_SOFTWARE_TYPE>",

  "project_key": "<YOUR_PROJECT_KEY>",

  "base_url": "https://device.memfault.com",

  "swupdate": {

    "input_file": "/etc/swupdate.cfg",

    "output_file": "/tmp/swupdate.cfg"

  },

  "reboot": {

    "last_reboot_reason_file": "/media/last_reboot_reason",

    "capture_pstore": false

  },

  "coredump": {

    "coredump_max_size_kib": 96000,

    "compression": "gzip",

    "rate_limit_count": 5,

    "rate_limit_duration_seconds": 3600,

    "capture_strategy": {

      "type": "threads",

      "max_thread_size_kib": 32

    },

    "log_lines": 100

  },

  "http_server": {

    "bind_address": "127.0.0.1:8787"

  },

  "fluent-bit": {

    "extra_fluentd_attributes": [],

    "bind_address": "127.0.0.1:5170",

    "max_connections": 4

  },

  "logs": {

    "compression_level": 1,

    "max_lines_per_minute": 500,

    "rotate_size_kib": 10240,

    "rotate_after_seconds": 3600,

    "storage": "persist",

    "source": "journald",

    "level_mapping": {

      "enable": false

    },

    "extra_attributes": [],

    "max_buffered_lines": 1000

  },

  "mar": {

    "mar_file_max_size_kib": 10240,

    "mar_entry_max_age_seconds": 604800,

    "mar_entry_max_count": 1000

  },

  "battery_monitor": null,

  "connectivity_monitor": null,

  "metrics": {

    "high_resolution_telemetry": {

      "enable": true,

      "max_samples_per_minute": 750

    },

    "enable_daily_heartbeats": false,

    "system_metric_collection": {

      "poll_interval_seconds": 10,

      "enable": true

    },

    "statsd_server": {

      "bind_address": "127.0.0.1:8125",

      "legacy_gauge_aggregation": false

    }

  }

}
```

--------------------------------

### Verify installed version with mflt get_device_info

Source: https://docs.memfault.com/docs/mcu/nordic-nrf-connect-sdk-guide

After the OTA update downloads and installs, the board reboots. Use the mflt get_device_info command to check that the new version was installed, as shown by the SW version output.

```shell
uart:~$ mflt get_device_info

[00:00:09.159,088] <inf> mflt: S/N: 352656106683967

[00:00:09.159,149] <inf> mflt: SW type: app

[00:00:09.159,210] <inf> mflt: SW version: 0.0.2

[00:00:09.159,271] <inf> mflt: HW version: nrf9151dk
```
Tokens:
Raw