Wrong order of modules in Http.client.stack · twitter/finagle#783

(3 评论) (0 反应) (0 负责人)Scala (8,864 star) (1,435 fork)batch import

help wantedwaiting

描述

Responses are handled by ClientTracingFilter before PayloadSizeFilter, causing unwanted side effects on Zipkin side.

Expected behavior

ClientTracingFilter should be placed before PayloadSizeFilter in Http.client.stack

Actual behavior

When working on zipkin - finagle integration we had an issue with weird "unknown" spans occurring after some delay after finished http request.

I found that the problem is in the order of modules: ClientTracingFilter and PayloadSizeFilter in Http.client.stack.

By default PayloadSizeFilter goes before ClientTracingFilter in the chain. When a response is coming, ClientTracingFilter is working beforehand. The problem is that, it makes collected spans to be pushed the Zipkin server. When finally PayloadSizeFilter is trying to generate another span with sent/received bytes it is already too late. As other spans have be already sent, it cannot be properly matched. When the flushing mechanism pushes it to the server it will be annotated with "unknown" label and destroy Zipkin UI.

I made a temporary workaround modifying Http.client.stack configuration

Http.client.stack
 .remove(ClientTracingFilter.role).insertBefore(Stack.Role("PayloadSize"), 
    ClientTracingFilter.module[http.Request, http.Response])

but I believe it should be fixed in the source code.

I described this situation on forum as well. https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!topic/finaglers/U9pVm_eFiJI

Libs: com.twitter:finagle-http_2.12:19.2.0 com.twitter:finagle-core_2.12:19.2.0

io.zipkin.reporter2:zipkin-sender-okhttp3:2.7.13 io.zipkin.reporter2:zipkin-reporter:2.7.13

io.zipkin.finagle2:zipkin-finagle_2.12: 2.0.11 io.zipkin.finagle2:zipkin-finagle-http_2.12:2.0.11

贡献者指南

技术栈: scala
领域: backendapiperformance
议题类型: bug
难度: 2
预计时间: under 1 hour
活动状态: stale
清晰度: clear
前置要求: Scala basicsFinagle HTTP client
新手友好度: 70
研究方向: Fix the order of ClientTracingFilter and PayloadSizeFilter in Http.client.stack. The stack is defined in the finagle http module, likely in a file like Http.scala or ClientBuilder.scala. Swap the modules so that ClientTracingFilter is placed before PayloadSizeFilter. Verify that the fix resolves the Zipkin span issue described in the forum post.