AWS XRAY SDK 问题：无法开始名为“Amazon S3”的子分段：找不到分段

Question

我们正在将 XRAY 添加到我们的 Spring Boot 应用程序中，但我无法解决以下错误：

Failed to begin subsegment named 'Amazon S3': segment cannot be found.

这是我们代码的相关部分：

pom.xml:

<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-recorder-sdk-core</artifactId>
    <version>1.2.1</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-recorder-sdk-aws-sdk</artifactId>
    <version>1.2.1</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-recorder-sdk-aws-sdk-instrumentor</artifactId>
    <version>1.2.1</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-recorder-sdk-apache-http</artifactId>
    <version>1.2.1</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-recorder-sdk-spring</artifactId>
    <version>1.3.1</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-recorder-sdk-sql-postgres</artifactId>
    <version>1.2.1</version>
</dependency> 

弹簧应用程序

@Bean
public Filter TracingFilter() {
    return new AWSXRayServletFilter("myService");
}

类调用 S3

@PostConstruct
public void runOnStartup(){
    String fileName = "myFileName";
    String bucketName = "myBucketName";

    amazonS3Client = AmazonS3ClientBuilder.standard()
        .withCredentials(new ProfileCredentialsProvider("MyCredentials"))
        .withClientConfiguration(getClientConfiguration())
        .withRegion(region)
        .build();

    Segment segment = AWSXRay.beginSegment("do-startup-operation");
    S3Object s3Object = amazonS3Client.getObject(bucketName, fileName);
    AWSXRay.endSegment();

    //Do stuff with S3Object
}

到目前为止我尝试过的：

1）我已经尝试过使用和不使用 sdk-aws-sdk-instrumentor 导入，在执行此问题和本文档中概述的操作时添加 TracingHandler 配置。

.withRequestHandlers(new TracingHandler(AWSXRay.getGlobalRecorder()))

2）我发现这个线程似乎建议使用 AWSXRAY.createSegment()，但我不确定 lambda 中会发生什么，或者它是否与我的场景相关

我已阅读并发现相关的其他文档/代码：https : //docs.aws.amazon.com/xray/latest/devguide/scorekeep-startup.html

https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-sdkclients.html

https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-multithreading.html

https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-workerthreads.html

https://github.com/aws/aws-xray-sdk-java/blob/master/aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/contexts/ThreadLocalSegmentContext.java# L23

PS我简化了我的代码并省略了一些错误处理以使查看此问题的人更容易阅读

Answer 1

X-Ray servlet 过滤器将在收到请求时打开一个段，并在返回响应之前关闭它。它创建的段代表完整的请求/响应生命周期。作为服务此请求的一部分捕获的任何内容（在本例中可能是一些 AWS 服务调用）都称为子分段。正如您所看到的，子段需要跟踪上下文（这是针对哪个段的）。

问题是，在服务器启动时，检测器尝试捕获 S3 调用，但由于尚未收到请求，因此无法找到上下文。一种选择是设置一个环境变量，AWS_XRAY_CONTEXT_MISSING这样LOG_ERROR就不会有异常，只有一个日志条目。有关更多详细信息，请访问https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-configuration.html#xray-sdk-java-configuration-envvars。

为了在 lambda 上运行，lambda 容器将为每个调用创建一个段。它将跟踪上下文设置为环境变量。因此，只要被捕获的代码位于处理程序类内，上下文就应该始终存在。

Answer 2

更换后现在可以使用

AWSXRay.getGlobalRecorder()

和

Entity mySegment = AWSXRay.beginSegment("do-startup-operation");
AWSXRay.getGlobalRecorder().setTraceEntity(mySegment);
S3Object s3Object = amazonS3Client.getObject(bucketName, fileName);
AWSXRay.endSegment();