Spotflow Observability Device SDK

Device SDK for Spotflow embedded observability platform.

This SDK provides a set of tools and libraries for Zephyr RTOS to send your logs to the Spotflow observability platform.

Device SDK is integrated with the Zephyr as a module that contains the Spotflow logging backend that seamlessly integrates with the Zephyr logging subsystem.

Our solution was tested on following Zephyr boards (more are coming soon):

• NXP FRDM-RW612
• Nordic NRF7002DK
• ESP32-C3-DevKitC

Getting Started

Register and get your Ingest key at Spotflow.

Follow the Quickstart guide that is available in our portal after registration.

Alternatively, you can check sample applications in the samples. The device SDK is ment to be used as a Zephyr module. You can add it to your Zephyr project by adding the following line to your west.yml:

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

Documentation

Architecture

---
title: Main log flow
---
flowchart LR
    A[User Code] --> B[Zephyr RTOS]
    B --> C[Spotflow Logging Backend]
    C --> D[Spotflow Mqtt Broker]
    D --> E[Spotflow Observability Platform]

Loading

---
title: Spotflow Logging Backend flow
---
flowchart LR
    A[Zephyr logging] --> B[Spotflow Logging Backend]
    B --> C[Spotflow Mqtt Broker]
    C --> D[Encode CBOR]
    D --> E[Log message Queue]
    E --> F[Processor]
    F --> G[Send to MQTT]

Loading

Feedback

Any comments, suggestions, or issues are welcome. Create a Github issue or contact us at [email protected], LinkedIn or Discord.