Roadmap

v0.1.0

The main goals of the v0.1.0 is to get the uncertainties out of the way, implement basic functionnalities and create the tools to help on this adventure

a proof of concept for the Protoproxy as their is much incertainties about the feasibility of that one
Core module to manage devices
CLI to easily interac with the system via vash and scripts
TUI to easiliy interac with the system via a fun user experience
Go Device SDK to create basic devices

Features

Create a poc of ProtoProxy which can listen Nats and push to db
1. Need to create store library
  - Create store server
2. need to select db [questdb]
3. need to deploy db [docker compose]
4. Need to create the deserialize library to line protocol
5. use unit test to validate
6. Need to deploy NatsIO [docker compose]
7. Need to create a NatsIO library
8. Need to create to pipe the natsio telemetry to the db through protoproxy
9. Deploy Questdb and connect
10. Add metrics to protoproxy
11. Add dashboard for protoproxy
12. Add dashboard for natsio
13. Add metrics endpoint for prometheus, nodeexporter, natsio, questdb
14. Configure a grafana with questdb and prometheus data source
15. Add dashboard to see telemetry
Core, register new device and basic management. The Core.
- Create a new device
- Update a device
- Delete a device
- List all devices with labels filter
- Get a device or a list of device with list of ids
- Setup unit test boilerplate
- Setup unit test for each functions
- Setup SurrealDB
- Setup NatsIO and request reply paradigm
- Add unit test with sub test and better handle db close
- Add search by annotations
- Add search by any json fields
- Add custom set of Mir errors for nice and consistent error handling
- Comment the protofile
- Added heartbeat functionality
MirCLI, the Command Line Interface to easy interact with the system and with scripts
- Basic functionallity to manage devices
- Create a database seeding script for populating the db
- Add name field to device
MirTUI, the Terminal User Interface with bubble tea
- Learn BubbleTea
- Create the general parent layout
- Create basic components like tooltip and toast
- Create main page layout
- Create the list device layouts
- Create the create device page layout
- Create the edit device page layout
- Delete a device function
MirGoSdk, device sdk in Go
Create builder or Option patterns for sdk
Have Heartbeat functionality implemented
Config and Logging setup
Design the event system
- How to publish new event
- How to catch those events
- ServerSide SDK

Improvements/Tech dett

Ergonomics

v0.2.0 Telemetry module

The main goals of this version is to create the Telemetry module as well as the visualiazing tools for the data

Features

Server Module

ProtoFlux, handle telemetry data from protobuf to line protocol

CLI/TUI

Upload schema via CLI
Schema explorer via CLI and maybe TUI
Create ProtoDash which can generate a dashboard from a proto file

Device SDK

Custom Protobuff annotation for Mir System
Added telemetry function to the SDK

Module SDK

Add new set of events regarding telemetry
Add stream subscriptions

Testing

Integration test for the telemetry module

Improvements/Tech dett

Project layout refactor
Decoupling of storage and server handlers
rework how boiler template of app is made for services
- same tool for cli could be used for bootstrap of service
- change how init is used to become more main and have a run method
Set config in a mir folder instead of per apps
- where is the line between using code and a spec? maybe enforcing a spec is sufficient instead of creating a maze of code abstraction for it -
merge tui and cli into one binary