Merge pull request #77 from Jalen-Stephens/76-implementing-logging

Author: Sulayb28

.github/workflows/ci-reports.yml

@@ -40,7 +40,7 @@ jobs:
       run: ./mvnw -B -ntp pmd:pmd -Dpmd.failOnViolation=false
 
     - name: Run Checkstyle
-      run: ./mvnw -B -ntp checkstyle:checkstyle
+      run: ./mvnw -B -ntp checkstyle:check
 
     # ===== OPTIONAL LIVE E2E (requires LIVE_E2E env + external deps) =====
     - name: Run live E2E (opt-in)

README.md

@@ -49,6 +49,13 @@ From the terminal, run the following CLI commands:
     mvn checkstyle:check
 ```
 
+## HTTP Request Logging
+All incoming HTTP requests are logged by `RequestLoggingFilter` (a Spring `OncePerRequestFilter`) using SLF4J + Logback to stdout only. Example:
+```
+2024-11-01 10:15:30.123 INFO  [http-nio-8080-exec-1] dev.coms4156.project.metadetect.logging.RequestLoggingFilter - HTTP_REQUEST method=GET uri=/health query=- status=200 durationMs=12
+```
+On Heroku, view the live stream with `heroku logs --tail`.
+
 ## Continuous Integration & Reports
 ---------------------------------------------------------------------
 - **Workflow:** `.github/workflows/ci-reports.yml` runs `./mvnw -B -ntp clean test`, `jacoco:report`, `pmd:pmd` (HTML) + `pmd:check` gate, and `checkstyle:checkstyle`. It then snapshots JaCoCo/PMD HTML to PNG via `scripts/html_to_png.sh` and uploads everything as the `ci-reports` artifact.

citations.md

@@ -1,3 +1,47 @@
+### **Commit / Ticket Reference**
+- **Commit:** feat(logging): add request logging filter and console logback config
+- **Ticket:** none
+- **Date:** 2025-12-02
+- **Team Member:** Jalen Stephens
+
+---
+
+### **AI Tool Information**
+- **Tool Used:** OpenAI ChatGPT (GPT-5) via Codex CLI
+- **Access Method:** Local Codex CLI session (sandboxed; no paid API calls)
+- **Configuration:** Default model settings
+- **Cost:** $0 (course-provided access)
+
+---
+
+### **Purpose of AI Assistance**
+Implemented centralized HTTP request logging with SLF4J/Logback for Heroku: added a `OncePerRequestFilter` to log method/URI/status/duration, configured console-only Logback pattern, and documented usage in the README.
+
+---
+
+### **Prompts / Interaction Summary**
+- “Here’s a ready-to-paste Codex prompt you can use for your new ‘logging’ branch 👇”
+- “can you make a commit message and fill out a citations template for it”
+
+---
+
+### **Resulting Artifacts**
+- `src/main/java/dev/coms4156/project/metadetect/logging/RequestLoggingFilter.java`
+- `src/main/resources/logback-spring.xml`
+- `README.md`
+
+---
+
+### **Verification**
+- Not run (sandboxed session without build execution). Recommended: `./mvnw -q test`
+
+---
+
+### **Attribution Statement**
+> Portions of this work were generated with assistance from OpenAI ChatGPT (GPT-5) on 2025-12-02. All AI-generated content was reviewed and finalized by the development team.
+
+---
+
 ### **Commit / Ticket Reference**
 - **Commit:** test: add coverage for model loader and logistic regression service
 - **Ticket:** none

src/main/java/dev/coms4156/project/metadetect/logging/RequestLoggingFilter.java

@@ -0,0 +1,46 @@
+package dev.coms4156.project.metadetect.logging;
+
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+import org.springframework.web.filter.OncePerRequestFilter;
+
+/**
+ * Logs basic metadata for every HTTP request handled by the application.
+ */
+@Component
+public class RequestLoggingFilter extends OncePerRequestFilter {
+
+  private static final Logger log = LoggerFactory.getLogger(RequestLoggingFilter.class);
+
+  @Override
+  protected void doFilterInternal(
+      HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+      throws ServletException, IOException {
+
+    long start = System.currentTimeMillis();
+    String method = request.getMethod();
+    String uri = request.getRequestURI();
+    String query = request.getQueryString();
+
+    try {
+      filterChain.doFilter(request, response);
+    } finally {
+      long durationMs = System.currentTimeMillis() - start;
+      int status = response.getStatus();
+
+      log.info(
+          "HTTP_REQUEST method={} uri={} query={} status={} durationMs={}",
+          method,
+          uri,
+          query == null ? "-" : query,
+          status,
+          durationMs);
+    }
+  }
+}

src/main/resources/logback-spring.xml

@@ -0,0 +1,15 @@
+<configuration>
+  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+    <encoder>
+      <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg%n</pattern>
+    </encoder>
+  </appender>
+
+  <!-- Tame noisy framework logs while keeping application logs at INFO -->
+  <logger name="org.hibernate" level="WARN" />
+  <logger name="org.springframework" level="INFO" />
+
+  <root level="INFO">
+    <appender-ref ref="STDOUT" />
+  </root>
+</configuration>