github/client-go
1
0
Fork 0
mirror of https://github.com/kubernetes/client-go.git synced 2025-06-29 08:29:23 +00:00
Code Issues Projects Releases Wiki Activity

Update websocket logging levels for better debuggability

Browse Source 
Kubernetes-commit: d3feb5080c18fa73aa87c81a78d5cac82c6ed06d
This commit is contained in:
Sean Sullivan 2025-02-11 20:20:23 +00:00 committed by Kubernetes Publisher
parent bf05f9c594
commit 3ead27a3a2
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
tools/remotecommand/websocket.go
View File

@ -248,6 +248,7 @@ func (c *wsStreamCreator) readDemuxLoop(bufferSize int, period time.Duration, de
// Initialize and start the ping/pong heartbeat. // Initialize and start the ping/pong heartbeat.
h := newHeartbeat(c.conn, period, deadline) h := newHeartbeat(c.conn, period, deadline)
// Set initial timeout for websocket connection reading. // Set initial timeout for websocket connection reading.
klog.V(5).Infof("Websocket initial read deadline: %s", deadline)
if err := c.conn.SetReadDeadline(time.Now().Add(deadline)); err != nil { if err := c.conn.SetReadDeadline(time.Now().Add(deadline)); err != nil {
klog.Errorf("Websocket initial setting read deadline failed %v", err) klog.Errorf("Websocket initial setting read deadline failed %v", err)
return return
@ -354,8 +355,8 @@ func (s *stream) Read(p []byte) (n int, err error) {
// Write writes directly to the underlying WebSocket connection. // Write writes directly to the underlying WebSocket connection.
func (s *stream) Write(p []byte) (n int, err error) { func (s *stream) Write(p []byte) (n int, err error) {
klog.V(4).Infof("Write() on stream %d", s.id) klog.V(8).Infof("Write() on stream %d", s.id)
defer klog.V(4).Infof("Write() done on stream %d", s.id) defer klog.V(8).Infof("Write() done on stream %d", s.id)
s.connWriteLock.Lock() s.connWriteLock.Lock()
defer s.connWriteLock.Unlock() defer s.connWriteLock.Unlock()
if s.conn == nil { if s.conn == nil {
@ -363,7 +364,7 @@ func (s *stream) Write(p []byte) (n int, err error) {
} }
err = s.conn.SetWriteDeadline(time.Now().Add(writeDeadline)) err = s.conn.SetWriteDeadline(time.Now().Add(writeDeadline))
if err != nil { if err != nil {
klog.V(7).Infof("Websocket setting write deadline failed %v", err) klog.V(4).Infof("Websocket setting write deadline failed %v", err)
return 0, err return 0, err
} }
// Message writer buffers the message data, so we don't need to do that ourselves. // Message writer buffers the message data, so we don't need to do that ourselves.
@ -392,8 +393,8 @@ func (s *stream) Write(p []byte) (n int, err error) {
// Close half-closes the stream, indicating this side is finished with the stream. // Close half-closes the stream, indicating this side is finished with the stream.
func (s *stream) Close() error { func (s *stream) Close() error {
klog.V(4).Infof("Close() on stream %d", s.id) klog.V(6).Infof("Close() on stream %d", s.id)
defer klog.V(4).Infof("Close() done on stream %d", s.id) defer klog.V(6).Infof("Close() done on stream %d", s.id)
s.connWriteLock.Lock() s.connWriteLock.Lock()
defer s.connWriteLock.Unlock() defer s.connWriteLock.Unlock()
if s.conn == nil { if s.conn == nil {
@ -452,7 +453,7 @@ func newHeartbeat(conn *gwebsocket.Conn, period time.Duration, deadline time.Dur
// be empty. // be empty.
h.conn.SetPongHandler(func(msg string) error { h.conn.SetPongHandler(func(msg string) error {
// Push the read deadline into the future. // Push the read deadline into the future.
klog.V(8).Infof("Pong message received (%s)--resetting read deadline", msg) klog.V(6).Infof("Pong message received (%s)--resetting read deadline", msg)
err := h.conn.SetReadDeadline(time.Now().Add(deadline)) err := h.conn.SetReadDeadline(time.Now().Add(deadline))
if err != nil { if err != nil {
klog.Errorf("Websocket setting read deadline failed %v", err) klog.Errorf("Websocket setting read deadline failed %v", err)
@ -487,14 +488,14 @@ func (h *heartbeat) start() {
for { for {
select { select {
case <-h.closer: case <-h.closer:
klog.V(8).Infof("closed channel--returning") klog.V(5).Infof("closed channel--returning")
return return
case <-t.C: case <-t.C:
// "WriteControl" does not need to be protected by a mutex. According to // "WriteControl" does not need to be protected by a mutex. According to
// gorilla/websockets library docs: "The Close and WriteControl methods can // gorilla/websockets library docs: "The Close and WriteControl methods can
// be called concurrently with all other methods." // be called concurrently with all other methods."
if err := h.conn.WriteControl(gwebsocket.PingMessage, h.message, time.Now().Add(pingReadDeadline)); err == nil { if err := h.conn.WriteControl(gwebsocket.PingMessage, h.message, time.Now().Add(pingReadDeadline)); err == nil {
klog.V(8).Infof("Websocket Ping succeeeded") klog.V(6).Infof("Websocket Ping succeeeded")
} else { } else {
klog.Errorf("Websocket Ping failed: %v", err) klog.Errorf("Websocket Ping failed: %v", err)
if errors.Is(err, gwebsocket.ErrCloseSent) { if errors.Is(err, gwebsocket.ErrCloseSent) {