TUI Dashboard

Real-Time Monitoring: ApiTap includes a beautiful Terminal User Interface (TUI) for monitoring pipeline progress in real-time with live metrics and visual indicators.

Enable TUI Mode

Launch with --tui flag

Add the flag to enable the interactive dashboard

docker run -it --rm \
  -v $(pwd):/app \
  devasm/apitap:latest \
  -y pipelines.yaml --tui

Features

Throughput Metrics

• MB/s transfer rate
• Rows per second
• Real-time charts
• Historical data

Memory Monitoring

• Current RAM usage
• Memory trends
• GC statistics
• Leak detection

Error Tracking

• HTTP error rates
• Sink failures
• Retry attempts
• Error logs

TUI Interface

ApiTap TUI Dashboard

╔═══════════════════════════════════════════════╗

║ ApiTap Pipeline Monitor ║

╠═══════════════════════════════════════════════╣

║ 📊 Throughput: 42,000 rows/s | 12.5 MB/s ║

║ 💾 Memory: 167.2 MiB / 256 MiB (67%) ║

║ 🔄 Status: ● Running | Pages: 142/500 ║

║ ⚠️ Errors: 0 failures | Retries: 2 ║

╚═══════════════════════════════════════════════╝

Press 'q' to quit | 'r' to refresh | 'h' for help

Key Metrics Explained

📈 Performance Indicators

Throughput

Real-time data processing rate showing both rows/second and MB/second

Memory Usage

Current RAM consumption with percentage of allocated limit

🔍 Status Information

Progress

Pages processed vs total estimated pages remaining

Error Rate

Failed requests, sink errors, and automatic retry attempts

Pro Tip: The TUI dashboard is perfect for monitoring long-running pipelines. It updates in real-time and provides instant visibility into performance and any issues.