Skip to main content

Documentation Index

Module: Lens (AWS Cost Management & Analytics) Documentation Version: 1.0.0 Last Updated: October 25, 2025 Total Pages: 12 comprehensive documents

Documentation Overview​

This documentation set provides complete coverage of the AWS Lens module, from executive overview to developer implementation details. The documentation is structured to serve multiple audiences:

  • Business Stakeholders: Files 01-02 (Overview, Functional Architecture)
  • Architects: Files 02-04 (Functional, Logical, Technical Architecture)
  • Developers: Files 05-12 (Component Design through Developer Guide)
  • DevOps Engineers: Files 10-11 (Configuration, Deployment)

Documentation Structure​

📋 Part I: Overview & Architecture (Files 01-04)​

FileDocumentLinesDescription
01LENS-OVERVIEW.md627Executive summary, features, tech stack, quick start
02FUNCTIONAL-ARCHITECTURE.md1,676Business capabilities, use cases, workflows, personas
03LOGICAL-ARCHITECTURE.md1,284Layer structure, components, design patterns
04TECHNICAL-ARCHITECTURE.md1,507Technology stack, databases, security, performance

Subtotal: 5,094 lines

🔧 Part II: Implementation Details (Files 05-08)​

FileDocumentLinesDescription
05COMPONENT-DESIGN.md63740 controllers, 107 services, 47 DAOs
06API-REFERENCE.md865100+ REST APIs with examples
07DATA-MODELS.md446165 DTOs, database schemas
08INTEGRATION-POINTS.md3418 external system integrations

Subtotal: 2,289 lines

🚀 Part III: Operations & Development (Files 09-12)​

FileDocumentLinesDescription
09DATA-FLOWS.md9636 major flows with sequence diagrams
10CONFIGURATION.md1,050Application config, environment setup
11DEPLOYMENT-GUIDE.md1,012Docker, Kubernetes, CI/CD
12DEVELOPER-GUIDE.md877Getting started, testing, contributing

Subtotal: 3,902 lines

Total Documentation Metrics​

  • Total Files: 12
  • Total Lines: 11,285
  • Total Pages (estimated): ~350 pages
  • Code Examples: 200+
  • Diagrams: 15+ (Mermaid sequence diagrams, architecture diagrams)
  • API Endpoints Documented: 100+
  • Components Documented: 194 (40 controllers + 107 services + 47 DAOs)
  • DTOs Documented: 165
  • Integration Points: 8

Quick Navigation by Role​

👔 For Business Stakeholders​

Goal: Understand what Lens does and its business value

  1. 01-lens-overview - Start here for executive summary
  2. 02-functional-architecture - Business capabilities and use cases

Time Required: 30-45 minutes

🏗️ For Solution Architects​

Goal: Understand architecture and design decisions

  1. 01-lens-overview - Overview
  2. 02-functional-architecture - Functional view
  3. 03-logical-architecture - Logical components
  4. 04-technical-architecture - Technical implementation
  5. 08-integration-points - External integrations
  6. 09-data-flows - Data flows

Time Required: 3-4 hours

💻 For Backend Developers​

Goal: Implement new features and fix bugs

  1. 12-developer-guide - START HERE for setup
  2. 05-component-design - Component structure
  3. 06-api-reference - API endpoints
  4. 07-data-models - Data structures
  5. 09-data-flows - Request flows
  6. 10-configuration - Configuration

Time Required: 4-5 hours to read, 2-3 days to become productive

🔧 For DevOps Engineers​

Goal: Deploy and maintain the application

  1. 10-configuration - Configuration details
  2. 11-deployment-guide - CRITICAL - Deployment procedures
  3. 04-technical-architecture - Infrastructure requirements
  4. 08-integration-points - External dependencies

Time Required: 2-3 hours

🧪 For QA Engineers​

Goal: Test the application thoroughly

  1. 06-api-reference - API endpoints for testing
  2. 09-data-flows - Expected behavior
  3. 12-developer-guide - Testing strategies (Section 5)

Time Required: 2-3 hours

📝 For Technical Writers​

Goal: Create marketing or user-facing documentation

  1. 01-lens-overview - Feature overview
  2. 02-functional-architecture - Use cases and workflows
  3. 06-api-reference - API documentation

Time Required: 2-3 hours

Key Features Documented​

Cost Management Features​

  • ✅ AWS vs Actual Cost Analysis
  • ✅ Cost Summary & Breakdown by Service
  • ✅ Multi-dimensional Cost Analysis
  • ✅ Cost Trend Analysis
  • ✅ Budget Tracking & Alerts
  • ✅ Cost Forecasting

Reservation Intelligence​

  • ✅ RI Coverage Analysis
  • ✅ RI Utilization Tracking
  • ✅ RI Recommendations
  • ✅ RI Expiry Tracking
  • ✅ Savings Plans Analysis

CUDOS Dashboards​

  • ✅ S3 Cost Dashboard
  • ✅ EC2 Compute Dashboard
  • ✅ RDS Database Dashboard
  • ✅ Lambda Serverless Dashboard
  • ✅ Network Cost Dashboard
  • ✅ Cross-service Cost Analysis

Reporting & Analytics​

  • ✅ Saved Reports
  • ✅ Custom Report Generation
  • ✅ Report Scheduling
  • ✅ Export to CSV/Excel/PDF
  • ✅ Report Sharing

Alerting & Notifications​

  • ✅ Budget Threshold Alerts
  • ✅ Anomaly Detection Alerts
  • ✅ RI Utilization Alerts
  • ✅ Custom Alert Rules
  • ✅ Multi-channel Notifications

Technical Highlights​

Architecture​

  • Layered Architecture: 5-layer design (Presentation, Application, Data Access, DTO, Infrastructure)
  • Design Patterns: Interface-based design, DTO pattern, Template Method, Repository, Factory
  • Polyglot Persistence: Snowflake (analytics), MongoDB (documents), MySQL (transactional), Redis (cache)

Technology Stack​

  • Framework: Spring Boot 2.7.4
  • Java Version: 17
  • Build Tool: Gradle 7.6
  • Databases: Snowflake, MongoDB 5.0, MySQL 8.0, Redis 6.2
  • Messaging: RabbitMQ 3.9
  • Cloud: AWS SDK (Cost Explorer, Pricing APIs)

Performance​

  • Response Time: 50-80ms (cached), 1-1.5s (uncached)
  • Cache Hit Ratio: 85-92%
  • Throughput: 100 req/sec (with cache)
  • Concurrent Users: 500+

Scalability​

  • Horizontal Scaling: Kubernetes HPA (3-10 pods)
  • Connection Pooling: HikariCP (20 connections per pod)
  • Async Processing: ThreadPoolTaskExecutor (10-20 threads)
  • Message Queue: RabbitMQ for event-driven architecture

Code Quality Standards​

Test Coverage​

  • Overall: 80%+
  • Controllers: 70%+
  • Services: 90%+
  • DAOs: 85%+

Documentation Standards​

  • All public methods have Javadoc
  • All REST APIs documented with examples
  • All database schemas documented
  • All configuration parameters documented

Code Style​

  • Google Java Style Guide
  • Lombok for boilerplate reduction
  • Slf4j for structured logging
  • JSR-303 for validation

Integration Points​

The Lens module integrates with 8 external systems:

  1. Snowflake - Primary analytics database (cost data warehouse)
  2. MongoDB - Document storage (saved reports, filters)
  3. MySQL - Transactional data (accounts, users, metadata)
  4. Redis - Caching layer (15min-1hour TTL)
  5. RabbitMQ - Message queue (event-driven processing)
  6. AWS SDK - Cost Explorer API, Pricing API, Organizations API
  7. Spring Cloud Config Server - Centralized configuration management
  8. authX Module - JWT authentication & authorization

Deployment Environments​

Development​

UAT​

Production​

  • URL: https://lens.cloudkeeper.com
  • Database: Prod Snowflake warehouse
  • Replicas: 3-10 pods (HPA enabled)
  • Features: SSL/TLS, monitoring, alerting

Getting Started - Quick Links​

For First-Time Readers​

Start here → 01-lens-overview

For New Developers​

Start here → 12-developer-guide

For DevOps Engineers​

Start here → 11-deployment-guide

For API Integration​

Start here → 06-api-reference

Document Maintenance​

Versioning​

  • Current Version: 1.0.0
  • Last Updated: October 25, 2025
  • Next Review: November 25, 2025 (monthly)

Update Process​

  1. Code changes → Update relevant documentation file
  2. New features → Update 01-OVERVIEW.md and relevant files
  3. API changes → Update 06-api-reference
  4. Configuration changes → Update 10-configuration
  5. Deployment changes → Update 11-deployment-guide

Ownership​

  • Module Owner: CloudKeeper Platform Team
  • Documentation Owner: Architecture Team
  • Reviewers: Senior Engineers + Tech Leads

Feedback & Contributions​

Report Issues​

Contribute​

See 12-developer-guide Section 10 for contribution guidelines.

Other Modules​

Platform Documentation​

  • CloudKeeper Platform Overview (Coming soon)
  • Stormus Architecture (Coming soon)

Document Statistics​

MetricValue
Total Documentation Files12
Total Lines11,285
Total Word Count~85,000 words
Estimated Reading Time10-12 hours
Code Examples200+
API Endpoints100+
Mermaid Diagrams15+
SQL Queries50+
Configuration Examples100+

End of Documentation Index

For questions or feedback, contact the Lens development team via Slack #lens-dev or create a JIRA ticket.