tailscale/net/neterror/neterror_posix.go
Amal Bansode 6de5b01e04
ipn/localapi: stop logging "broken pipe" errors (#18487)
The Tailscale CLI has some methods to watch the IPN bus for
messages, say, the current netmap (`tailscale debug netmap`).
The Tailscale daemon supports this using a streaming HTTP
response. Sometimes, the client can close its connection
abruptly -- due to an interruption, or in the case of `debug netmap`,
intentionally after consuming one message.

If the server daemon is writing a response as the client closes
its end of the socket, the daemon typically encounters a "broken pipe"
error. The "Watch IPN Bus" handler currently logs such errors after
they're propagated by a JSON encoding/writer helper.

Since the Tailscale CLI nominally closes its socket with the daemon
in this slightly ungraceful way (viz. `debug netmap`), stop logging
these broken pipe errors as far as possible. This will help avoid
confounding users when they scan backend logs.

Updates #18477

Signed-off-by: Amal Bansode <amal@tailscale.com>
2026-01-26 16:41:03 -08:00

33 lines
945 B
Go

// Copyright (c) Tailscale Inc & contributors
// SPDX-License-Identifier: BSD-3-Clause
//go:build !plan9 && !js && !wasip1 && !wasm
package neterror
import (
"errors"
"io"
"io/fs"
"runtime"
"syscall"
)
// Reports whether err resulted from reading or writing to a closed or broken pipe.
func IsClosedPipeError(err error) bool {
// 232 is Windows error code ERROR_NO_DATA, "The pipe is being closed".
if runtime.GOOS == "windows" && errors.Is(err, syscall.Errno(232)) {
return true
}
// EPIPE/ENOTCONN are common errors when a send fails due to a closed
// socket. There is some platform and version inconsistency in which
// error is returned, but the meaning is the same.
// Libraries may also return root errors like fs.ErrClosed/io.ErrClosedPipe
// due to a closed socket.
return errors.Is(err, syscall.EPIPE) ||
errors.Is(err, syscall.ENOTCONN) ||
errors.Is(err, fs.ErrClosed) ||
errors.Is(err, io.ErrClosedPipe)
}