AWS xray documentation change
Summary
Expanded adaptive sampling documentation with Python support and new DisableDefaultAnomalyDetection parameter
Security assessment
Adds operational controls for telemetry sampling (fault monitoring configuration). No evidence of security vulnerability remediation; changes are feature enhancements for observability.
Diff
diff --git a/xray/latest/devguide/xray-adaptive-sampling.md b/xray/latest/devguide/xray-adaptive-sampling.md index 0394bf5b7..0d7bea758 100644 --- a//xray/latest/devguide/xray-adaptive-sampling.md +++ b//xray/latest/devguide/xray-adaptive-sampling.md @@ -37 +37,9 @@ Benefits of using adaptive sampling: -**Supported SDK** – Adaptive sampling requires the latest version of the ADOT SDK. +**Supported SDK** – Adaptive sampling requires the AWS Distro for OpenTelemetry (ADOT) SDK. + +**Supported languages** + + * Java (version [v2.11.5](https://github.com/aws-observability/aws-otel-java-instrumentation/releases/tag/v2.11.5) or higher) + + * Python (version [v0.15.0](https://github.com/aws-observability/aws-otel-python-instrumentation/releases/tag/v0.15.0) or higher) + + @@ -39 +46,0 @@ Benefits of using adaptive sampling: -**Supported language** – Java (version [v2.11.5](https://github.com/aws-observability/aws-otel-java-instrumentation/releases/tag/v2.11.5) or higher) @@ -125 +132,2 @@ The `SamplingRateBoost` field defines the upper bound and behavior for anomaly-d - "CooldownWindowMinutes": 10 + "CooldownWindowMinutes": 10, + "DisableDefaultAnomalyDetection": false @@ -132,0 +141,2 @@ The `CooldownWindowMinutes` defines time window (in minutes) in which only one s +The `DisableDefaultAnomalyDetection` controls whether the ADOT SDK uses the built-in default anomaly condition (HTTP 5xx fault responses) to trigger a sampling boost. The value type is _boolean_ and the default is `false`. When set to `true`, the SDK will no longer boost sampling on HTTP 5xx responses by default. In that case, a boost is only triggered by anomaly conditions that you define explicitly through the Local SDK configuration. Use this when you want full control over what constitutes an anomaly (for example, only specific error codes or latency thresholds) and want to avoid boosts on all 5xx responses. + @@ -157 +167 @@ In this example, baseline sampling is 5% (`FixedRate: 0.05`). During anomalies, -When no anomaly condition configuration is provided, the ADOT SDK uses **HTTP 5xx error codes** as the default anomaly condition to trigger sampling boost. +When no anomaly condition configuration is provided, the ADOT SDK uses **HTTP 5xx error codes** as the default anomaly condition to trigger sampling boost. You can disable this default by setting `DisableDefaultAnomalyDetection` to `true` on the `SamplingRateBoost` field.