# Docs


- **Introduction**
- [What is Spotflow?](/): Introducing the observability platform for embedded devices
- Quickstart
  - [Zephyr Integration](/quickstart/zephyr): Integrate your Zephyr-based devices using Spotflow west module.
  - [nRF Connect SDK Integration](/quickstart/nordic-nrf-connect): Integrate your devices with Nordic nRF Connect SDK using Spotflow west module.
  - [ESP-IDF Integration](/quickstart/esp-idf): Integrate your ESP-IDF devices using Spotflow module.
  - [Connect via MQTT](/quickstart/mqtt): Connect your devices using MQTT on non-Zephyr devices or when extra flexibility is needed.

- **Integration Guides**
- Zephyr
  - [Logging with Zephyr](/guides/zephyr/logging-zephyr): Enable log collection on devices running Zephyr RTOS and analyze ingested log messages.
  - [Crash reports with Zephyr](/guides/zephyr/crash-reports-zephyr): Send crash reports and collect core dumps from Zephyr devices in the field and analyze them with Spotflow.
  - [Metrics with Zephyr](/guides/zephyr/metrics-zephyr): Enable system and custom metric collection on devices running Zephyr RTOS and analyze ingested metrics in Spotflow dashboards.
  - [Over-the-air (OTA) updates with Zephyr](/guides/zephyr/ota-zephyr): Enable and customize Spotflow OTA updates on Zephyr devices.
  - [Over-the-air (OTA) updates of external MCUs](/guides/zephyr/ota-external-mcu-zephyr): Remotely update firmware of external MCUs connected to your Zephyr device.
  - [Advanced configuration for Zephyr](/guides/zephyr/advanced-config-zephyr): This guide describes various advanced configuration options for the Zephyr module.
- nRF Connect SDK
  - [Difference from "vanilla" Zephyr](/guides/nordic-nrf-connect/zephyr-differences): References to the Zephyr guide and hints for partition configuration.
- ESP-IDF
  - [Logging with ESP-IDF](/guides/esp-idf/logging-esp-idf): Enable log collection on devices running ESP-IDF and analyze ingested log messages.
  - [Crash reports with ESP-IDF](/guides/esp-idf/crash-reports-esp-idf): Send ESP-IDF core dumps from devices in the field and analyze them with Spotflow.
  - [Metrics with ESP-IDF](/guides/esp-idf/metrics-esp-idf): Enable system and custom metric collection on devices running ESP-IDF and analyze ingested metrics in Spotflow dashboards.
- MQTT
  - [Logging with MQTT](/guides/mqtt/logging-mqtt): Collect logs from any device using standard MQTT interface.
  - [Crash reports with MQTT](/guides/mqtt/crash-reports-mqtt): Send crash reports and collect core dumps from any device in the field that can run a MQTT client and analyze them with Spotflow.
  - [Metrics with MQTT](/guides/mqtt/metrics-mqtt): Collect metrics from any device using standard MQTT interface and analyze them in Spotflow dashboards.
  - [Over-the-air (OTA) updates with MQTT](/guides/mqtt/ota-mqtt): Implement the MQTT protocol for Spotflow OTA updates on devices that use a custom MQTT client.
  - [MQTT Session metadata](/guides/mqtt/session-metadata): Establish session-scoped context for telemetry messages sent during one MQTT session, such as extra labels or firmware build ID.

- **Fundamentals**
- Monitoring
  - [Logging](/fundamentals/monitoring/logging): Comprehensive description of Spotflow logging including technical details.
  - [Crash reports & core dumps](/fundamentals/monitoring/crash-reports): Comprehensive description of Spotflow crash reports and core dumps including technical details.
  - [Metrics](/fundamentals/monitoring/metrics): Comprehensive description of Spotflow metrics including collection model, configuration, and dashboard usage.
  - [Alerts](/fundamentals/monitoring/alerts): Learn how to configure alert rules in Spotflow, understand how alerts are evaluated, and send notifications to the right people.
  - [Dashboards](/fundamentals/monitoring/dashboards): Learn how to use dashboards in Spotflow to monitor your embedded device fleet effectively.
- [Over-the-air (OTA) updates](/fundamentals/ota): Learn how to configure OTA updates in Spotflow, understand how to create and manage firmware versions, and roll out updates to your devices.
- [Firmware management](/fundamentals/firmware-management): Comprehensive description of Spotflow firmware management including technical details.
- [Device authorization](/fundamentals/device-authorization): How to use ingest keys to authorize your device to send data to Spotflow.
- [Gateway & relay architectures](/fundamentals/device-source-id): How to attribute telemetry to the originating device in gateway and relay architectures where messages are forwarded on behalf of other devices.
- [Bluetooth Low Energy](/fundamentals/bluetooth-low-energy): How Spotflow devices forward telemetry through a Bluetooth Low Energy gateway using the Spotflow BLE GATT service and framed stream protocol.

- **Using Spotflow**
- Guides
  - [Invite members to your workspace](/using-spotflow/guides/invite-members): Learn how to invite members to your Spotflow workspace and manage their access.
  - [Create custom dashboard](/using-spotflow/guides/custom-dashboards): Learn how to configure custom dashboards in Spotflow to monitor your embedded device fleet effectively.
  - [Deploy Over-the-Air (OTA) updates](/using-spotflow/guides/ota): Learn how to create and manage OTA updates in Spotflow for your embedded device fleet.
  - [Track security issues across your devices](/using-spotflow/guides/track-security-issues): Learn how to use SBOMs to identify security issues in your firmware and assess their impact across your devices.
  - [Set up alerts](/using-spotflow/guides/alert-rules): Learn how to set up alerts in Spotflow to get notified when something happens in your embedded device fleet.
- Best Practices
  - [Comply with CRA](/using-spotflow/best-practices/comply-with-cra): Use Spotflow to maintain a software inventory, track vulnerabilities, deliver security updates, and monitor your device fleet.
  - [Using Spotflow with Resource-Constrained Devices](/using-spotflow/best-practices/resource-constrained-devices): How to configure Spotflow's device module to fit tight RAM, bandwidth, and power budgets on embedded hardware.
  - [Using Spotflow in Mesh Networks](/using-spotflow/best-practices/mesh-networks): How to collect logs, metrics, and crash reports from devices that connect to the internet through a gateway rather than directly.
  - [Using Spotflow with Your Existing MQTT Broker](/using-spotflow/best-practices/existing-mqtt-broker): How to collect logs, metrics, and crash reports through your own cloud MQTT broker (such as AWS IoT Core, Azure IoT Hub, or HiveMQ) without adding a second MQTT connection from the device.

- **Links**
- [Home Page](https://spotflow.io/)
- [Product Roadmap](https://roadmap.spotflow.io/roadmap)
- [Changelog](https://roadmap.spotflow.io/changelog)
- [Discord Community](https://discord.gg/yw8rAvGZBx)
- [Status Page](https://status.spotflow.io)