Spring Actuator /health端点返回200时抛出Broken Pipe Error的处理方案

问题 #

在Spring Actuator的/health端点遇到Broken pipe错误，该错误伴随HTTP状态码200 OK返回。目前未在HealthIndicator下配置自定义处理逻辑，想了解：

• 是否需要处理该异常？
• 处理的方式、位置？
• 能否捕获该异常并重新抛出为其他错误码？

错误栈如下：

java.io.IOException: Broken pipe
    at java.base/sun.nio.ch.FileDispatcherImpl.write0(Native Method)
    at java.base/sun.nio.ch.SocketDispatcher.write(SocketDispatcher.java:62)
    at java.base/sun.nio.ch.IOUtil.writeFromNativeBuffer(IOUtil.java:132)
    at java.base/sun.nio.ch.IOUtil.write(IOUtil.java:97)
    at java.base/sun.nio.ch.IOUtil.write(IOUtil.java:53)
    at java.base/sun.nio.ch.SocketChannelImpl.write(SocketChannelImpl.java:532)
    at org.apache.tomcat.util.net.SecureNioChannel.flush(SecureNioChannel.java:124)
    at org.apache.tomcat.util.net.SecureNioChannel.write(SecureNioChannel.java:826)
    at org.apache.tomcat.util.net.NioEndpoint$NioSocketWrapper.doWrite(NioEndpoint.java:1384)
    at org.apache.tomcat.util.net.SocketWrapperBase.doWrite(SocketWrapperBase.java:773)
    at org.apache.tomcat.util.net.SocketWrapperBase.flushBlocking(SocketWrapperBase.java:726)
    at org.apache.tomcat.util.net.SocketWrapperBase.flush(SocketWrapperBase.java:716)
    at org.apache.coyote.http11.Http11OutputBuffer$SocketOutputBuffer.end(Http11OutputBuffer.java:568)
    at org.apache.coyote.http11.filters.ChunkedOutputFilter.end(ChunkedOutputFilter.java:199)
    at org.apache.coyote.http11.Http11OutputBuffer.end(Http11OutputBuffer.java:235)
    at org.apache.coyote.http11.Http11Processor.finishResponse(Http11Processor.java:1222)
    at org.apache.coyote.AbstractProcessor.action(AbstractProcessor.java:389)
    at org.apache.coyote.Response.action(Response.java:209)
    at org.apache.catalina.connector.OutputBuffer.close(OutputBuffer.java:262)
    at org.apache.catalina.connector.Response.finishResponse(Response.java:443)
    at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:391)
    at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399)
    at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
    at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:890)
    at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1743)
    at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
    at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)
    at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)
    at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
    at java.base/java.lang.Thread.run(Thread.java:833)

回答 #

是否需要处理该异常？ #

不需要主动处理。这个错误本质是客户端在服务器完成响应写入前就关闭了连接——比如客户端超时、用户关闭页面、监控工具提前断开等。从错误栈能看到，异常发生在Tomcat的底层IO写入阶段，此时Spring已经生成了200的响应，只是没法把数据完整发给客户端。这种情况属于网络层面的异常，不影响服务本身的健康状态，也不会导致服务逻辑出错。

处理的方式、位置？ #

如果只是想避免日志刷屏，可以通过以下方式处理：

• Tomcat层面过滤日志：在配置文件中调整日志级别，让Tomcat不打印这类IO异常：

  logging.level.org.apache.coyote.http11.Http11Processor=ERROR
  

  这样可以忽略Broken pipe这类底层IO异常的日志输出。
• 自定义Tomcat阀：如果需要更精准的控制，可以自定义ErrorReportValve，在其中过滤掉Broken pipe异常，避免日志输出。

能否捕获该异常并重新抛出为其他错误码？ #

不能。因为异常发生时，HTTP响应的状态码已经设置为200，甚至响应头可能已经发送给客户端了。根据HTTP协议，一旦响应头发送，就无法修改状态码。从错误栈也能看到，异常出现在Http11Processor.finishResponse阶段，此时响应已经接近完成，根本没法再更改状态码。

内容的提问来源于stack exchange，提问作者JITHIN_PATHROSE