如何在 X-Ray SegmentListener 中访问传入的 HTTP 请求？

Question

问题

我对 Java 使用AWS X-Ray SDK来为我的 Spring Boot 微服务启用 X-Ray 跟踪。 通过以下代码片段，我可以附加自定义SegmentListener ：

final AWSXRayRecorder recorder = AWSXRayRecorderBuilder
                .standard()
                .withPlugin(new EcsPlugin())
                .withSegmentListener(new SLF4JSegmentListener())
                .withSegmentListener(new MyHttpHeaderSegementListener())
                .build();
AWSXRay.setGlobalRecorder(recorder);

在MyHttpHeaderSegementListener ，我尝试根据传入的 HTTP 请求 header（来自前端）注入 X-Ray 注释：

public class MyHttpHeaderSegementListener implements SegmentListener {

  // snippet source: https://stackoverflow.com/a/54349178/6489012
  public static Optional<HttpServletRequest> getCurrentHttpRequest() {
    return Optional.ofNullable(RequestContextHolder.getRequestAttributes())
                   .filter(ServletRequestAttributes.class::isInstance)
                   .map(ServletRequestAttributes.class::cast)
                   .map(ServletRequestAttributes::getRequest);
  }

  public MyHttpHeaderSegementListener() {}

  @Override
  public void onBeginSegment(final Segment segment) {
    final var httpContext = MyHttpHeaderSegementListener.getCurrentHttpRequest();
    httpContext.ifPresent(context -> segment.putAnnotation("Origin", context.getHeader("Origin")));
  }

}

段侦听器按预期触发onBeginSegment段，但MyHttpHeaderSegementListener.getCurrentHttpRequest()始终返回Optional.empty 。

问题

1. 是否有可能在SegmentListener中检查传入的 HTTP 请求（因为它们是由Controller接收的）？
2. aws-xray-sdk-java甚至可能支持原生方式吗？
3. 为什么从RequestContextHolder中取出来的请求总是空的？

（有点题外话，但是：4.根据 HTTP 标头设置注释甚至是一个好习惯）

Answer 1

我对 2. 和 3. 问题没有答案，但我找到了 1. 问题的答案。

对于传入请求，您需要添加一个 Spring 过滤器来配置 AWS X-Ray 。 由于过滤器可以访问 HTTP 请求，我只是将自己的过滤器包装在 AWS 的com.amazonaws.xray.javax.servlet.AWSXRayServletFilter周围：

public class XRayServletFilter extends AWSXRayServletFilter {
  public XRayServletFilter(String fixedSegmentName) {
    super(fixedSegmentName);
  }

  @Override
  public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain chain) throws IOException, ServletException {
    this.addHttpRequestToContext(request);

    super.doFilter(request, response, chain);
  }

  private void addHttpRequestToContext(final ServletRequest request){
    final Optional<HttpServletRequest> httpServletRequest = HttpRequestUtils.castToHttpRequest(request);

    if (httpServletRequest.isPresent()) {
      final ServletRequestAttributes requestAttributes = new ServletRequestAttributes(httpServletRequest.get());
      RequestContextHolder.setRequestAttributes(requestAttributes);
    }
  }
}

其中使用了我写的 static class：

public final class HttpRequestUtils {
  public static Optional<HttpServletRequest> getCurrentHttpRequest() {
    return Optional.ofNullable(RequestContextHolder.getRequestAttributes())
                   .filter(ServletRequestAttributes.class::isInstance)
                   .map(ServletRequestAttributes.class::cast)
                   .map(ServletRequestAttributes::getRequest);
  }

  public static Optional<HttpServletRequest> castToHttpRequest(ServletRequest request) {
    try {
      return Optional.of((HttpServletRequest) request);
    } catch (ClassCastException classCastException) {
      return Optional.empty();
    }
  }
}

这个自定义过滤器基本上在 RequestContextHolder 中设置了RequestContextHolder请求。 之后，您可以在您的分段侦听器中使用它：

public class MyHttpHeaderSegementListener implements SegmentListener {
  public MyHttpHeaderSegementListener() {}

  @Override
  public void onBeginSegment(final Segment segment) {
    final Optional<HttpServletRequest> request = HttpRequestUtils.getCurrentHttpRequest();

    request.map(req -> req.getHeader("Origin")).ifPresent(origin -> segment.putAnnotation("client_origin", origin));;
  }
}