View a markdown version of this page

使用 X-Ray API - AWS X-Ray

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

使用 X-Ray API

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

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

  • 直接使用 X-Ray API 可最大限度地提高灵活性,并对您提出的请求进行自定义 X-Ray。

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

下图显示了选择如何与 X-Ray API 交互的指南:

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

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

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

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

  • GetTraceSummaries— 检索痕迹的 ID 和注释。您可以指定 FilterExpression 来检索跟踪摘要的子集。

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

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

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

  • put-trace-segment s — 将区段文档上传到。 X-Ray

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

  • get-trace-summaries - 检索跟踪的 ID 和注释。您可以指定 FilterExpression 来检索跟踪摘要的子集。

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

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

要开始使用,必须安装AWS CLI适用于您的操作系统的。 AWS 支持LinuxmacOS和Windows操作系统。有关 X-Ray 命令列表的更多信息,请参阅的AWS CLI 命令参考指南 X-Ray。