Regression

A Spring Boot server for collecting, storing, and analyzing error logs with REST APIs and AI-powered log analysis

Regression – Requirements Specification

Overview: Regression is a Spring Boot-based server for collecting, storing, and analyzing application error logs. It provides RESTful APIs for log ingestion and retrieval, with AI-driven analysis to detect anomalies, trends, and root causes.

---

---

Screen.Recording.2025-05-18.at.15.24.55.mov

---

Prerequisites

• Java 21 or higher
• Maven 3.8 or higher
• SQLite 3 (or your preferred database)
• Docker (optional, for containerized deployment)

Local Development Setup

1. Clone the repository

   git clone https://github.com/kenya-jug/regression.git
   cd regression

2. Configure the database

   • SQLite database will be automatically created in the project directory
   • Update src/main/resources/application.properties with your database configuration:

     spring.datasource.url=jdbc:sqlite:regression.db
     spring.datasource.driver-class-name=org.sqlite.JDBC

3. Build the project

   mvn clean install

4. Run the application

   mvn spring-boot:run

   The server will start on http://localhost:8080

Docker Deployment

1. Build the Docker image

   docker build -t regression .

2. Run the container

   docker run -p 8080:8080 regression

API Documentation

Once the application is running, you can access the API documentation at:

• Swagger UI: http://localhost:8080/swagger-ui.html
• OpenAPI Specification: http://localhost:8080/v3/api-docs

Development Workflow

1. Running Tests

   mvn test

2. Code Style Check

   mvn checkstyle:check

3. Generating Documentation

   mvn javadoc:javadoc

Contributing

1. Create a new branch for your feature

   git checkout -b feature/your-feature-name

2. Make your changes and commit them

   git add .
   git commit -m "Description of your changes"

3. Push your changes and create a pull request

📊 Code Coverage Report

Overall Coverage: 0% ✅

Metric	Covered	Missed	Total	Coverage
INSTRUCTION			0	0% ✅
LINE			0	0% ✅
BRANCH			0	0% ✅
METHOD			0	0% ✅
CLASS			0	0% ✅
COMPLEXITY			0	0% ✅