Spotflow

Introduction

Spotflow is an observability platform for embedded devices that collects logs, metrics, and crash dumps from devices in the field. It provides dashboards, alerts, crash analysis, vulnerability detection, and over-the-air (OTA) firmware updates.

The Spotflow Device SDK integrates with Zephyr as a module, uses the native logging and core dump subsystems, and sends telemetry to the platform over MQTT or BLE. OTA updates integrate with MCUboot and can also update external MCUs connected to the device.

The SDK is licensed under the Business Source License 1.1 with an additional use grant for interaction with the Spotflow platform. See the Spotflow Device SDK license for details.

Usage with Zephyr

To pull in the SDK as a Zephyr module, add it as a west project in your west.yml manifest with the following content and run west update:

manifest:
  projects:
    - name: spotflow
      url: https://github.com/spotflow-io/device-sdk
      revision: main
      path: modules/lib/spotflow

Create a Spotflow account and obtain an ingest key from the Spotflow web application. Ensure the device has an Internet connection, then add the following to prj.conf, replacing the device ID with a unique identifier and the ingest key with your own:

CONFIG_LOG=y
CONFIG_SPOTFLOW=y
CONFIG_SPOTFLOW_DEVICE_ID="zephyr-device-001"
CONFIG_SPOTFLOW_INGEST_KEY="<your-ingest-key>"

The SDK sends messages from standard Zephyr logging macros, such as LOG_INF(), to Spotflow. See the Spotflow Zephyr quickstart for a complete setup using a sample application and the Spotflow documentation for metrics, crash reports, configuration options, and OTA updates.

Reference