👋 Welcome to TelemetryFlow Platform

TelemetryFlow is an enterprise-grade observability platform that provides comprehensive monitoring, logging, and tracing capabilities for modern cloud-native applications. Built from the ground up with Domain-Driven Design (DDD) and CQRS patterns, it delivers industrial-strength reliability with developer-friendly APIs.

• 100% OTLP Compliance - Full support for metrics, logs, and traces
• Native Protocol Support - OTLP/HTTP and OTLP/gRPC
• Zero Vendor Lock-in - Standard OpenTelemetry SDKs and collectors
• Seamless Integration - Works with existing OTEL instrumentation

• Domain-Driven Design - 15+ business modules + 10+ shared modules with clear boundaries
• CQRS Implementation - 40+ command/query handlers for optimal performance
• Event-Driven - NATS + BullMQ hybrid messaging for real-time events
• Multi-Tenancy - Hierarchical isolation (Region → Organization → Workspace → Tenant)
• Modular Design - LEGO-pattern modules for easy extension

• 5-Tier RBAC System - Granular role-based access control
• AWS-Style API Keys - Dual-key authentication (tfk-/tfs-)
• Argon2id Hashing - OWASP-recommended cryptographic security
• MFA Support - TOTP with backup codes
• SSO Ready - Google, GitHub, Azure AD, SAML, OIDC
• Complete Audit Trail - Every action logged to ClickHouse

• ClickHouse Backend - Columnar storage for 100x query performance
• Horizontal Scaling - Stateless authentication and distributed caching
• Redis Caching - Sub-millisecond response times
• Optimized Ingestion - Handle millions of data points per second

49 Technical Documentation Files covering every aspect of the platform:

• System architecture and data flow
• Multi-tenancy implementation
• Security architecture
• Performance optimizations

• Backend Overview (4 files) - Tech stack, DDD/CQRS patterns, module structure
• Business Modules (15 files) - Core, Auth, API Keys, Telemetry, Monitoring, Alerts, SSO, Audit, Dashboard, etc.
• Shared Modules (10 files) - Cache, Email, Logger, Queue, Messaging, CORS, ClickHouse, OTEL, UI, Platform

• Vue 3 architecture overview
• Technology stack and module structure
• State management with Pinia
• Routing and data visualization with ECharts 6.0

• Database schema and quick reference
• OTLP ingestion guide with SDK examples
• Naming conventions and coding standards

• Docker Compose deployment guide
• Kubernetes deployment
• Environment configuration
• Production deployment checklist

Total: 52,000+ lines of documentation | 151+ Mermaid diagrams

✅ Completed Features:

• Full OTLP support (metrics, logs, traces, exemplars)
• API Key authentication with AWS-style dual keys (tfk-/tfs-)
• 5-Tier RBAC system with 22 permissions
• Multi-tenancy architecture (Region → Org → Workspace → Tenant)
• DDD/CQRS implementation (40+ handlers)
• 15 backend business modules + 10 shared modules
• Modern Vue 3 frontend with Naive UI
• Real-time WebSocket updates with Socket.IO
• ECharts 6.0 data visualization
• Comprehensive documentation (49 files, 52,000+ lines, 151+ diagrams)
• Complete test infrastructure (280+ tests, 88-92% coverage)
• Docker Compose & Kubernetes deployment guides

• ✅ 100% OpenTelemetry Compliant - Full OTLP support for metrics, logs, traces
• ✅ Enterprise Security - AWS-style API keys with Argon2id hashing
• ✅ High Test Coverage - 88-92% backend coverage with 280+ tests
• ✅ Complete Documentation - 49 comprehensive files with 52,000+ lines and 151+ diagrams
• ✅ OpenAPI Specification - 2,866 lines of detailed API documentation
• ✅ DDD/CQRS Architecture - 15+ backend modules with 40+ CQRS handlers
• ✅ Multi-Tenancy - Hierarchical isolation with automatic context injection

• Domain-Driven Design - Clean architecture with clear module boundaries
• CQRS Pattern - Optimized read/write operations
• Event Sourcing - Complete audit trail in ClickHouse
• Type Safety - 100% TypeScript across frontend and backend
• Performance - ClickHouse provides 100x query performance vs traditional SQL
• Scalability - Stateless authentication enables horizontal scaling
• Documentation - 49 comprehensive files with 151+ Mermaid diagrams covering architecture, modules, deployment, and best practices

• 5-Minute Setup - Bootstrap complete platform with pnpm bootstrap
• Hot Module Reload - Vite 7.2.4 provides lightning-fast HMR
• Interactive API Docs - Swagger UI with live testing
• Comprehensive Documentation - 49 technical files covering architecture, modules, deployment
• Visual Documentation - 151+ Mermaid diagrams for architecture understanding
• Integration Guides - OTLP integration examples for multiple programming languages
• Clear Error Messages - Detailed validation errors with fix suggestions

✅ Authentication

• JWT with refresh tokens
• TOTP-based MFA (Google Authenticator, Authy)
• SSO (Google, GitHub, Azure AD, SAML, OIDC)
• API keys with Argon2id hashing

✅ Authorization

• 5-tier RBAC system
• Permission-based access control (22 permissions)
• Multi-tenant data isolation
• Workspace-level resource quotas

✅ Audit & Compliance

• Complete audit trail in ClickHouse
• All API key operations logged
• User action tracking
• Security event monitoring

✅ Data Protection

• Encryption at rest (optional)
• TLS/SSL for data in transit
• Password complexity requirements
• Automatic session timeout

We welcome contributions! Here's how you can help:

1. Code Contributions

   • Fix bugs
   • Add new features
   • Improve performance
   • Enhance documentation

2. Bug Reports

   • Report issues on GitHub
   • Provide reproduction steps
   • Include logs and screenshots

3. Feature Requests

   • Suggest new features
   • Propose architecture improvements
   • Share use cases

4. Documentation

   • Improve existing docs
   • Add tutorials
   • Translate documentation

Apache License 2.0

Copyright 2024-2026 DevOpsCorner Indonesia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

See LICENSE for full details.

Built with these amazing open-source technologies:

Special thanks to all contributors and the open-source community!

Coming Soon: Public demo environment