Amazon SNS 中的主动跟踪

权限启用主动跟踪使用 AWS SDK 对 Amazon SNS 主题启用主动跟踪使用 AWS CLI 对 Amazon SNS 主题启用主动跟踪使用 CloudFormation 对 Amazon SNS 主题启用主动跟踪验证已启用主动跟踪测试

使用 AWS X-Ray，可以在用户请求经过 Amazon SNS 主题并流向 Amazon Data Firehose、AWS Lambda、Amazon SQS 和 HTTP/S 端点订阅的过程中，对这些请求进行追踪和分析。

借助 X-Ray，您可以获得每个请求的端到端可视化视图，从而能够：

识别哪些服务在调用您的 Amazon SNS 主题，以及其订阅下游包含哪些服务。
分析各类延迟，例如：
- 请求在 Amazon SNS 主题中等待处理的时间。
- 传输到每个订阅端点所花费的时间。

重要

订阅数很多的 Amazon SNS 主题可能达到大小限制，无法完全跟踪。有关跟踪文档大小限制的信息，请参阅《AWS 一般参考》中的 X-Ray 服务限额。

如果您从正在跟踪的服务中调用 Amazon SNS API，则 Amazon SNS 会传递跟踪，即使在 API 上未启用 X-Ray 跟踪也是如此。

Amazon SNS 对于标准主题和 FIFO 主题都支持 X-Ray 跟踪。您可以使用 Amazon SNS 控制台、Amazon SNS SetTopicAttributes API、Amazon Simple Notification Service CLI 参考或 CloudFormation 为 Amazon SNS 主题启用 X-Ray。

要了解有关将 Amazon SNS 与 X-Ray 结合使用的更多信息，请参阅《AWS X-Ray 开发人员指南》中的 Amazon SNS 和 AWS X-Ray。

使用 Amazon SNS 控制台时，Amazon SNS 会尝试为 Amazon SNS 主题创建调用 X-Ray 所需的权限。如果您没有足够的权限使用 Amazon SNS 控制台，则尝试可能会被拒绝。有关更多信息，请参阅Amazon SNS 中的 Identity and Access Management和用于 Amazon SNS 访问控制的示例案例。

使用 CLI 时，必须手动配置权限。这些权限是使用资源策略配置的。有关在 X-Ray 中使用所需权限的更多信息，请参阅 Amazon SNS 和 AWS X-Ray。

在 Amazon SNS 主题上启用主动跟踪后，它会读取跟踪 ID，根据跟踪 ID 向客户发送数据，并将跟踪 ID 传播到下游服务。

登录 Amazon SNS 控制台。
选择一个主题或创建一个新主题。有关创建主题的详细信息，请参阅创建 Amazon SNS 主题。
在创建主题页面的详细信息部分，选择主题类型：FIFO或标准。
1. 输入主题的名称。
2. （可选）输入主题的显示名称。
展开 Active tracing（主动跟踪），然后选择 Use active tracing（使用主动跟踪）。

一旦您已为 Amazon SNS 主题启用了 X-Ray，则可以使用 X-Ray 服务地图查看该主题的端到端跟踪和服务地图。

以下代码示例显示如何使用 AWS SDK for Java 对 Amazon SNS 主题启用主动跟踪。


public static void enableActiveTracing(SnsClient snsClient, String topicArn) {

        try {

            SetTopicAttributesRequest request = SetTopicAttributesRequest.builder()
                .attributeName("TracingConfig")
                .attributeValue("Active")
                .topicArn(topicArn)
                .build();

            SetTopicAttributesResponse result = snsClient.setTopicAttributes(request);
            System.out.println("\n\nStatus was " + result.sdkHttpResponse().statusCode() + "\n\nTopic " + request.topicArn()
                + " updated " + request.attributeName() + " to " + request.attributeValue());

        } catch (SnsException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
        }
    }

以下代码示例显示如何使用 AWS CLI 对 Amazon SNS 主题启用主动跟踪。


aws sns set-topic-attributes \
    --topic-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --attribute-name TracingConfig \
    --attribute-value Active

以下 CloudFormation 堆栈显示如何对 Amazon SNS 主题启用主动跟踪。


AWSTemplateFormatVersion: 2010-09-09
Resources:
  MyTopicResource:
    Type: 'AWS::SNS::Topic'
    Properties:
      TopicName: 'MyTopic'
      TracingConfig: 'Active'

您可以使用 Amazon SNS 控制台来验证是否对您的主题启用了主动跟踪，或者资源策略是否添加失败。