eKuiper Manager

January 26, 2026 ยท View on GitHub

Build Status License: IOSL Next.js TypeScript PRs Welcome Live Demo AI Powered

๐Ÿš€ 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


๐ŸŽฏ Why This Project?

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 Status

โœ… Fully Built & Working

FeatureDescription
Swagger API PlaygroundComplete interactive API documentation with live "Try It Out" functionality. Full OpenAPI 3.0 spec with 70+ endpoints.
Rule Tracing & DebuggingReal-time data flow tracing with span hierarchy and detailed message attributes.
Rule TopologyVisual 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 AssistantConversational agent, Rule/Stream generators, Analysis tools. (New in v1.2.0)
Server PersistenceBrowser-based (Default) or SQLite (Experimental) storage for server configs.

๐Ÿ”ถ Partially Built (Functional but Incomplete)

FeatureStatusNotes
Query Designer30%Visual builder for shop floor users. Node-based editor in progress.
Rule Management90%List, start, stop, tracing, topology, and explain working. Edit with SQL working. Create with UI logic in progress.
Dashboard Overview70%System info display, CPU/memory/uptime monitoring. Needs real-time refresh polish.
Rule Metrics70%Basic metrics and status display. Advanced historical charts pending.
eKuiper Health Check80%Ping and system info working. Connection status indicators need work.
Action/Sink Configuration40%Basic MQTT sink working. Other sink types need implementation.
Stream Management50%List and view streams. Create with SQL editor partially working.

๐Ÿšง Under Development

FeaturePriorityNotes
Visual Pipeline BuilderMediumDrag-and-drop rule builder with React Flow
Monaco SQL EditorHigheKuiper SQL syntax highlighting & IntelliSense
MQTT Message SimulatorHighTest message generation for rule validation
Connection ManagementMediumShared MQTT, Redis, SQL connections
Schema RegistryLowProtobuf and JSON Schema management
Import/ExportMediumBackup and restore configurations
Real-time Logs ViewerLowFilter and search server logs
Python Plugin EditorLowCustom function/source/sink development
Batch Rule OperationsMediumMulti-select start/stop/delete
Configuration TemplatesLowPre-configured source/sink templates

๐Ÿ›ฃ๏ธ Development Roadmap

Phase 1: MQTT-First Development (Current Priority)

I have the capacity to fully test only MQTT-based pathways, so those will be developed and validated first:

  1. โœ… Swagger API Playground - Complete
  2. ๐Ÿ”„ MQTT Source Configuration - In Progress
  3. ๐Ÿ”„ MQTT Sink Configuration - In Progress
  4. ๐Ÿ”„ MQTT-based Rule Creation & Testing - In Progress
  5. โณ MQTT Message Simulator - Planned
  6. โณ MQTT Connection Management - Planned

Phase 2: Core Rule Engine Features

  • โœ… 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)

Phase 3: Extended Sources & Sinks

  • HTTP Pull/Push sources
  • REST API sinks
  • Redis pub/sub
  • InfluxDB sinks
  • File sources/sinks

Phase 4: Advanced Features

  • Schema registry integration
  • Python plugin development environment
  • Visual pipeline builder
  • Import/Export functionality

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18+
  • eKuiper server running (default: http://localhost:9081)
  • (Optional) OpenRouter API Key for AI features

Installation

# 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 dev

Open http://localhost:3000 in your browser.

AI Configuration (Optional)

To enable AI features, create a .env file and add your OpenRouter key:

OPENROUTER_API_KEY=your_key_here

Persistence Configuration

By default, server connections are stored in your Browser (Local Storage). To enable Database Mode (SQLite) (Experimental/Beta):

  1. Configure prisma in your environment.
  2. Toggle "Persistence Mode" in Settings.

Note: Database mode is work-in-progress and may be unstable. Browser mode is recommended.

Connect to eKuiper

  1. Start your eKuiper instance
  2. Navigate to the Manager Overview
  3. Enter your eKuiper server URL and click Connect
  4. Explore the Swagger Playground at /api-docs

Documentation available

https://ekuiper-manager.superdocs.cloud/

๐Ÿค Contributing - Let's Build This Together!

This project needs YOUR help to become the best eKuiper manager out there!

Why Contribute?

  • ๐ŸŒŸ 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

Priority Contribution Areas

AreaDifficultyImpact
Non-MQTT Source TestingMedium๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ I can't test these - need contributors with Kafka, Redis, HTTP setups
Sink Type ImplementationMedium๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ InfluxDB, TDengine, SQL sinks need work
UI/UX ImprovementsEasy-Medium๐Ÿ”ฅ๐Ÿ”ฅ Always welcome
DocumentationEasy๐Ÿ”ฅ๐Ÿ”ฅ Examples, tutorials, API guides
Error HandlingMedium๐Ÿ”ฅ๐Ÿ”ฅ Edge cases and better user feedback
TestingMedium๐Ÿ”ฅ Unit tests, integration tests
Docker SupportMedium๐Ÿ”ฅ Docker Compose setup with eKuiper

How to Contribute

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Development Guidelines

  • Follow existing code style (TypeScript, React patterns)
  • Add comments for complex logic
  • Test with a running eKuiper instance
  • Update documentation when adding features

๐Ÿ”Œ Tech Stack

TechnologyPurpose
Next.js 14React framework with App Router
TypeScriptType-safe development
Tailwind CSSStyling
Radix UIAccessible UI primitives
Monaco EditorCode editing
React FlowVisual pipeline builder
Swagger UI ReactAPI documentation
ZustandState management
OpenRouterAI Model Integration

๐Ÿ“ Project Structure

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

๐Ÿ“„ License

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)

๐Ÿ™ Acknowledgments


โญ Star This Repo!

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.