Gandalf/sofarr
Public Access
0
0
Fork 0
Code Issues 1 Pull Requests Actions 1 Packages Projects Releases 59 Wiki Activity

FEATURE: Client-side console log capturing and streaming endpoint #46

New Issue
Closed
opened 2026-05-24 11:21:21 +01:00 by Gandalf · 1 comment
Gandalf commented 2026-05-24 11:21:21 +01:00
Owner
Copy Link
Copy Source

FEATURE: Client-side console log capturing and streaming API endpoint with dual-authentication

Problem / Requirement:
To aid in frontend troubleshooting, developers need a way to capture and gather client-side console logs (console.log, console.warn, console.error) and make them accessible over a real-time log stream endpoint. This helps debug frontend issues (such as SSE failures, CSP violations, and state synchronization issues) in environments without direct access to browser devtools.

Success Criteria:

  1. Client-Side Interceptor: Intercept standard browser console methods at SPA startup and place captured logs into an in-memory queue.
  2. Batched Log Transmission (Selected Option A): Periodic HTTP POST batch queries to POST /api/debug/client-logs (every 2 seconds or when the queue hits 20 items) to minimize browser thread and network overhead.
  3. Server storage and SSE log streaming:
    • Save incoming logs into a separate rolling 1000-line buffer clientLogBuffer.
    • Expose GET /api/debug/client-logs to stream client-side logs in real-time via SSE.
  4. Security & Configuration:
    • Enableable only when the environment variable ENABLE_LOG_STREAM=true is set.
    • Enforce exact same dual-auth rules (Emby session cookie, Basic Auth fallback, and X-Webhook-Secret header bypass) on both client logs endpoints.
  5. API Documentation: Documented in server/openapi.yaml.
FEATURE: Client-side console log capturing and streaming API endpoint with dual-authentication Problem / Requirement: To aid in frontend troubleshooting, developers need a way to capture and gather client-side console logs (console.log, console.warn, console.error) and make them accessible over a real-time log stream endpoint. This helps debug frontend issues (such as SSE failures, CSP violations, and state synchronization issues) in environments without direct access to browser devtools. Success Criteria: 1. Client-Side Interceptor: Intercept standard browser console methods at SPA startup and place captured logs into an in-memory queue. 2. Batched Log Transmission (Selected Option A): Periodic HTTP POST batch queries to POST /api/debug/client-logs (every 2 seconds or when the queue hits 20 items) to minimize browser thread and network overhead. 3. Server storage and SSE log streaming: • Save incoming logs into a separate rolling 1000-line buffer clientLogBuffer. • Expose GET /api/debug/client-logs to stream client-side logs in real-time via SSE. 4. Security & Configuration: • Enableable only when the environment variable ENABLE_LOG_STREAM=true is set. • Enforce exact same dual-auth rules (Emby session cookie, Basic Auth fallback, and X-Webhook-Secret header bypass) on both client logs endpoints. 5. API Documentation: Documented in server/openapi.yaml.
Gandalf added the Kind/Feature
Priority
Medium
3
 labels 2026-05-24 11:21:21 +01:00
Gandalf commented 2026-05-24 11:31:55 +01:00
Author
Owner
Copy Link
Copy Source

Resolved in commit 3c6791658c.

Resolved in commit 3c6791658c8fb05f15b84cbdba1815eef40823d1.
Gandalf added the Area/Frontend label 2026-05-28 11:58:05 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Area/Docker
Docker image and container packaging
 Area/Download Clients
Download client integrations
 Area/Frontend
Client-side UI and build tooling
 Area/History
History and completed downloads views
 Area/Logging
Log streaming, file handling, and debug infrastructure
 Area/Matching
Matching and correlation logic
 Area/Proxy
Upstream service proxy routes
 Area/SSE
Server-Sent Events and real-time streaming
 Area/Webhooks
Webhook processing and reliability
 Compat/Breaking
Breaking change that won't be backward compatible
 Compat/Non-Breaking
Non-breaking compatibility change
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No labels Area/Frontend Kind/Feature
Priority
Medium
3
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
Gandalf
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Gandalf/sofarr#46