使用 X-Ray API - AWS X-Ray

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

使用 X-Ray API

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

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

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

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

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

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

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

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

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

  • GetTraceSummaries— 检索轨迹IDs并对其进行注释。您可以指定 a 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— 检索跟踪列表中的跟踪IDs列表。检索到的每条跟踪都是来自单个请求的分段文档的集合。

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

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

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

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