使用 SDK - AWS X-Ray

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

使用 SDK

注意

End-of-support 注意 — 2027 年 2 月 25 日, AWS X-Ray 将停止对 AWS X-Ray SDKs 和守护程序的支持。2027 年 2 月 25 日之后,您将不再收到更新或发布。有关支持时间表的更多信息,请参阅X-Ray SDK 和守护程序终止支持时间表。我们建议迁移到 OpenTelemetry。有关迁移到的更多信息 OpenTelemetry,请参阅从 X-Ray 仪器迁移到 OpenTelemetry 仪器

如果您想使用命令行界面,或者需要的自定义跟踪、监控或日志记录功能超出 AWS Management Console中提供的范围,请使用 SDK。您也可以使用 S AWS DK 开发使用 X-Ray 的程序 APIs。你可以使用 AWS Distro for OpenTelemetry (ADOT) SDK 或 X-Ray SDK。

如果您使用 SDK,则可以在检测应用程序和配置收集器或代理时为工作流添加自定义。您可以使用 SDK 来执行以下无法使用 AWS Management Console完成的任务:

  • 发布自定义指标 - 以低至 1 秒的高分辨率对指标采样,使用多个维度添加有关指标的信息,并将数据点聚合到统计数据集中。

  • 自定义收集器 - 自定义收集器任何部分的配置,包括接收器、处理器、导出器和连接器。

  • 自定义您的检测 - 自定义分段和子分段,将自定义键值对添加为属性,并创建自定义指标。

  • 以编程方式创建和更新采样规则。

如果您想灵活地ADOT使用具有额外 AWS 安全性和优化层的标准化 OpenTelemetry SDK,请使用 SDK。 AWS Distro fo ADOT r OpenTelemetry () SDK 是一个与供应商无关的软件包,它允许与其他供应商和非AWS 服务的后端集成,而无需重新分析代码。

如果您已经在使用 X-Ray SDK,只与 AWS 后端集成,并且不想更改与 X-Ray 或应用程序代码的交互方式,请使用 X-Ray SDK。

有关每项特征的更多信息,请参阅在 AWS Distro for 和 X-Ray OpenTelemetry 之间进行选择 SDKs

使用 ADOT SDK

S ADOT DK 是一组向后端服务发送数据的开源 APIs、库和代理。 ADOT由多个后端和代理支持 AWS,与多个后端和代理集成,并提供大量由OpenTelemetry社区维护的开源库。使用 ADOT SDK 可检测您的应用程序并收集日志、元数据、指标和跟踪。您还可以ADOT使用监控服务并根据中的指标设置警报 CloudWatch。

如果您使用的是 ADOT SDK,则可以将以下选项与代理结合使用:

  • 将 ADOT SDK 与CloudWatch 代理一起使用 — 推荐。

  • 将 ADOT SDK 与 ADOTCollect or 配合使用 — 如果您想使用具有多 AWS 层安全性和优化的独立于供应商的软件,则建议使用。

要使用 ADOT SDK,请执行以下操作:

  • 使用 ADOT SDK 检测您的应用程序。有关更多信息,请参阅 ADOT 技术文档中适用于编程语言的文档。

  • 配置 ADOT 收集器以告知其将收集的数据发送到何处。

ADOT收集器收到您的数据后,会将其发送到您在ADOT配置中指定的后端。 ADOT可以将数据发送到多个后端,包括外部的供应商 AWS,如下图所示:

在检测应用程序并配置收集器时,可以自定义 ADOT 收集器。

AWS 定期更新ADOT以增加功能并与OpenTelemetry框架保持一致。开发 ADOT 的更新和未来计划是向公众开放的路线图的一部分。ADOT 支持多种编程语言,其中包括:

  • Go

  • Java

  • JavaScript

  • Python

  • .NET

  • Ruby

  • PHP

如果您使用的是 Python,则 ADOT 可以自动检测您的应用程序。要开始使用ADOT,请参阅 Collecto OpenTelemetry r AWS 发行版简介和入门

使用 X-Ray SDK

X-Ray SDK 是一组向 AWS 后端服务发送数据的 AWS APIs 和库。使用 X-Ray SDK 可检测您的应用程序并收集跟踪数据。您无法使用 X-Ray SDK 收集日志或指标数据。

如果您使用的是 X-Ray SDK,则可以将以下选项与代理结合使用:

  • 结合使用 X-Ray SDK 和 AWS X-Ray 守护程序 - 如果您不想更新应用程序代码,请使用此选项。

  • 将 X-Ray SDK 与 CloudWatch 代理一起使用 —(推荐) CloudWatch 代理与 X-Ray SDK 兼容。

要使用 X-Ray SDK,请执行以下操作:

  • 使用 X-Ray SDK 检测您的应用程序。

  • 配置收集器以告知其将收集到的数据发送到何处。您可以使用 CloudWatch 代理或 X-Ray 守护程序来收集您的跟踪信息。

收集器或代理收到您的数据后,它会将其发送到您在代理配置中指定的 AWS 后端。X-Ray SDK 只能向 AWS 后端发送数据,如下图所示:

将 X-Ray SDK 与 CloudWatch 代理或 X-Ray 守护程序一起使用。

如果您使用的是 Java,则可以使用 X-Ray SDK 自动检测您的应用程序。要开始使用 X-Ray SDK,请查看与以下编程语言相关的库: