nats-console/ROADMAP.md

NATS JetStream Console - Roadmap

Current Status: Beta (v0.5.0)

Phases 1-5 are complete. The application now includes full CRUD operations, detailed management views, metrics charts, real-time WebSocket updates, alert system with notification channels, message search/export/replay, multi-tenancy features (RBAC, API keys, audit logging, 2FA), custom dashboards, and enterprise features (IP allowlisting, data retention policies, audit trail export, GDPR compliance tools, and compliance reports).

---

Phase 1: Core MVP ✅ (Completed)

Infrastructure

• Monorepo setup with pnpm workspaces and Turborepo
• Docker Compose for local development (PostgreSQL, Redis, ClickHouse, NATS)
• Shared package with types, schemas, and utilities
• Makefile for common operations

Backend API

• Fastify server with TypeScript
• Prisma ORM with PostgreSQL
• Redis for sessions and caching
• ClickHouse for time-series metrics
• Authentication (JWT, refresh tokens)
• NATS client with connection pooling
• Basic CRUD for clusters, streams, consumers

Workers

• Metrics collector (stream, consumer, cluster metrics)
• Alert processor skeleton
• NATS JetStream for internal job queues

Frontend

• Next.js 15 with App Router
• shadcn/ui components
• Authentication pages (login, register)
• Dashboard layout with sidebar
• Basic list views for all entities

---

Phase 2: Detail Views & Forms ✅ (Completed)

Stream Management

• Stream detail page
  • Overview tab with stats
  • Messages tab with browser (pagination, JSON formatting, copy, expand/collapse)
  • Consumers tab
  • Configuration tab
  • Metrics tab with charts (message throughput, data throughput)
• Create stream dialog
• Edit stream configuration
• Delete stream with confirmation
• Purge stream messages
• Message publishing interface

Consumer Management

• Consumer detail page
  • Overview with lag visualization (progress bars)
  • Configuration details
  • Metrics tab with charts (lag, pending, ack rate)
• Create consumer dialog
• Edit consumer configuration
• Delete consumer with confirmation
• Pause/Resume consumer

Cluster Management

• Cluster detail page
  • Server info and health
  • JetStream account info
  • Connected streams overview
  • Metrics tab with gauge charts (memory, connections, storage)
• Add cluster wizard
• Edit cluster connection
• Test connection functionality
• Cluster health monitoring

---

Phase 3: Real-time & Monitoring ✅ (Completed)

WebSocket Integration

• WebSocket server in API
• Real-time metrics streaming via Redis pub/sub
• Live message preview
• Alert notifications (real-time via WebSocket)
• Connection status indicators in UI

Charts & Visualization

• Integrate charting library (ECharts)
• Message throughput charts
• Consumer lag visualization
• Storage usage graphs (gauge charts)
• Historical trends (via ClickHouse time-series)

Alert System

• Alert rule builder UI
• Condition types:
  • Consumer lag threshold
  • Message rate anomaly
  • Storage capacity
  • Connection health
• Notification channels:
  • Email notifications (via Resend)
  • Slack integration
  • Webhook endpoints
  • PagerDuty integration
  • Microsoft Teams integration
  • Google Chat integration
• Alert history and acknowledgment
• Incident management (create, acknowledge, resolve, close)

---

Phase 4: Advanced Features ✅ (Completed)

Message Operations

• Message search with filters
• Message replay functionality
• Dead letter queue management
• Message schema viewer
• Export messages to JSON/CSV

Multi-tenancy

• Organization management
• Team management
• Role-based access control (RBAC)
• Audit logging
• API key management

Custom Dashboards

• Dashboard builder
• Widget library
• Saved queries
• Dashboard sharing
• Export to PDF

---

Phase 5: Enterprise Features ✅ (Completed)

Security

• SSO/SAML integration
• Two-factor authentication
• IP allowlisting
• Encryption at rest
• Secrets management

Compliance

• GDPR compliance tools
• Data retention policies
• Audit trail export
• Compliance reports

Scaling

• Multi-region support
• Horizontal API scaling
• Read replicas
• Caching optimization

Operations

• Backup and restore
• Migration tools
• CLI tool
• Terraform provider
• Kubernetes operator

---

Phase 6: Ecosystem

Integrations

• Prometheus metrics export
• Grafana dashboard templates
• OpenTelemetry tracing
• DataDog integration
• CloudWatch integration

Developer Experience

• API documentation (OpenAPI)
• SDK generation
• Postman collection
• Interactive API explorer
• Code examples

Community

• Public Docker image
• Helm chart
• Documentation site
• Video tutorials
• Community forum

---

Technical Debt & Improvements

Performance

• Query optimization
• Connection pooling tuning
• Lazy loading for large lists
• Virtual scrolling
• Image optimization

Code Quality

• Unit test coverage > 80%
• E2E tests with Playwright
• API integration tests
• Storybook for components
• Documentation

DevOps

• CI/CD pipeline
• Automated releases
• Docker multi-stage builds
• Health check endpoints
• Graceful shutdown

---

Release Schedule

Version	Status	Focus
0.1.0	✅ Complete	Core MVP
0.2.0	✅ Complete	Detail views & forms
0.3.0	✅ Complete	Real-time & monitoring
0.4.0	✅ Complete	Advanced features
0.5.0	✅ Current	Enterprise features
1.0.0	Planned	Production ready

---

Contributing

See CONTRIBUTING.md for guidelines on how to contribute to this project.

Feedback

Please open issues for:

• Bug reports
• Feature requests
• Documentation improvements
• General questions