使用 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 支持 X-Ray SDK 中提供的所有功能，包括其他 AWS 服务功能。以下函数是前面列出的 API 操作的版本，格式更简单：

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

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

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

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

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

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

主题