How kenya-jug/regression works
Project type and purpose
• This is a Spring Boot–based backend service (“Regression”) whose sole responsibility is to collect, store, and analyze application error logs via REST APIs.
• It targets high-volume log ingestion, fast retrieval, AI-powered analysis, and exposes metrics for monitoring.
File structure
• Top-level:
• pom.xml (build & dependencies)
• src/main/java/com/kenyajug/regression – contains the application entrypoint (RegressionApplication), servlet initializer, domain entities, repositories, and utility classes.
• src/main/resources – application.properties, DB changelog scripts, SQL schema.
• specification/ – design docs for API and persistence.
• src/test – unit and integration tests.
• .github/workflows/maven.yml – CI pipeline.
README for additional insights
• RESTful API for log ingestion and retrieval
• AI-driven modules for anomaly detection and root-cause analysis
• JWT/OAuth2 security
• Metrics endpoint (/metrics) for monitoring
• Persist to relational or NoSQL database, migrations via changelog
a. Main components
1) External Clients
• Log Producers (microservices, apps sending JSON via HTTP POST)
• API Consumers (dashboards, CLI, or other services fetching logs via GET)
• Swagger UI / OpenAPI client
2) API & Security Layer
• Spring MVC Controllers (LogIngestionController, LogRetrievalController, AnalysisController)
• Security filters (JWT/OAuth2 filter chain)
3) Business Logic Layer
• Services:
• IngestionService (validates, transforms, hands off to persistence)
• RetrievalService (applies filters, pagination)
• AIAnalysisService (calls embedded or external ML models)
4) Persistence Layer
• Repositories implementing CrudRepository
• Domain Entities: AppLog, Application, LogsMetadata, User
• Database Migration (Liquibase/Flyway changelog scripts)
• Database (SQLite/PostgreSQL)
5) Monitoring & Metrics
• Spring Actuator endpoints (/metrics, /health)
• Exporters (Prometheus endpoint)
6) Infrastructure & CI/CD
• Docker container
• GitHub Actions (maven build, test, coverage)
• Container registry & orchestration (optional Kubernetes)
b. Relationships & interactions
• Clients → HTTP POST/GET → Controllers
• Controllers → (via Security Filter) → Services
• Services → Repositories → Database
• Services → AIAnalysis component / external ML service
• Actuator module intercepts and exposes metrics to Monitoring system
• CI pipeline triggers Maven build, runs tests, builds Docker image, pushes to registry
c. Architectural patterns & principles
• Layered architecture (Controller → Service → Repository → DB)
• Domain-driven design (clear Entities and Repositories)
• Repository pattern for data access
• Separation of concerns (ingestion vs retrieval vs analysis)
• Pluggable AI model architecture (swap or extend analysis module)
• Database migrations for schema evolution
d. Key technologies & frameworks
• Spring Boot, Spring MVC, Spring Data JPA
• SQLite / PostgreSQL (configurable via application.properties)
• Liquibase/Flyway for changelogs
• JWT/OAuth2 (Spring Security)
• Spring Actuator for metrics
• Maven, GitHub Actions
• Docker
Detailed breakdown of components
• API Tier:
[API Layer – Spring MVC Controllers] – secured by [Security Filter Chain]
• Service Tier:
[IngestionService] ↔ [Repository Layer]
[RetrievalService] ↔ [Repository Layer]
[AIAnalysisService] ↔ [ML Model / External AI Service]
• Data Tier:
[Repositories] → [Database (with migrations)]
• Monitoring:
[Actuator] → [Prometheus / Grafana]
• Infrastructure:
[GitHub Repo] → [GitHub Actions] → [Docker Image] → [K8s Cluster / Docker Host]