Sentio IoT is an open-source, enterprise-grade observability platform designed specifically for IoT and edge devices. Monitor metrics, logs, and traces across thousands of devices in real-time with AI-driven alerting, predictive maintenance, and native integrations.
🚀 Quick Start • 📖 Documentation • 🗺️ Roadmap • 🤝 Contributing • 💬 Discussions
|
|
Get up and running in under 5 minutes!
# Clone the repository
git clone https://github.com/NickScherbakov/sentio-iot.git
cd sentio-iot
# Start all services with Docker Compose
docker-compose up -d
# Wait for services to initialize (~30 seconds)
docker-compose ps
# Access the dashboard
open http://localhost:3000
# Default credentials: admin / admin (⚠️ Change in production!)After running docker-compose up, you'll have:
| Service | Port | Description |
|---|---|---|
| 🎨 Dashboard | 3000 | Web UI for monitoring and management |
| 🔌 API Server | 8080 | REST API and WebSocket endpoint |
| 📊 VictoriaMetrics | 8428 | Time-series metrics database |
| 📝 Loki | 3100 | Log aggregation system |
| 🔍 Tempo | 3200 | Distributed tracing backend |
| 💾 PostgreSQL | 5432 | Metadata and configuration store |
| 🚀 Redis | 6379 | Cache and message queue |
- 📖 Read the Full Documentation
- ⚙️ Configure your first device connector
- 🎯 Set up alerts and monitoring
- 🚀 Plan your production deployment
Comprehensive documentation to help you get started:
| Guide | Description |
|---|---|
| 📘 Getting Started | Complete overview and introduction |
| 🔧 Installation | Detailed installation instructions |
| ⚙️ Configuration | Configuration reference and examples |
| 📋 Examples | Ready-to-use configuration examples |
| 🚀 Deployment | Production deployment guide |
| 📚 API Reference | REST API and WebSocket documentation |
| 🏗️ Architecture | Technical architecture deep dive |
| ❓ FAQ | Frequently asked questions |
| 🔧 Troubleshooting | Common issues and solutions |
| 🆚 Comparison | Compare with alternatives |
- FastAPI (Python 3.11) - High-performance async API framework
- aiohttp - Async HTTP client/server
- scikit-learn - Machine learning library
- OpenTelemetry - Observability instrumentation
- React 18 - Modern UI framework
- Material-UI - Professional component library
- Recharts - Powerful data visualization
- Vite - Lightning-fast build tool
- VictoriaMetrics - Fast, cost-effective time-series DB
- Loki - Horizontally-scalable log aggregation
- Tempo - High-scale distributed tracing backend
- PostgreSQL 15 - Reliable relational database
- Redis 7 - In-memory data structure store
- Docker - Containerization platform
Sentio IoT uses a modern microservices architecture designed for scalability and reliability:
┌─────────────────────────────────────────────────────────────────┐
│ Dashboard (React) │
│ http://localhost:3000 │
└────────────────────────────┬────────────────────────────────────┘
│ REST/WebSocket
┌────────────────────────────┴────────────────────────────────────┐
│ API Server (FastAPI) │
│ Authentication • Authorization • WebSocket │
└─────┬──────────┬──────────┬──────────┬─────────────────────────┘
│ │ │ │
▼ ▼ ▼ ▼
┌──────────┐ ┌──────┐ ┌──────┐ ┌──────────────┐
│Victoria │ │ Loki │ │Tempo │ │ PostgreSQL │
│ Metrics │ │ │ │ │ │ & Redis │
│(Metrics) │ │(Logs)│ │(Trace)│ │ (Metadata) │
└──────────┘ └──────┘ └──────┘ └──────────────┘
▲ ▲ ▲
│ │ │
┌─────┴──────────┴────────┴──────────────────────────────────────┐
│ Collectors Service │
│ Metrics • Logs • Traces Ingestion │
└─────────────────────────────┬────────────────────────────────────┘
│
┌─────────────────────────────┴────────────────────────────────────┐
│ Protocol Connectors │
│ Home Assistant • Zigbee • Modbus • OPC-UA │
└───────────────────────────────────────────────────────────────────┘
│
┌─────────┴──────────┐
▼ ▼
[IoT Devices] [Industrial PLCs]
- 🎨 Dashboard: Modern React SPA with Material-UI
- 🔌 API Server: FastAPI with async/await for high concurrency
- 📊 Collectors: High-throughput data ingestion service
- 🔗 Connectors: Protocol-specific device integration layer
- 🤖 AI Engine: Machine learning for anomaly detection
- 💾 Storage: Best-in-class open-source data stores
|
|
MQTT, CoAP, KNX, and custom protocol support - see our Roadmap
We love contributions! Sentio IoT is built by the community, for the community.
- 🐛 Report bugs - Open an issue with details
- 💡 Suggest features - Share your ideas
- 📝 Improve docs - Help others get started
- 💻 Submit PRs - Fix bugs or add features
- ⭐ Star the repo - Show your support!
- Read our Contributing Guide
- Check out Good First Issues
- Join discussions in GitHub Discussions
- Review our Code of Conduct
# Clone your fork
git clone https://github.com/YOUR_USERNAME/sentio-iot.git
cd sentio-iot
# Create a branch
git checkout -b feature/amazing-feature
# Make your changes and test
docker-compose up -d
# Commit and push
git commit -m "Add amazing feature"
git push origin feature/amazing-feature
# Open a Pull RequestCheck out our Roadmap to see what's coming next! We're working on:
- 🎨 Custom dashboard builder
- 🏢 Multi-tenancy support
- 🧠 Advanced AI/ML models
- 📱 Mobile applications
- 🔌 Additional protocol support
- ☸️ Kubernetes deployment
Vote on features and suggest new ones in GitHub Issues!
Sentio IoT builds on amazing open-source projects:
- VictoriaMetrics - Fast time-series database
- Grafana Loki - Log aggregation system
- Grafana Tempo - Distributed tracing
- FastAPI - Modern Python web framework
- React - UI framework
- Material-UI - React components
Special thanks to all our contributors!
If you find Sentio IoT useful, please consider:
- ⭐ Star this repository - It helps others discover the project
- 🐦 Share on social media - Spread the word
- 💬 Join discussions - Help build the community
- 🤝 Contribute - Code, docs, or ideas
- 💖 Sponsor - Support ongoing development
This project is licensed under the MIT License - see the LICENSE file for details.
- ✅ Commercial use allowed
- ✅ Modification allowed
- ✅ Distribution allowed
- ✅ Private use allowed
- ℹ️ License and copyright notice required
Security is a top priority. Please review our Security Policy and report vulnerabilities responsibly.
- 💬 GitHub Discussions - Ask questions, share ideas
- 🐛 Issue Tracker - Report bugs, request features
- 📧 Email - Create an issue for sensitive matters
Sentio IoT is perfect for:
- 🏠 Smart Home Monitoring - Track all your IoT devices in one place
- 🏭 Industrial IoT - Monitor factory equipment and sensors
- 🏢 Building Management - Oversee HVAC, lighting, and security systems
- 🌾 Agriculture - Monitor greenhouses and farm equipment
- 💡 Energy Management - Track power consumption and optimize usage
- 🚗 Fleet Management - Monitor vehicle telemetry and diagnostics
Built with ❤️ by the open-source community
⭐ Star us on GitHub! — it motivates us to create more features ⭐