spring-cloud/spring-cloud-gateway

Add logging when max frame size is exceeded

Open

#1,048 opened on May 8, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (4,284 stars) (3,204 forks)batch import
enhancementhelp wanted

Description

When gateway is proxying websocket connections, if a message exceeds the max frame size, the websocket connection is dropped.

(This is related to #163)

However, there's no logging that indicates this has happened, even with TRACE level logging enabled in gateway.

It'd be very helpful if there was a warning message logged within the gateway that indicates this has happened. (Specifically, that the message exceeded the maxFrameSize, so the messages was dropped, and the websocket connection was terminated).

Contributor guide

Tech stack
java
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaSpring BootWebSocket
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the codebase for where websocket frame handling occurs, likely in classes related to WebSocket proxying (e.g., WebSocketService or similar). Look for where maxFrameSize is checked or where the connection is dropped. Add a logger instance and a warning log message there using SLF4J Logger at WARN level. Also review related issue #163 for additional context and potential code locations.
Add logging when max frame size is exceeded · spring-cloud/spring-cloud-gateway#1048 | Good First Issue