🚀 The First Open-Source Web UI & Manager for LF Edge eKuiper - Because the Community Deserves Better
An open-source, community-driven web interface and management platform for eKuiper - the lightweight IoT data analytics and stream processing engine. Built because the existing closed-source solution is buggy and the community deserves a reliable, open alternative.
Developed & Maintained by I-Dacs Labs
📧 Contact: measure@i-dacs.com | 🌐 Website: i-dacs.com | 💼 LinkedIn
There is currently no fully open-source eKuiper management UI. EMQ's proprietary eKuiper Manager is:
- Closed source
- Reportedly buggy and unreliable
- Not community-extensible
This project aims to fill that gap with a completely open-source, community-driven solution.
| Feature | Description |
|---|---|
| Swagger API Playground | Complete interactive API documentation with live "Try It Out" functionality. Full OpenAPI 3.0 spec with 70+ endpoints. |
| Rule Tracing & Debugging | Real-time data flow tracing with span hierarchy and detailed message attributes. |
| Rule Topology | Visual graph representation of the data flow from sources through operators to sinks. |
| Query Plan (Explain) | Visualized execution plans and performance hints for eKuiper SQL queries. |
| AI Assistant | Conversational agent, Rule/Stream generators, Analysis tools. (New in v1.2.0) |
| Server Persistence | Browser-based (Default) or SQLite (Experimental) storage for server configs. |
| Feature | Status | Notes |
|---|---|---|
| Query Designer | 30% | Visual builder for shop floor users. Node-based editor in progress. |
| Rule Management | 90% | List, start, stop, tracing, topology, and explain working. Edit with SQL working. Create with UI logic in progress. |
| Dashboard Overview | 70% | System info display, CPU/memory/uptime monitoring. Needs real-time refresh polish. |
| Rule Metrics | 70% | Basic metrics and status display. Advanced historical charts pending. |
| eKuiper Health Check | 80% | Ping and system info working. Connection status indicators need work. |
| Action/Sink Configuration | 40% | Basic MQTT sink working. Other sink types need implementation. |
| Stream Management | 50% | List and view streams. Create with SQL editor partially working. |
| Feature | Priority | Notes |
|---|---|---|
| Visual Pipeline Builder | Medium | Drag-and-drop rule builder with React Flow |
| Monaco SQL Editor | High | eKuiper SQL syntax highlighting & IntelliSense |
| MQTT Message Simulator | High | Test message generation for rule validation |
| Connection Management | Medium | Shared MQTT, Redis, SQL connections |
| Schema Registry | Low | Protobuf and JSON Schema management |
| Import/Export | Medium | Backup and restore configurations |
| Real-time Logs Viewer | Low | Filter and search server logs |
| Python Plugin Editor | Low | Custom function/source/sink development |
| Batch Rule Operations | Medium | Multi-select start/stop/delete |
| Configuration Templates | Low | Pre-configured source/sink templates |
I have the capacity to fully test only MQTT-based pathways, so those will be developed and validated first:
- ✅ Swagger API Playground - Complete
- 🔄 MQTT Source Configuration - In Progress
- 🔄 MQTT Sink Configuration - In Progress
- 🔄 MQTT-based Rule Creation & Testing - In Progress
- ⏳ MQTT Message Simulator - Planned
- ⏳ MQTT Connection Management - Planned
- ✅ Rule CRUD with validation (SQL-based)
- ✅ Rule status & basic metrics
- ✅ Rule topology visualization
- ✅ Data tracing and debugging
- ✅ Query execution plan visualization (Explain)
- ⏳ Advanced historical charts (Pending)
- HTTP Pull/Push sources
- REST API sinks
- Redis pub/sub
- InfluxDB sinks
- File sources/sinks
- Schema registry integration
- Python plugin development environment
- Visual pipeline builder
- Import/Export functionality
- Node.js 18+
- eKuiper server running (default: http://localhost:9081)
- (Optional) OpenRouter API Key for AI features
# Clone the repository
git clone https://github.com/ankur-paan/ekuiper-manager.git
cd ekuiper-manager
# Install dependencies
npm install
# Start development server
npm run devOpen http://localhost:3000 in your browser.
To enable AI features, create a .env file and add your OpenRouter key:
OPENROUTER_API_KEY=your_key_hereBy default, server connections are stored in your Browser (Local Storage). To enable Database Mode (SQLite) (Experimental/Beta):
- Configure
prismain your environment. - Toggle "Persistence Mode" in Settings.
Note: Database mode is work-in-progress and may be unstable. Browser mode is recommended.
- Start your eKuiper instance
- Navigate to the Manager Overview
- Enter your eKuiper server URL and click Connect
- Explore the Swagger Playground at
/api-docs
https://ekuiper-manager.superdocs.cloud/
This project needs YOUR help to become the best eKuiper manager out there!
- 🌟 First-mover advantage - Be part of building the definitive open-source eKuiper UI
- 🔧 Real impact - Your code will be used by the global IoT community
- 📚 Learn edge computing - Work with cutting-edge IoT stream processing
- 🤝 Community driven - No corporate agenda, just building great software
| Area | Difficulty | Impact |
|---|---|---|
| Non-MQTT Source Testing | Medium | 🔥🔥🔥 I can't test these - need contributors with Kafka, Redis, HTTP setups |
| Sink Type Implementation | Medium | 🔥🔥🔥 InfluxDB, TDengine, SQL sinks need work |
| UI/UX Improvements | Easy-Medium | 🔥🔥 Always welcome |
| Documentation | Easy | 🔥🔥 Examples, tutorials, API guides |
| Error Handling | Medium | 🔥🔥 Edge cases and better user feedback |
| Testing | Medium | 🔥 Unit tests, integration tests |
| Docker Support | Medium | 🔥 Docker Compose setup with eKuiper |
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
- Follow existing code style (TypeScript, React patterns)
- Add comments for complex logic
- Test with a running eKuiper instance
- Update documentation when adding features
| Technology | Purpose |
|---|---|
| Next.js 14 | React framework with App Router |
| TypeScript | Type-safe development |
| Tailwind CSS | Styling |
| Radix UI | Accessible UI primitives |
| Monaco Editor | Code editing |
| React Flow | Visual pipeline builder |
| Swagger UI React | API documentation |
| Zustand | State management |
| OpenRouter | AI Model Integration |
src/
├── app/ # Next.js App Router
│ ├── page.tsx # Main application entry
│ └── api-docs/ # Swagger playground
├── components/
│ ├── dashboard/ # Metrics dashboard
│ ├── editor/ # Monaco code editors
│ ├── manager/ # Manager UI components
│ ├── pipeline/ # Visual pipeline builder
│ └── ui/ # Shared UI components
├── lib/
│ └── ekuiper/ # eKuiper API client
│ ├── client.ts # Base REST client
│ ├── manager-client.ts # Extended manager client
│ └── manager-types.ts # TypeScript interfaces
└── public/
└── ekuiper-openapi.json # Complete OpenAPI spec
This project is licensed under the IDACS Open Source License (IOSL) - see the LICENSE file for details.
Key points:
- ✅ Free to use, modify, and distribute
- ✅ Commercial use permitted
- 📧 Organizations with >$1M annual turnover using in production: please notify us at measure@i-dacs.com (just a friendly notification, no fee required)
- LF Edge eKuiper - The IoT stream processing engine
- EMQ - Original developers of eKuiper
- Next.js - React framework
- Swagger UI - API documentation
If you find this project useful, please give it a star! It helps others discover the project and motivates continued development.
Developed by I-Dacs Labs
📧 measure@i-dacs.com | 🌐 i-dacs.com | 💼 LinkedIn
Building the future of Industrial IoT together.