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

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

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

X-Ray 开发工具包使用 AWS 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 条跟踪,并对其他 100 个请求应用了 10% 的固定速率,结果共有 20 个采样请求。配额有效期为五分钟(按生存时间表示),或者直到分配新的配额为止。X-Ray 也可能指定比默认报告间隔更长的间隔,尽管这里没有这样做。

注意

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

响应中的其他两个字段可能表示输入有问题。请针对上一次 GetSamplingRules 调用检查 LastRuleModification。如果较新,则获取相应规则的新副本。UnprocessedStatistics 可以包括指示规则已删除、输入中的统计文档太旧或权限错误的错误。