Description

Memfault provides observability purpose-built for devices. Compatible with constrained microcontroller-based devices to complex Linux and Android systems, Memfault helps embedded development teams understand exactly how their devices perform in the field, and find and fix faults fast.

Fault Diagnostics: Automatically capture diagnostics data every time your devices experience a crash or unexpected error. Diagnose and debug faults happening in the field within hours, not days or weeks.
Log Management: Automatic log storage, collection, and analysis designed for devices, not servers and apps. Save hours with every investigation and turn your logs into a tool for fleet-wide insights.
Fleet Health Monitoring: Monitor the health of your fleet in real-time with built-in tools for comparison between software versions, hardware versions, and more. We handle the data collection and processing, you get the insights.
Product Analytics: Understand product usage, performance, and reliability using real-world data. Collect product usage data from every device in your fleet even when they aren’t connected so there are no gaps in your data and no more guessing.

Pricing

1NCE OS Plugins allow you to start at no cost. The Device Observability plugin by Memfault has a free trial plan for up to 10 devices. You can increase the number of devices and unlock more features and benefits by selecting the right plan for your business.

Start Using

To install Plugin in 1NCE OS you can choose one of the two options described below. After configuration is done you can use the Demo script for zephyr from 1NCE OS to showcase Memfault Plugin features and understand the capabilities of 1NCE OS SDK.

⚠️ Please note that during Memfault plugin installation your Organization's email address will be used for the new Memfault account. You will need access to this email to receive confirmation email from Memfault after Sign up.

⚠️ Please note that by installing this plugin, you are aware that data is shared with Memfault.

Memfault Plugin Installation via Frontend

Plugin Installation

The Plugin can be installed in 1NCE OS portal "Plugins" tab by choosing "Memfault."

There is no need to provide any extra information, so you can immediatelly proceed with the installation by pressing the "Install" button on the "Plugin Details page."

⚠️ Please note that after pressing install button system automatically creates Memfault account with your 1NCE Organization's email address, which cannot be changed afterwards.

If plugin installation goes well you should see the "Plugin Installed" page.
After this, you already can start sending data to the Memfault system.

In the Plugin installed page, you will see the "Open Memfault Portal" button, which in the new browser tab will open your new Memfault account finalization page. The email field will be already prefilled with your 1NCE Organization's email address.

In case you navigate away from the "Plugin Installed" page you can still get the Memfault registration URL by navigating to the Memfault plugin details and clicking on the "Register with Memfault" link.

After registration in the Memfault portal is completed you should see the following plugin details page, where we provide details about the Memfault plugin and the "Memfault portal" link to easily navigate to your Memfault account.
If you need to uninstall the Memfault plugin it also can be done from this page. The uninstall button will only remove the plugin from the 1NCE system, in the Memfault portal account will not be deleted.

Memfault plugin installation via API

Plugin Installation

The Memfault plugin can be created via the partners API by using the "MEMFAULT" partner in the API Explorer.
There is no need to pass any request body during the POST request.

Example:

curl --location --request POST 'https://api.1nce.com/management-api/v1/partners/MEMFAULT/plugins' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \

Plugin Get and Uninstall endpoints

To get details or uninstall your Memfault integration via API, you can use the same endpoints you would use for a generic Plugin described in the API Explorer.

⚠️ Memfault portal Url to finalize registration can be retrieved only in the response of the Get Plugin Details endpoint.

Utilizing Memfault plugin

The Memfault server receives and stores debug and log data sent by your devices.

1NCE OS Memfault plugin supports CoAP/CoAPs to HTTPS proxying with seamless support for Authorization. All the data sent by the device to the 1NCE OS Coap Proxy server is proxied to the Memfault Chunks endpoint. We automatically pass device ICCID as a device identifier to the Memfault system, so the following URI should be added in CoAP Requests Proxy-URIoption:

https://chunks.memfault.com/api/v0/chunks/:iccid:

Additionally please remember to set the correct Content-Format option, for binary payloads it should be 42.

To utilize proxy functionality please use one of the following endpoints for CoAP requests:

• coap://coap.proxy.os.1nce.com:5683

• coaps://coaps.proxy.os.1nce.com:5684.

  If CoAPs is required to be used please refer to DTLS encryption for CoAP.

Coap to HTTPS Proxy functionality

CoAP to HTTPS proxy's main functionality is to "translate" the CoAP requests to HTTPS requests and HTTPS responses to CoAP responses. As mentioned before 1NCE OS Coap Proxy for Memfault Plugin automatically replaces :iccid: part with the actual ICCID value before doing HTTPS request to the Memfault chunks API.
Additionally, the Memfault plugin also retrieves and stores the Memfault project key value during plugin installation. This value then is automatically injected as a Memfault-Project-Key header into the HTTPS request towards Memfault Chunks API endpoint, so there is no need to manage it from the customer device side.

Adding devices in Memfault

After Memfault plugin installation is done you can utilize Demo script for zephyr to start sending chunks data to the Memfault system. If chunks are processed successfully, the device will show up in the Memfault portal on the Devices page automatically with the ICCID of the 1NCE sim card used as a device serial number.

Features and Limitations

General Plugins features and limitations applies to Memfault.
There are still some individual Features and Limitations applied to the Memfault plugin:

Features

• Seamless Memfault plugin creation without the need to prepare or enter any additional information.
• Automatic Memfault authorization process in the Coap Proxy without the need to store any secrets or extra configuration on the device.

Limitations

• During Memfault account creation system will use your 1NCE Organization's email address, so there is no way to provide a custom email before plugin installation.
• The device serial number in the Memfault system always is the ICCID of the 1NCE sim card.
• Maximum supported payload size for Coap Proxy requests is 5120 bytes. It is suggested to send payload which is smaller than 1024 bytes in a single request to not trigger block-wise transfer.
• Currently only supported Memfault proxying mode is uploading a single chunk in one request, other modes like base64-encoded chunks and multiple chunks in one request described in the Memfault Chunks endpoint are not supported.

Outcome of successful plugin creation

After devices start to send data to the Memfault system, you can start monitoring different aspects of your device fleet.
The Connectivity page provides useful insights like device uptime, sent data amount, and more.

On the Overview page, you can display many different useful widgets.

More information about how to use Memfault features can be found in the Memfault Documentation.