X-Ray
Implementation details for API xray
Coverage Overview
X-Ray
is supported by LocalStack
only in the pro image.
| Availability | Testing* | |||||||
|---|---|---|---|---|---|---|---|---|
| Operation | Implemented | Image | Internal Test Suite | External Test Suite | Terraform Validated | AWS Validated | Snapshot Tested | Details |
| BatchGetTraces | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
| CreateGroup | ||||||||
| CreateSamplingRule | ✔️ | pro | ✔️ | Show Tests | ||||
| DeleteGroup | ||||||||
| DeleteResourcePolicy | ||||||||
| DeleteSamplingRule | ✔️ | pro | ✔️ | Show Tests | ||||
| GetEncryptionConfig | ||||||||
| GetGroup | ||||||||
| GetGroups | ||||||||
| GetInsight | ||||||||
| GetInsightEvents | ||||||||
| GetInsightImpactGraph | ||||||||
| GetInsightSummaries | ||||||||
| GetSamplingRules | ✔️ | pro | ✔️ | Show Tests | ||||
| GetSamplingStatisticSummaries | ||||||||
| GetSamplingTargets | ||||||||
| GetServiceGraph | ✔️ | pro | ✔️ | |||||
| GetTimeSeriesServiceStatistics | ||||||||
| GetTraceGraph | ✔️ | pro | ||||||
| GetTraceSummaries | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
| ListResourcePolicies | ||||||||
| ListTagsForResource | ||||||||
| PutEncryptionConfig | ||||||||
| PutResourcePolicy | ||||||||
| PutTelemetryRecords | ✔️ | pro | ✔️ | ✔️ | Show Tests | |||
| PutTraceSegments | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
| TagResource | ||||||||
| UntagResource | ||||||||
| UpdateGroup | ||||||||
| UpdateSamplingRule | ✔️ | pro | ✔️ | Show Tests | ||||
Terminology
- Internal Test Suite: tested by LocalStack's internal integration test suite
- External Test Suite: covered by an external integration test suite, that runs against LocalStack
- Terraform Validated: operation tested with Terraform
- AWS Validated: the integration test that includes this operation call was validated against AWS
- Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same
Testing Details
This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.How to read the test details?
For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the exeuction of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.
Those operation calls have been recorded during the exeuction of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.
- Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
- Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
- test name
- status code returned (which is the expected one for the test case)
- information about validation:
- AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
- Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS
BatchGetTraces
Parameters: TraceIds
- LocalStack Pro
- test_basic_xray_integration LocalStack Pro: tests/aws/services/lambda_/test_lambda_xray.py::TestLambdaXrayIntegration::test_basic_xray_integration HTTP Status Code: 200 AWS validated
CreateSamplingRule
Parameters: SamplingRule
- LocalStack Pro
- test_create_and_get_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_create_and_get_sampling_rule HTTP Status Code: 200
- test_create_existing_sampling_rule_raises_exception LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_create_existing_sampling_rule_raises_exception HTTP Status Code: 200
- test_delete_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_delete_sampling_rule HTTP Status Code: 200
- test_update_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_update_sampling_rule HTTP Status Code: 200
- test_create_existing_sampling_rule_raises_exception LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_create_existing_sampling_rule_raises_exception HTTP Status Code: 400 (InvalidRequestException)
DeleteSamplingRule
Parameters: RuleName
- LocalStack Pro
- test_create_and_get_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_create_and_get_sampling_rule HTTP Status Code: 200
- test_create_existing_sampling_rule_raises_exception LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_create_existing_sampling_rule_raises_exception HTTP Status Code: 200
- test_delete_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_delete_sampling_rule HTTP Status Code: 200
- test_update_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_update_sampling_rule HTTP Status Code: 200
- test_delete_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_delete_sampling_rule HTTP Status Code: 400 (InvalidRequestException)
GetSamplingRules
Parameters: - (without any parameters)
- LocalStack Pro
- test_create_and_get_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_create_and_get_sampling_rule HTTP Status Code: 200
- test_delete_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_delete_sampling_rule HTTP Status Code: 200
- test_update_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_update_sampling_rule HTTP Status Code: 200
GetTraceSummaries
Parameters: EndTime, StartTime
- LocalStack Pro
- test_basic_xray_integration LocalStack Pro: tests/aws/services/lambda_/test_lambda_xray.py::TestLambdaXrayIntegration::test_basic_xray_integration HTTP Status Code: 200 AWS validated
- test_custom_xray_records_endpoint LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_custom_xray_records_endpoint HTTP Status Code: 200
- test_put_and_get_trace_segments LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_put_and_get_trace_segments HTTP Status Code: 200
PutTelemetryRecords
Parameters: TelemetryRecords
- LocalStack Pro
- test_put_records LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_put_records HTTP Status Code: 200
PutTraceSegments
Parameters: TraceSegmentDocuments
- LocalStack Pro
- test_basic_xray_integration LocalStack Pro: tests/aws/services/lambda_/test_lambda_xray.py::TestLambdaXrayIntegration::test_basic_xray_integration HTTP Status Code: 200 AWS validated
- test_custom_xray_records_endpoint LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_custom_xray_records_endpoint HTTP Status Code: 200
- test_put_and_get_trace_segments LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_put_and_get_trace_segments HTTP Status Code: 200
UpdateSamplingRule
Parameters: SamplingRuleUpdate
- LocalStack Pro
- test_update_sampling_rule LocalStack Pro: tests/aws/services/xray/test_xray.py::TestXRay::test_update_sampling_rule HTTP Status Code: 200
Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)