|
| 1 | +# Stock Data Demo Platform |
| 2 | + |
| 3 | +A unified, high-throughput stock data demo platform that combines real-time data ingestion with advanced visualization capabilities. This integrated system handles WebSocket data from Polygon.io, stores it in ClickHouse, and provides both administrative controls and sophisticated stock data visualization. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## 🚀 **Getting Started** |
| 8 | + |
| 9 | +### **Prerequisites** |
| 10 | + |
| 11 | +- Node.js 18+ |
| 12 | +- Access to ClickHouse cluster |
| 13 | +- Polygon.io API credentials |
| 14 | + |
| 15 | +### **Installation & Startup** |
| 16 | + |
| 17 | +```bash |
| 18 | +# Install all dependencies (both backend and frontend) |
| 19 | +npm install |
| 20 | + |
| 21 | +# Start the integrated platform |
| 22 | +npm start |
| 23 | + |
| 24 | +# For development with hot reloading |
| 25 | +npm run dev |
| 26 | +``` |
| 27 | + |
| 28 | +### **Access Points** |
| 29 | + |
| 30 | +- **🏠 Landing Page**: `http://localhost:34567/` |
| 31 | +- **📈 Stock Charts UI**: `http://localhost:34567/stocks` _(live candlestick charts)_ |
| 32 | +- **🎛️ Admin Controls**: `http://localhost:34567/admin` |
| 33 | +- **📊 Health API**: `http://localhost:34567/health` |
| 34 | +- **🔌 Metrics API**: `http://localhost:34567/metrics` |
| 35 | + |
| 36 | +## 🏗️ **Application Structure** |
| 37 | + |
| 38 | +``` |
| 39 | +stock-data/ |
| 40 | +├── app.js # Main Express server (ingestion + routing) |
| 41 | +├── package.json # Combined dependencies |
| 42 | +├── public/ # Static assets and admin UI |
| 43 | +│ ├── index.html # Unified landing page |
| 44 | +│ ├── admin.html # Ingestion monitoring UI |
| 45 | +│ ├── styles.css # Admin UI styles |
| 46 | +│ └── app.js # Admin UI JavaScript |
| 47 | +├── frontend/ # Next.js stock visualization app |
| 48 | +│ ├── src/ |
| 49 | +│ │ ├── components/ # Stock UI components |
| 50 | +│ │ │ ├── liveDataTable.tsx |
| 51 | +│ │ │ └── liveStockChart.tsx |
| 52 | +│ │ ├── queryHandlers/ # ClickHouse query logic |
| 53 | +│ │ ├── types/ # TypeScript definitions |
| 54 | +│ │ └── app/ # Next.js app structure |
| 55 | +│ ├── next.config.mjs # Next.js configuration |
| 56 | +│ └── tsconfig.json # TypeScript configuration |
| 57 | +└── README.md # This documentation |
| 58 | +``` |
| 59 | + |
| 60 | +## 🔧 **Configuration** |
| 61 | + |
| 62 | +Key configurable parameters in the `StockDataIngester` class: |
| 63 | + |
| 64 | +```javascript |
| 65 | +this.maxBatchSize = 1000; // Records per batch |
| 66 | +this.maxMemoryUsage = 100 * 1024 * 1024; // 100MB memory limit |
| 67 | +this.batchTimeout = 5000; // 5 second flush interval |
| 68 | +this.maxConcurrentInserts = 10; // Max parallel ClickHouse inserts |
| 69 | +this.maxReconnectAttempts = 10; // WebSocket reconnection attempts |
| 70 | +``` |
| 71 | + |
| 72 | +## 📊 **Platform Capabilities** |
| 73 | + |
| 74 | +### **Data Ingestion Service** |
| 75 | + |
| 76 | +- **Throughput**: 100,000+ messages per second |
| 77 | +- **Memory Management**: Auto-managed with 100MB default limit |
| 78 | +- **Latency**: Sub-second batch processing |
| 79 | +- **Availability**: Automatic recovery from most failure scenarios |
| 80 | +- **Data Types**: Real-time trades and quotes from all US equities |
| 81 | + |
| 82 | +### **Visualization Frontend** |
| 83 | + |
| 84 | +- **Real-time Updates**: Live data refreshes every 100ms |
| 85 | +- **Interactive Charts**: Candlestick charts with volume indicators |
| 86 | +- **Time Window Selection**: 4 different aggregation periods (5min to 1day) with smart refresh rates |
| 87 | +- **Chart Performance**: Optimized refresh intervals from 500ms to 60s based on time window |
| 88 | +- **Data Quality**: Direct ClickHouse integration for minimal latency |
| 89 | +- **UI Framework**: Modern React with ClickHouse UI components |
| 90 | + |
| 91 | +### **Administrative Interface** |
| 92 | + |
| 93 | +- **Live Monitoring**: Real-time connection status and throughput metrics |
| 94 | +- **Control Panel**: Start, stop, pause, and restart data ingestion |
| 95 | +- **Performance Tracking**: Memory usage, queue lengths, processing rates |
| 96 | +- **Connection History**: Detailed logs of connection events and failures |
| 97 | + |
| 98 | +## 🔗 **Integration Architecture** |
| 99 | + |
| 100 | +### **Data Flow** |
| 101 | + |
| 102 | +1. **WebSocket Ingestion** → Polygon.io real-time feeds |
| 103 | +2. **Data Processing** → Filtering, transformation, and batching |
| 104 | +3. **Database Storage** → ClickHouse with optimized async inserts |
| 105 | +4. **UI Data Access** → Direct ClickHouse queries from frontend |
| 106 | +5. **Administrative Monitoring** → Express API endpoints |
| 107 | + |
| 108 | +### **Technology Stack** |
| 109 | + |
| 110 | +- **Backend**: Node.js + Express (JavaScript) |
| 111 | +- **Frontend**: Next.js + React (TypeScript) |
| 112 | +- **Database**: ClickHouse with optimized settings |
| 113 | +- **UI Components**: ClickHouse UI + Custom Components |
| 114 | +- **Charts**: Chart.js with financial data extensions and real-time streaming |
| 115 | +- **Time Windows**: Multiple aggregation periods (1s, 1m, 2m, 1h buckets) with adaptive refresh rates |
| 116 | +- **Real-time**: WebSocket connections + polling |
| 117 | + |
| 118 | +## 🎮 **Control API** |
| 119 | + |
| 120 | +```bash |
| 121 | +# Pause data ingestion |
| 122 | +curl -X POST http://localhost:34567/control/pause |
| 123 | + |
| 124 | +# Resume data ingestion |
| 125 | +curl -X POST http://localhost:34567/control/start |
| 126 | + |
| 127 | +# Stop ingestion completely |
| 128 | +curl -X POST http://localhost:34567/control/stop |
| 129 | + |
| 130 | +# Restart with clean reconnection |
| 131 | +curl -X POST http://localhost:34567/control/restart |
| 132 | +``` |
| 133 | + |
| 134 | +## 📈 **Monitoring & Metrics** |
| 135 | + |
| 136 | +### **Health Check Response** |
| 137 | + |
| 138 | +```json |
| 139 | +{ |
| 140 | + "status": "connected", |
| 141 | + "connected": true, |
| 142 | + "paused": false, |
| 143 | + "uptime": 1234.5, |
| 144 | + "totalUptime": 5678.9, |
| 145 | + "tradesInserted": 125847, |
| 146 | + "quotesInserted": 98234, |
| 147 | + "totalRecordsInserted": 224081, |
| 148 | + "processedMessages": 15678, |
| 149 | + "droppedMessages": 23, |
| 150 | + "memoryUsageMB": 45, |
| 151 | + "runningInserts": 3, |
| 152 | + "queueLength": 0, |
| 153 | + "connectionHistory": [...], |
| 154 | + "statusMessage": "Active - Receiving data" |
| 155 | +} |
| 156 | +``` |
| 157 | + |
| 158 | +## 🚨 **Production Considerations** |
| 159 | + |
| 160 | +### **Performance Optimization** |
| 161 | + |
| 162 | +- ClickHouse async inserts with 5MB batches |
| 163 | +- Concurrent insert limiting (max 10 parallel) |
| 164 | +- Memory pressure detection and handling |
| 165 | +- Queue overflow protection |
| 166 | + |
| 167 | +### **Reliability Features** |
| 168 | + |
| 169 | +- Exponential backoff reconnection (up to 10 attempts) |
| 170 | +- Stale connection detection (60+ seconds timeout) |
| 171 | +- Graceful shutdown with data preservation |
| 172 | +- Comprehensive error logging and recovery |
| 173 | + |
| 174 | +### **Scalability Notes** |
| 175 | + |
| 176 | +- Horizontal scaling: Run multiple ingestion instances |
| 177 | +- Database scaling: ClickHouse cluster configuration |
| 178 | +- Frontend scaling: CDN deployment for static assets |
| 179 | +- Load balancing: Multiple Express instances behind proxy |
| 180 | + |
| 181 | +## 🔧 **Development** |
| 182 | + |
| 183 | +### **Frontend Development** |
| 184 | + |
| 185 | +```bash |
| 186 | +# Build frontend for production |
| 187 | +npm run frontend:build |
| 188 | + |
| 189 | +# Run frontend in development mode |
| 190 | +npm run frontend:dev |
| 191 | + |
| 192 | +# Run only the backend |
| 193 | +npm run backend |
| 194 | +``` |
0 commit comments