通过 X-Ray API 使用采样规则 - AWS X-Ray
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

通过 X-Ray API 使用采样规则

AWS X-Ray 开发工具包使用 X-Ray API 获取采样规则、报告采样结果并获取配额。您可以使用这些 API 来更好地了解采样规则的工作方式或采用 X-Ray 开发工具包不支持的语言进行采样。

首先利用 GetSamplingRules 获取所有采样规则。

$ aws xray get-sampling-rules { "SamplingRuleRecords": [ { "SamplingRule": { "RuleName": "Default", "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/Default", "ResourceARN": "*", "Priority": 10000, "FixedRate": 0.01, "ReservoirSize": 0, "ServiceName": "*", "ServiceType": "*", "Host": "*", "HTTPMethod": "*", "URLPath": "*", "Version": 1, "Attributes": {} }, "CreatedAt": 0.0, "ModifiedAt": 1530558121.0 }, { "SamplingRule": { "RuleName": "base-scorekeep", "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/base-scorekeep", "ResourceARN": "*", "Priority": 9000, "FixedRate": 0.1, "ReservoirSize": 2, "ServiceName": "Scorekeep", "ServiceType": "*", "Host": "*", "HTTPMethod": "*", "URLPath": "*", "Version": 1, "Attributes": {} }, "CreatedAt": 1530573954.0, "ModifiedAt": 1530920505.0 }, { "SamplingRule": { "RuleName": "polling-scorekeep", "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/polling-scorekeep", "ResourceARN": "*", "Priority": 5000, "FixedRate": 0.003, "ReservoirSize": 0, "ServiceName": "Scorekeep", "ServiceType": "*", "Host": "*", "HTTPMethod": "GET", "URLPath": "/api/state/*", "Version": 1, "Attributes": {} }, "CreatedAt": 1530918163.0, "ModifiedAt": 1530918163.0 } ] }

输出包含默认规则和自定义规则。如果您尚未创建采样规则,请参阅采样规则

针对传入请求按优先级的上升顺序评估规则。如果规则匹配,请使用固定比率和容器大小来做出采样决定。记录采样的请求并忽略(用于跟踪目的)未采样的请求。在做出采样决定后停止评估规则。

规则容器大小是在应用固定比率之前每秒要记录的跟踪的目标数量。该容器在所有服务中以累计方式应用,因此您无法直接使用它。但是,如果它是非零值,您可以每秒从容器借用一个跟踪,直到 X-Ray 分配配额。在接收配额之前,记录每秒的第一个请求,然后将固定比率应用于其他请求。固定比率是介于 0 和 1.00 (100%) 之间的小数。

以下示例显示了对 GetSamplingTargets 的调用以及有关在过去 10 秒内所做的采样决定的详细信息。

$ aws xray get-sampling-targets --sampling-statistics-documents '[ { "RuleName": "base-scorekeep", "ClientID": "ABCDEF1234567890ABCDEF10", "Timestamp": "2018-07-07T00:20:06, "RequestCount": 110, "SampledCount": 20, "BorrowCount": 10 }, { "RuleName": "polling-scorekeep", "ClientID": "ABCDEF1234567890ABCDEF10", "Timestamp": "2018-07-07T00:20:06", "RequestCount": 10500, "SampledCount": 31, "BorrowCount": 0 } ]' { "SamplingTargetDocuments": [ { "RuleName": "base-scorekeep", "FixedRate": 0.1, "ReservoirQuota": 2, "ReservoirQuotaTTL": 1530923107.0, "Interval": 10 }, { "RuleName": "polling-scorekeep", "FixedRate": 0.003, "ReservoirQuota": 0, "ReservoirQuotaTTL": 1530923107.0, "Interval": 10 } ], "LastRuleModification": 1530920505.0, "UnprocessedStatistics": [] }

来自 X-Ray 的响应包含要使用的配额(而不是从容器借用)。在本示例中,服务在 10 秒内从容器借用了 10 个跟踪,并且将固定比率 10% 应用于其他 100 个请求,从而产生总共 20 个已采样请求。该配额适用于 5 分钟时间(由生存时间表示)或持续到分配新配额。X-Ray 也可分配一个长于默认值的报告时间间隔(但它在此处没有分配)。

注意

来自 X-Ray 的响应可能不包含您首次调用它时的配额。继续从容器借用,直到您获得一个配额。

响应中的另外两个字段可能指示输入存在问题。请针对上一次 GetSamplingRules 调用检查 LastRuleModification。如果它较新,则获取规则的新副本。UnprocessedStatistics 可包含指示规则已被删除、输入中的统计数据文档过旧或权限错误的错误。