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

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

使用 X-Ray API

如果 X-Ray SDK 不支持你的编程语言,你可以 APIs 直接使用 X-Ray 或 Amazon Command Line Interface (Amazon CLI) 来调用 X-Ray API 命令。使用以下指南来选择与 API 的交互方式:

  • 使用 Amazon CLI 预先格式化的命令或请求中的选项来简化语法。

  • 直接使用 X-Ray API,以大幅提高灵活性,并根据您向 X-Ray 提出的请求进行自定义。

如果您直接使用 X-Ray API 而不是 Amazon CLI,则必须以正确的数据格式对请求进行参数化,可能还必须配置身份验证和错误处理。

下图显示了相关指南,可帮助您选择与 X-Ray API 的交互方式:

X-Ray 显示有关应用程序请求的详细信息。

使用 X-Ray API 将跟踪数据直接发送到 X-Ray。X-Ray API 支持 X-Ray SDK 中提供的所有功能,包括以下常见操作:

  • PutTraceSegments— 将分段文档上传到 X-Ray。

  • BatchGetTraces— 检索跟踪列表中的跟踪 IDs列表。检索到的每个跟踪是一组来自单个请求的分段文档。

  • GetTraceSummaries— 检索轨迹 IDs 并对其进行注释。您可以指定 FilterExpression 来检索跟踪摘要的子集。

  • GetTraceGraph— 检索特定跟踪 ID 的服务图表。

  • GetServiceGraph— 检索 JSON 格式化文档,描述处理传入请求和调用下游请求的服务。

您还可以在应用程序代码中使用 Amazon Command Line Interface (Amazon CLI) 以编程方式与 X-Ray 进行交互。 Amazon CLI 支持 X-Ray SDK 中可用的所有功能,包括其他功能 Amazon Web Services 服务。以下函数是前面列出的 API 操作的版本,格式更简单:

  • put-trace-segments— 将分段文档上传到 X-Ray。

  • batch-get-traces— 检索跟踪列表中的跟踪 IDs列表。检索到的每个跟踪是一组来自单个请求的分段文档。

  • get-trace-summaries— 检索轨迹 IDs 并对其进行注释。您可以指定 FilterExpression 来检索跟踪摘要的子集。

  • get-trace-graph— 检索特定跟踪 ID 的服务图表。

  • get-service-graph— 检索JSON格式化文档,该文档描述了处理传入请求和调用下游请求的服务。

要开始使用,您必须Amazon CLI为自己的操作系统安装。 Amazon 支持 Linux, macOS 以及 Windows 操作系统。有关 X-Ray 命令列表的更多信息,请参阅针对 X-Ray 的Amazon CLI 命令参考指南