Amazon X-Ray和 Step Functions - Amazon Step Functions
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Amazon X-Ray和 Step Functions

您可以使用Amazon X-Ray来可视化状态机的组件、确定性能瓶颈以及对导致错误的请求进行故障排除。您的状态机会将跟踪数据发送到 X-Ray,X-Ray 将处理这些数据以生成服务映射和可搜索的跟踪摘要。

为状态机启用 X-Ray 后,您可以在 X-Ray 可用的所有Amazon区域中跟踪在 Step Functions 中执行的请求。这将为您提供整个 Step Functions 请求的详细概述。即使上游服务未传递跟踪 ID,Step Functions 也会向 X-Ray 发送跟踪信息,以便执行状态机。您可以使用 X-Ray 服务地图,以查看请求的延迟,包括集成了 X-Ray 的任何Amazon服务。您还可以配置采样规则,以告知 X-Ray 根据您指定的标准以哪种采样率记录哪些请求。

如果未为状态机启用 X-Ray,并且上游服务未传递跟踪 ID,Step Functions 将不会向 X-Ray 发送跟踪以执行状态机。但是,如果跟踪 ID 由上游服务传递,Step Functions 会将跟踪发送到 X-Ray 以执行状态机。

在同时支持两者的区域,您可以Amazon X-Ray与Step Functions 一起使用。有关 X-Ray 和 Ste p 函数的区域支持的信息,请参阅 Step Functions 和 X-Ray 端点和配额页面。

X-Ray 和Step Functions 组合配额

您可以向跟踪中添加最多七天的数据,也可以查询三十天前的跟踪数据,即 X-Ray 存储跟踪数据的时间长度。您的踪迹将受到X-Ray 配额的限制。除其他配额外,X-Ray 还为 Step Functions 状态机提供的最小保证跟踪大小为 100KB。如果向 X-Ray 提供的跟踪数据超过 100KB,则可能导致跟踪数据冻结。有关 X-Ray 其他配额的更多信息,请参阅 X-Ray 端点和配额页面的服务配额部分。

设置和配置

创建状态机时启用 X-Ray 追踪

通过在 “指定详细信息” 页面上选择 “启用 X-Ray 跟踪”,可以在创建新状态机时启用 X-R ay 跟踪。

  1. 打开 Ste p Functions 控制台并选择 “创建状态机”。

  2. “选择创作方法” 页面上,选择相应的选项来创建状态机。如果选择 “运行示例项目”,则无法在创建状态机期间启用 X-Ray 跟踪,并且需要在创建状态机后启用 X-Ray 跟踪。有关在现有状态机中启用 X-Ray 的更多信息,请参见在现有状态机中启用 X-Ray

    选择 Next(下一步)

  3. 在 “指定详细信息” 页面上,配置您的状态机。

  4. 选择启用 X-R ay

    您的 Step Functions 状态机现在会向 X-Ray 发送跟踪以执行状态机。

    注意

    如果您选择使用现有 IAM 角色,则应确保允许 X-Ray 写入。有关所需权限的更多信息,请参阅 X-Ray 的 IAM 政策

在现有状态机中启用 X-Ray

要在现有状态机中启用 X-Ray,请执行以下操作:

  1. Step Functions 控制台中,选择要为其启用跟踪的状态机。

  2. 选择 Edit(编辑)。

  3. 选择启用 X-R ay

    您将看到一条通知,告诉您可能需要进行其他更改。

    注意

    为现有状态机启用 X-Ray 时,必须确保您有一个 IAM 策略,该策略为 X-Ray 授予足够的权限来执行跟踪。您可以手动添加一个,也可以生成一个。有关更多信息,请参阅的 IAM 政策部分X-Ray

  4. (可选)自动为状态机生成一个新角色,使其包含 X-Ray 权限。

  5. 选择 Save(保存)。

为 SteX-Ray Functions

首次运行启用 X-Ray 跟踪的状态机时,它将使用 X-Ray 跟踪的默认配置值。 Amazon X-Ray不会为发送到应用程序的每个请求收集数据。相反,它收集统计上数量众多的请求的数据。默认是每秒记录第一个请求,以及所有其他请求的百分之五。每秒一个请求是容器。这可确保只要服务正在处理请求,就会每秒至少记录一个跟踪。5% 是对超出容器尺寸的额外请求进行采样的比率

为避免在入门时产生服务费用,默认采样率是保守的。您可以配置 X-Ray 以修改默认采样规则,并配置其他规则,以根据服务或请求的属性应用采样。

例如,您可能需要禁用采样并跟踪所有修改状态或处理用户帐户或事务的调用请求。对于高容量的只读调用,例如后台轮询、运行状况检查或连接维护,您可以以低速率采样,但仍能获得足够的数据来观察所发生的问题。

要为状态机配置采样规则,请执行以下操作:

  1. 转到 X-Ray 控制台

  2. 选择 Sampling (采样)

  3. 要创建规则,请选择 Create sampling rule (创建采样规则)

    要编辑规则,请选择规则的名称。

    要删除规则,请选择一条规则并使用 Actions (操作) 菜单来删除它。

现有抽样规则的某些部分,例如名称和优先级,无法更改。相反,添加或克隆现有规则,进行所需的更改,然后使用新规则。

有关 X-Ray 采样规则以及如何配置各种参数的详细信息,请参阅在 X-Ray 控制台中配置采样规则

集成上游服务

要将 Step Functions 工作流(例如 Express、同步和标准工作流)的执行与上游服务相集成,您需要设置traceHeader。如果您在 API Gateway 中使用 HTTP API,则会自动为您完成此操作。但是,如果您使用的是 Lambda 函数和/或 SDK,则需要自己设置traceHeader开启StartExecutionStartSyncExecutionAPI 调用。

必须将traceHeader格式指定为\p{ASCII}∗。此外,要让 Step Functions 使用相同的跟踪 ID,必须将格式指定为Root={TRACE_ID};Sampled={1 or 0}。如果您使用的是 Lambda 函数,请在当前分段中将TRACE_ID替换为跟踪 ID,并将 Sampled 字段设置为假设您的采样模式为1 true,0如果您的采样模式为 false。以这种格式提供跟踪 ID 可确保您获得完整的追踪信息。

以下是用 Python 编写的示例,展示了如何指定traceHeader

state_machine = config.get_string_paramter("STATE_MACHINE_ARN") if (xray_recorder.current_subsegment() is not None and xray_recorder.current_subsegment().sampled) : trace_id = "Root={};Sampled=1".format( xray_recorder.current_subsegment().trace_id ) else: trace_id = "Root=not enabled;Sampled=0" LOGGER.info("trace %s", trace_id) # execute it response = states.start_sync_execution( stateMachineArn=state_machine, input=event['body'], name=context.aws_request_id, traceHeader=trace_id ) LOGGER.info(response)

概念

X-Ray

您可以使用 Amazon X-Ray 控制台查看您的应用程序所服务的请求的服务地图和跟踪。为状态机启用 X-Ray 后,您可以访问控制台查看 X-Ray 收集的详细信息。

查看 X-Ray有关如何访问 X-Ray 控制台执行状态机的信息,请参阅。

有关 X-Ray 控制台的详细信息,请参阅 X-Ray 控制台文档

区段、子分段和跟踪

记录有关向状态机发出的请求的信息。它包含诸如状态机执行的工作之类的信息,还可能包含包含下游调用信息的子分段

跟踪会收集单个请求生成的所有分段。

采样

为确保高效跟踪并提供应用程序所服务的请求的代表性样本,X-Ray 应用采样算法确定跟踪哪些请求。这可以通过编辑抽样规则来更改。

指标

对于您的状态机,X-Ray 将测量调用时间、状态转换时间、Step Functions 的总执行时间以及该执行时间的差异。可以通过 X-Ray 控制台访问。

分析

Amazon X-RayAnalytics 控制台是用于解释跟踪数据的交互式工具。您可以通过单击与当前跟踪集关联的指标和字段的图表和面板,使用越来越精细的筛选条件细化活动的数据集。这使您可以分析状态机的运行情况,并快速找到和识别性能问题。

有关 X-Ray 分析的详细信息,请参阅与Amazon X-Ray分析控制台交互

Step Functions 服务集成和 X-Ray

一些与 Step Functions 集成的Amazon服务Amazon X-Ray通过向请求添加跟踪标头、运行 X-Ray 守护程序或做出采样决策并将跟踪数据上传到 X-Ray 来提供集成。其他必须使用Amazon X-Ray SDK 进行检测。一些还不支持 X-Ray 集成。使用带有 Step Functions 的服务集成时,必须进行 X-Ray 集成才能提供完整的跟踪数据

原生X-Ray

与本机 X-Ray 支持的服务集成包括:

需要使用进行检测

需要 X-Ray 仪器的服务集成:

  • Amazon Elastic Container Service

  • Amazon Batch

  • Amazon Fargate

仅限客户端跟踪

其他服务集成不支持 X-Ray 但是,仍然可以收集客户端跟踪信息:

  • Amazon DynamoDB

  • Amazon EMR

  • 亚马逊 SageMaker

  • Amazon CodeBuild

  • Amazon Glue

查看 X-Ray

X-Ray 以分段形式接收来自服务的数据。X-Ray 将具有共同请求的片段分组为轨迹。X-Ray 对跟踪进行处理以生成服务图,该图可直观地呈现您的应用程序。

开始执行状态机后,可以通过选择 “执行详细信息” 部分中的 X-Ray 跟踪映射链接来查看其 X-Ray 轨迹线。


        X-Ray

为状态机启用了 X-Ray 后,可以在 X-Ray 控制台中查看其执行的跟踪信息。

查看 StX-Ray p Functions

以下步骤说明了启用 X-Ray 并运行执行后,可以在控制台中看到什么样的信息。显示了回调模式示例(Amazon SQS、Amazon SNS,Lambda) 样本项目的 X-Ray

跟踪

执行完成后,您可以导航到 X-Ray 控制台,在那里您将看到 X-Ray Tr aces 页面。这将显示服务映射的概述以及状态机的跟踪和分段信息。


        X-Ray

服务地图

X-Ray 控制台中的服务映射可帮助您识别出现错误的服务、存在高延迟连接的服务,或者查看失败请求的跟踪信息。


        X-Ray

在跟踪图上,您可以选择一个服务节点来查看对该节点的请求,或者选择两个节点之间的边来查看通过该连接的请求。在这里,WaitForCallBack节点已被选中,您可以查看有关其执行和响应状态的其他信息。


        X-Ray

您可以看到 X-Ray 服务地图与状态机的关系。Step Functions 调用的每个服务集成都有一个服务映射节点,前提是它支持 X-Ray。


        X-Ray

分段和子分段

跟踪是由单个请求生成的区段集合。每个分段都提供资源的名称、有关请求的详细信息以及有关已完成工作的详细信息。在 “跟踪” 页面上,您可以看到分段及其相应的子分段(如果已展开)。您可以选择一个分段或子分段来查看有关它的详细信息。

选择每个选项卡,查看区段和子分段信息的显示方式。

Overview of Segments

此状态机的分段和子分段概述。服务映射上的每个节点都有不同的分段。


              分段
View segment detail

选择区段将提供资源的名称、有关请求的详细信息以及有关已完成工作的详细信息。


              分段详细信息
View subsegment detail

分段可以将有关已完成工作的数据分解为子分段。选择子分段可让您查看更精细的时间信息和细节。子分段可以包含有关Amazon服务调用、外部 HTTP API 或 SQL 数据库的其他详细信息。


              分段详细信息

分析

Amazon X-RayAnalytics 控制台是用于解释跟踪数据的交互式工具。你可以用它来更容易地理解你的状态机的运行情况。借助该控制台,您可以通过交互式响应时间图表和时间序列图表探索、分析和直观地显示跟踪。这可以帮助您快速找到性能和延迟问题。

您可以通过单击与当前跟踪集关联的指标和字段的图表和面板,使用越来越精细的筛选条件细化活动的数据集。


        分析

配置

您可以从 X-Ray 控制台配置采样和加密选项。

Sampling

选择 “采样” 以查看有关采样率和配置的详细信息。您可以更改采样规则以控制您记录的数据量,也可以修改采样行为以满足您的特定要求。


              采样
Encryption

选择 “加密” 以修改加密设置。您可以使用默认设置,其中 X-Ray 会加密轨迹和静止日期,或者,如果需要,您可以选择客户主密钥。标准Amazon KMS费用适用于后一种情况。

如果追踪图或服务图中没有数据怎么办?

如果您已启用 X-Ray,但在 X-Ray 控制台中看不到任何数据,请检查以下内容:

  • 您的 IAM 角色设置正确,允许写入 X-Ray。

  • 采样规则允许对数据进行采样。

  • 由于在应用新创建或修改的 IAM 角色之前可能会有很短的延迟,因此请在几分钟后再次检查跟踪或服务映射。

  • 如果您在 X-Ray Traces 面板中看到 “未找到数据”,请检查您Amazon Security Token Service的 IAM 账户设置并确保在目标区域启用该设置。有关更多信息,请参阅 IAM 用户指南