aws-sdk-xray 1.77.0 → 1.79.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-xray/client.rb +479 -14
- data/lib/aws-sdk-xray/client_api.rb +237 -0
- data/lib/aws-sdk-xray/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-xray/types.rb +461 -5
- data/lib/aws-sdk-xray.rb +1 -1
- data/sig/client.rbs +98 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +156 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 45faebf65dac03920c0185775fdb5284ca472d0de08420c9b4253c68b6bb703e
|
4
|
+
data.tar.gz: 8bb96f7afb187182171e06297e5bfd86532b95a530b54fd2946c17ae38b35937
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0b4ed769773dd6229f6db3b9a8e796d2d1a13f4bac21b21fea43a82ae2d2cb84deffe1daa6a490ddc509dd872e91b21af2420b18afa070a7d49825d7bb0993a5
|
7
|
+
data.tar.gz: 603370adf275299a99e69fca9edaa4603b3aac20e10ce68af597a5aad30628645ec40b24cf0974d68c1054dcb905c50f8d7880d72b9789d031fd2d33546b65a5
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.79.0 (2025-01-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.78.0 (2024-11-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - AWS X-Ray introduces Transaction Search APIs, enabling span ingestion into CloudWatch Logs for high-scale trace data indexing. These APIs support span-level queries, trace graph generation, and metric correlation for deeper application insights.
|
13
|
+
|
4
14
|
1.77.0 (2024-10-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.79.0
|
data/lib/aws-sdk-xray/client.rb
CHANGED
@@ -257,11 +257,34 @@ module Aws::XRay
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -447,6 +470,11 @@ module Aws::XRay
|
|
447
470
|
|
448
471
|
# @!group API Operations
|
449
472
|
|
473
|
+
# <note markdown="1"> You cannot find traces through this API if Transaction Search is
|
474
|
+
# enabled since trace is not indexed in X-Ray.
|
475
|
+
#
|
476
|
+
# </note>
|
477
|
+
#
|
450
478
|
# Retrieves a list of traces specified by ID. Each trace is a collection
|
451
479
|
# of segment documents that originates from a single request. Use
|
452
480
|
# `GetTraceSummaries` to get a list of trace IDs.
|
@@ -494,6 +522,30 @@ module Aws::XRay
|
|
494
522
|
req.send_request(options)
|
495
523
|
end
|
496
524
|
|
525
|
+
# Cancels an ongoing trace retrieval job initiated by
|
526
|
+
# `StartTraceRetrieval` using the provided `RetrievalToken`. A
|
527
|
+
# successful cancellation will return an HTTP 200 response.
|
528
|
+
#
|
529
|
+
# @option params [required, String] :retrieval_token
|
530
|
+
# Retrieval token.
|
531
|
+
#
|
532
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
533
|
+
#
|
534
|
+
# @example Request syntax with placeholder values
|
535
|
+
#
|
536
|
+
# resp = client.cancel_trace_retrieval({
|
537
|
+
# retrieval_token: "RetrievalToken", # required
|
538
|
+
# })
|
539
|
+
#
|
540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CancelTraceRetrieval AWS API Documentation
|
541
|
+
#
|
542
|
+
# @overload cancel_trace_retrieval(params = {})
|
543
|
+
# @param [Hash] params ({})
|
544
|
+
def cancel_trace_retrieval(params = {}, options = {})
|
545
|
+
req = build_request(:cancel_trace_retrieval, params)
|
546
|
+
req.send_request(options)
|
547
|
+
end
|
548
|
+
|
497
549
|
# Creates a group resource with a name and a filter expression.
|
498
550
|
#
|
499
551
|
# @option params [required, String] :group_name
|
@@ -878,6 +930,49 @@ module Aws::XRay
|
|
878
930
|
req.send_request(options)
|
879
931
|
end
|
880
932
|
|
933
|
+
# Retrieves all indexing rules.
|
934
|
+
#
|
935
|
+
# Indexing rules are used to determine the server-side sampling rate for
|
936
|
+
# spans ingested through the CloudWatchLogs destination and indexed by
|
937
|
+
# X-Ray. For more information, see [Transaction Search][1].
|
938
|
+
#
|
939
|
+
#
|
940
|
+
#
|
941
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
|
942
|
+
#
|
943
|
+
# @option params [String] :next_token
|
944
|
+
# Specify the pagination token returned by a previous request to
|
945
|
+
# retrieve the next page of indexes.
|
946
|
+
#
|
947
|
+
# @return [Types::GetIndexingRulesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
948
|
+
#
|
949
|
+
# * {Types::GetIndexingRulesResult#indexing_rules #indexing_rules} => Array<Types::IndexingRule>
|
950
|
+
# * {Types::GetIndexingRulesResult#next_token #next_token} => String
|
951
|
+
#
|
952
|
+
# @example Request syntax with placeholder values
|
953
|
+
#
|
954
|
+
# resp = client.get_indexing_rules({
|
955
|
+
# next_token: "String",
|
956
|
+
# })
|
957
|
+
#
|
958
|
+
# @example Response structure
|
959
|
+
#
|
960
|
+
# resp.indexing_rules #=> Array
|
961
|
+
# resp.indexing_rules[0].name #=> String
|
962
|
+
# resp.indexing_rules[0].modified_at #=> Time
|
963
|
+
# resp.indexing_rules[0].rule.probabilistic.desired_sampling_percentage #=> Float
|
964
|
+
# resp.indexing_rules[0].rule.probabilistic.actual_sampling_percentage #=> Float
|
965
|
+
# resp.next_token #=> String
|
966
|
+
#
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetIndexingRules AWS API Documentation
|
968
|
+
#
|
969
|
+
# @overload get_indexing_rules(params = {})
|
970
|
+
# @param [Hash] params ({})
|
971
|
+
def get_indexing_rules(params = {}, options = {})
|
972
|
+
req = build_request(:get_indexing_rules, params)
|
973
|
+
req.send_request(options)
|
974
|
+
end
|
975
|
+
|
881
976
|
# Retrieves the summary information of an insight. This includes impact
|
882
977
|
# to clients and root cause services, the top anomalous services, the
|
883
978
|
# category, the state of the insight, and the start and end time of the
|
@@ -1149,6 +1244,119 @@ module Aws::XRay
|
|
1149
1244
|
req.send_request(options)
|
1150
1245
|
end
|
1151
1246
|
|
1247
|
+
# Retrieves a service graph for traces based on the specified
|
1248
|
+
# `RetrievalToken` from the CloudWatch log group generated by
|
1249
|
+
# Transaction Search. This API does not initiate a retrieval job. You
|
1250
|
+
# must first execute `StartTraceRetrieval` to obtain the required
|
1251
|
+
# `RetrievalToken`.
|
1252
|
+
#
|
1253
|
+
# The trace graph describes services that process incoming requests and
|
1254
|
+
# any downstream services they call, which may include Amazon Web
|
1255
|
+
# Services resources, external APIs, or databases.
|
1256
|
+
#
|
1257
|
+
# The response is empty until the `RetrievalStatus` is *COMPLETE*. Retry
|
1258
|
+
# the request after the status changes from *RUNNING* or *SCHEDULED* to
|
1259
|
+
# *COMPLETE* to access the full service graph.
|
1260
|
+
#
|
1261
|
+
# When CloudWatch log is the destination, this API can support
|
1262
|
+
# cross-account observability and service graph retrieval across linked
|
1263
|
+
# accounts.
|
1264
|
+
#
|
1265
|
+
# For retrieving graphs from X-Ray directly as opposed to the
|
1266
|
+
# Transaction-Search Log group, see [GetTraceGraph][1].
|
1267
|
+
#
|
1268
|
+
#
|
1269
|
+
#
|
1270
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html
|
1271
|
+
#
|
1272
|
+
# @option params [required, String] :retrieval_token
|
1273
|
+
# Retrieval token.
|
1274
|
+
#
|
1275
|
+
# @option params [String] :next_token
|
1276
|
+
# Specify the pagination token returned by a previous request to
|
1277
|
+
# retrieve the next page of indexes.
|
1278
|
+
#
|
1279
|
+
# @return [Types::GetRetrievedTracesGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1280
|
+
#
|
1281
|
+
# * {Types::GetRetrievedTracesGraphResult#retrieval_status #retrieval_status} => String
|
1282
|
+
# * {Types::GetRetrievedTracesGraphResult#services #services} => Array<Types::RetrievedService>
|
1283
|
+
# * {Types::GetRetrievedTracesGraphResult#next_token #next_token} => String
|
1284
|
+
#
|
1285
|
+
# @example Request syntax with placeholder values
|
1286
|
+
#
|
1287
|
+
# resp = client.get_retrieved_traces_graph({
|
1288
|
+
# retrieval_token: "RetrievalToken", # required
|
1289
|
+
# next_token: "String",
|
1290
|
+
# })
|
1291
|
+
#
|
1292
|
+
# @example Response structure
|
1293
|
+
#
|
1294
|
+
# resp.retrieval_status #=> String, one of "SCHEDULED", "RUNNING", "COMPLETE", "FAILED", "CANCELLED", "TIMEOUT"
|
1295
|
+
# resp.services #=> Array
|
1296
|
+
# resp.services[0].service.reference_id #=> Integer
|
1297
|
+
# resp.services[0].service.name #=> String
|
1298
|
+
# resp.services[0].service.names #=> Array
|
1299
|
+
# resp.services[0].service.names[0] #=> String
|
1300
|
+
# resp.services[0].service.root #=> Boolean
|
1301
|
+
# resp.services[0].service.account_id #=> String
|
1302
|
+
# resp.services[0].service.type #=> String
|
1303
|
+
# resp.services[0].service.state #=> String
|
1304
|
+
# resp.services[0].service.start_time #=> Time
|
1305
|
+
# resp.services[0].service.end_time #=> Time
|
1306
|
+
# resp.services[0].service.edges #=> Array
|
1307
|
+
# resp.services[0].service.edges[0].reference_id #=> Integer
|
1308
|
+
# resp.services[0].service.edges[0].start_time #=> Time
|
1309
|
+
# resp.services[0].service.edges[0].end_time #=> Time
|
1310
|
+
# resp.services[0].service.edges[0].summary_statistics.ok_count #=> Integer
|
1311
|
+
# resp.services[0].service.edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
|
1312
|
+
# resp.services[0].service.edges[0].summary_statistics.error_statistics.other_count #=> Integer
|
1313
|
+
# resp.services[0].service.edges[0].summary_statistics.error_statistics.total_count #=> Integer
|
1314
|
+
# resp.services[0].service.edges[0].summary_statistics.fault_statistics.other_count #=> Integer
|
1315
|
+
# resp.services[0].service.edges[0].summary_statistics.fault_statistics.total_count #=> Integer
|
1316
|
+
# resp.services[0].service.edges[0].summary_statistics.total_count #=> Integer
|
1317
|
+
# resp.services[0].service.edges[0].summary_statistics.total_response_time #=> Float
|
1318
|
+
# resp.services[0].service.edges[0].response_time_histogram #=> Array
|
1319
|
+
# resp.services[0].service.edges[0].response_time_histogram[0].value #=> Float
|
1320
|
+
# resp.services[0].service.edges[0].response_time_histogram[0].count #=> Integer
|
1321
|
+
# resp.services[0].service.edges[0].aliases #=> Array
|
1322
|
+
# resp.services[0].service.edges[0].aliases[0].name #=> String
|
1323
|
+
# resp.services[0].service.edges[0].aliases[0].names #=> Array
|
1324
|
+
# resp.services[0].service.edges[0].aliases[0].names[0] #=> String
|
1325
|
+
# resp.services[0].service.edges[0].aliases[0].type #=> String
|
1326
|
+
# resp.services[0].service.edges[0].edge_type #=> String
|
1327
|
+
# resp.services[0].service.edges[0].received_event_age_histogram #=> Array
|
1328
|
+
# resp.services[0].service.edges[0].received_event_age_histogram[0].value #=> Float
|
1329
|
+
# resp.services[0].service.edges[0].received_event_age_histogram[0].count #=> Integer
|
1330
|
+
# resp.services[0].service.summary_statistics.ok_count #=> Integer
|
1331
|
+
# resp.services[0].service.summary_statistics.error_statistics.throttle_count #=> Integer
|
1332
|
+
# resp.services[0].service.summary_statistics.error_statistics.other_count #=> Integer
|
1333
|
+
# resp.services[0].service.summary_statistics.error_statistics.total_count #=> Integer
|
1334
|
+
# resp.services[0].service.summary_statistics.fault_statistics.other_count #=> Integer
|
1335
|
+
# resp.services[0].service.summary_statistics.fault_statistics.total_count #=> Integer
|
1336
|
+
# resp.services[0].service.summary_statistics.total_count #=> Integer
|
1337
|
+
# resp.services[0].service.summary_statistics.total_response_time #=> Float
|
1338
|
+
# resp.services[0].service.duration_histogram #=> Array
|
1339
|
+
# resp.services[0].service.duration_histogram[0].value #=> Float
|
1340
|
+
# resp.services[0].service.duration_histogram[0].count #=> Integer
|
1341
|
+
# resp.services[0].service.response_time_histogram #=> Array
|
1342
|
+
# resp.services[0].service.response_time_histogram[0].value #=> Float
|
1343
|
+
# resp.services[0].service.response_time_histogram[0].count #=> Integer
|
1344
|
+
# resp.services[0].links #=> Array
|
1345
|
+
# resp.services[0].links[0].reference_type #=> String
|
1346
|
+
# resp.services[0].links[0].source_trace_id #=> String
|
1347
|
+
# resp.services[0].links[0].destination_trace_ids #=> Array
|
1348
|
+
# resp.services[0].links[0].destination_trace_ids[0] #=> String
|
1349
|
+
# resp.next_token #=> String
|
1350
|
+
#
|
1351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetRetrievedTracesGraph AWS API Documentation
|
1352
|
+
#
|
1353
|
+
# @overload get_retrieved_traces_graph(params = {})
|
1354
|
+
# @param [Hash] params ({})
|
1355
|
+
def get_retrieved_traces_graph(params = {}, options = {})
|
1356
|
+
req = build_request(:get_retrieved_traces_graph, params)
|
1357
|
+
req.send_request(options)
|
1358
|
+
end
|
1359
|
+
|
1152
1360
|
# Retrieves all sampling rules.
|
1153
1361
|
#
|
1154
1362
|
# @option params [String] :next_token
|
@@ -1571,6 +1779,35 @@ module Aws::XRay
|
|
1571
1779
|
req.send_request(options)
|
1572
1780
|
end
|
1573
1781
|
|
1782
|
+
# Retrieves the current destination of data sent to `PutTraceSegments`
|
1783
|
+
# and *OpenTelemetry* API. The Transaction Search feature requires a
|
1784
|
+
# CloudWatchLogs destination. For more information, see [Transaction
|
1785
|
+
# Search][1] and [OpenTelemetry][2].
|
1786
|
+
#
|
1787
|
+
#
|
1788
|
+
#
|
1789
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
|
1790
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OpenTelemetry-Sections.html
|
1791
|
+
#
|
1792
|
+
# @return [Types::GetTraceSegmentDestinationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1793
|
+
#
|
1794
|
+
# * {Types::GetTraceSegmentDestinationResult#destination #destination} => String
|
1795
|
+
# * {Types::GetTraceSegmentDestinationResult#status #status} => String
|
1796
|
+
#
|
1797
|
+
# @example Response structure
|
1798
|
+
#
|
1799
|
+
# resp.destination #=> String, one of "XRay", "CloudWatchLogs"
|
1800
|
+
# resp.status #=> String, one of "PENDING", "ACTIVE"
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSegmentDestination AWS API Documentation
|
1803
|
+
#
|
1804
|
+
# @overload get_trace_segment_destination(params = {})
|
1805
|
+
# @param [Hash] params ({})
|
1806
|
+
def get_trace_segment_destination(params = {}, options = {})
|
1807
|
+
req = build_request(:get_trace_segment_destination, params)
|
1808
|
+
req.send_request(options)
|
1809
|
+
end
|
1810
|
+
|
1574
1811
|
# Retrieves IDs and annotations for traces available for a specified
|
1575
1812
|
# time frame using an optional filter. To get the full traces, pass the
|
1576
1813
|
# trace IDs to `BatchGetTraces`.
|
@@ -1588,12 +1825,12 @@ module Aws::XRay
|
|
1588
1825
|
# `annotation.account = "12345"`
|
1589
1826
|
#
|
1590
1827
|
# For a full list of indexed fields and keywords that you can use in
|
1591
|
-
# filter expressions, see [
|
1592
|
-
#
|
1828
|
+
# filter expressions, see [Use filter expressions][1] in the *Amazon Web
|
1829
|
+
# Services X-Ray Developer Guide*.
|
1593
1830
|
#
|
1594
1831
|
#
|
1595
1832
|
#
|
1596
|
-
# [1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters
|
1833
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-filters
|
1597
1834
|
#
|
1598
1835
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
1599
1836
|
# The start of the time frame for which to retrieve traces.
|
@@ -1602,8 +1839,8 @@ module Aws::XRay
|
|
1602
1839
|
# The end of the time frame for which to retrieve traces.
|
1603
1840
|
#
|
1604
1841
|
# @option params [String] :time_range_type
|
1605
|
-
#
|
1606
|
-
#
|
1842
|
+
# Query trace summaries by TraceId (trace start time), Event (trace
|
1843
|
+
# update time), or Service (trace segment end time).
|
1607
1844
|
#
|
1608
1845
|
# @option params [Boolean] :sampling
|
1609
1846
|
# Set to `true` to get summaries for only a subset of available traces.
|
@@ -1791,6 +2028,77 @@ module Aws::XRay
|
|
1791
2028
|
req.send_request(options)
|
1792
2029
|
end
|
1793
2030
|
|
2031
|
+
# Retrieves a list of traces for a given `RetrievalToken` from the
|
2032
|
+
# CloudWatch log group generated by Transaction Search. For information
|
2033
|
+
# on what each trace returns, see [BatchGetTraces][1].
|
2034
|
+
#
|
2035
|
+
# This API does not initiate a retrieval job. To start a trace
|
2036
|
+
# retrieval, use `StartTraceRetrieval`, which generates the required
|
2037
|
+
# `RetrievalToken`.
|
2038
|
+
#
|
2039
|
+
# When the `RetrievalStatus` is not *COMPLETE*, the API will return an
|
2040
|
+
# empty response. Retry the request once the retrieval has completed to
|
2041
|
+
# access the full list of traces.
|
2042
|
+
#
|
2043
|
+
# For cross-account observability, this API can retrieve traces from
|
2044
|
+
# linked accounts when CloudWatch log is the destination across relevant
|
2045
|
+
# accounts. For more details, see [CloudWatch cross-account
|
2046
|
+
# observability][2].
|
2047
|
+
#
|
2048
|
+
# For retrieving data from X-Ray directly as opposed to the
|
2049
|
+
# Transaction-Search Log group, see [BatchGetTraces][1].
|
2050
|
+
#
|
2051
|
+
#
|
2052
|
+
#
|
2053
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html
|
2054
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html
|
2055
|
+
#
|
2056
|
+
# @option params [required, String] :retrieval_token
|
2057
|
+
# Retrieval token.
|
2058
|
+
#
|
2059
|
+
# @option params [String] :trace_format
|
2060
|
+
# Format of the requested traces.
|
2061
|
+
#
|
2062
|
+
# @option params [String] :next_token
|
2063
|
+
# Specify the pagination token returned by a previous request to
|
2064
|
+
# retrieve the next page of indexes.
|
2065
|
+
#
|
2066
|
+
# @return [Types::ListRetrievedTracesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2067
|
+
#
|
2068
|
+
# * {Types::ListRetrievedTracesResult#retrieval_status #retrieval_status} => String
|
2069
|
+
# * {Types::ListRetrievedTracesResult#trace_format #trace_format} => String
|
2070
|
+
# * {Types::ListRetrievedTracesResult#traces #traces} => Array<Types::RetrievedTrace>
|
2071
|
+
# * {Types::ListRetrievedTracesResult#next_token #next_token} => String
|
2072
|
+
#
|
2073
|
+
# @example Request syntax with placeholder values
|
2074
|
+
#
|
2075
|
+
# resp = client.list_retrieved_traces({
|
2076
|
+
# retrieval_token: "RetrievalToken", # required
|
2077
|
+
# trace_format: "XRAY", # accepts XRAY, OTEL
|
2078
|
+
# next_token: "String",
|
2079
|
+
# })
|
2080
|
+
#
|
2081
|
+
# @example Response structure
|
2082
|
+
#
|
2083
|
+
# resp.retrieval_status #=> String, one of "SCHEDULED", "RUNNING", "COMPLETE", "FAILED", "CANCELLED", "TIMEOUT"
|
2084
|
+
# resp.trace_format #=> String, one of "XRAY", "OTEL"
|
2085
|
+
# resp.traces #=> Array
|
2086
|
+
# resp.traces[0].id #=> String
|
2087
|
+
# resp.traces[0].duration #=> Float
|
2088
|
+
# resp.traces[0].spans #=> Array
|
2089
|
+
# resp.traces[0].spans[0].id #=> String
|
2090
|
+
# resp.traces[0].spans[0].document #=> String
|
2091
|
+
# resp.next_token #=> String
|
2092
|
+
#
|
2093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ListRetrievedTraces AWS API Documentation
|
2094
|
+
#
|
2095
|
+
# @overload list_retrieved_traces(params = {})
|
2096
|
+
# @param [Hash] params ({})
|
2097
|
+
def list_retrieved_traces(params = {}, options = {})
|
2098
|
+
req = build_request(:list_retrieved_traces, params)
|
2099
|
+
req.send_request(options)
|
2100
|
+
end
|
2101
|
+
|
1794
2102
|
# Returns a list of tags that are applied to the specified Amazon Web
|
1795
2103
|
# Services X-Ray group or sampling rule.
|
1796
2104
|
#
|
@@ -1995,13 +2303,12 @@ module Aws::XRay
|
|
1995
2303
|
req.send_request(options)
|
1996
2304
|
end
|
1997
2305
|
|
1998
|
-
# Uploads segment documents to Amazon Web Services X-Ray.
|
1999
|
-
#
|
2000
|
-
#
|
2001
|
-
# completed segment, an in-progress segment, or an array of subsegments.
|
2306
|
+
# Uploads segment documents to Amazon Web Services X-Ray. A segment
|
2307
|
+
# document can be a completed segment, an in-progress segment, or an
|
2308
|
+
# array of subsegments.
|
2002
2309
|
#
|
2003
2310
|
# Segments must include the following fields. For the full segment
|
2004
|
-
# document schema, see [Amazon Web Services X-Ray Segment Documents][
|
2311
|
+
# document schema, see [Amazon Web Services X-Ray Segment Documents][1]
|
2005
2312
|
# in the *Amazon Web Services X-Ray Developer Guide*.
|
2006
2313
|
#
|
2007
2314
|
# **Required segment document fields**
|
@@ -2030,7 +2337,9 @@ module Aws::XRay
|
|
2030
2337
|
# overwrite the in-progress segment.
|
2031
2338
|
#
|
2032
2339
|
# A `trace_id` consists of three numbers separated by hyphens. For
|
2033
|
-
# example, 1-58406520-a006649127e371903a2de979.
|
2340
|
+
# example, 1-58406520-a006649127e371903a2de979. For trace IDs created by
|
2341
|
+
# an X-Ray SDK, or by Amazon Web Services services integrated with
|
2342
|
+
# X-Ray, a trace ID includes:
|
2034
2343
|
#
|
2035
2344
|
# **Trace ID Format**
|
2036
2345
|
#
|
@@ -2043,10 +2352,20 @@ module Aws::XRay
|
|
2043
2352
|
# * A 96-bit identifier for the trace, globally unique, in 24
|
2044
2353
|
# hexadecimal digits.
|
2045
2354
|
#
|
2355
|
+
# <note markdown="1"> Trace IDs created via OpenTelemetry have a different format based on
|
2356
|
+
# the [W3C Trace Context specification][2]. A W3C trace ID must be
|
2357
|
+
# formatted in the X-Ray trace ID format when sending to X-Ray. For
|
2358
|
+
# example, a W3C trace ID `4efaaf4d1e8720b39541901950019ee5` should be
|
2359
|
+
# formatted as `1-4efaaf4d-1e8720b39541901950019ee5` when sending to
|
2360
|
+
# X-Ray. While X-Ray trace IDs include the original request timestamp in
|
2361
|
+
# Unix epoch time, this is not required or validated.
|
2046
2362
|
#
|
2363
|
+
# </note>
|
2047
2364
|
#
|
2048
|
-
#
|
2049
|
-
#
|
2365
|
+
#
|
2366
|
+
#
|
2367
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments.html
|
2368
|
+
# [2]: https://www.w3.org/TR/trace-context/
|
2050
2369
|
#
|
2051
2370
|
# @option params [required, Array<String>] :trace_segment_documents
|
2052
2371
|
# A string containing a JSON document defining one or more segments or
|
@@ -2078,6 +2397,69 @@ module Aws::XRay
|
|
2078
2397
|
req.send_request(options)
|
2079
2398
|
end
|
2080
2399
|
|
2400
|
+
# Initiates a trace retrieval process using the specified time range and
|
2401
|
+
# for the give trace IDs on Transaction Search generated by the
|
2402
|
+
# CloudWatch log group. For more information, see [Transaction
|
2403
|
+
# Search][1].
|
2404
|
+
#
|
2405
|
+
# API returns a `RetrievalToken`, which can be used with
|
2406
|
+
# `ListRetrievedTraces` or `GetRetrievedTracesGraph` to fetch results.
|
2407
|
+
# Retrievals will time out after 60 minutes. To execute long time
|
2408
|
+
# ranges, consider segmenting into multiple retrievals.
|
2409
|
+
#
|
2410
|
+
# If you are using [CloudWatch cross-account observability][2], you can
|
2411
|
+
# use this operation in a monitoring account to retrieve data from a
|
2412
|
+
# linked source account, as long as both accounts have transaction
|
2413
|
+
# search enabled.
|
2414
|
+
#
|
2415
|
+
# For retrieving data from X-Ray directly as opposed to the
|
2416
|
+
# Transaction-Search Log group, see [BatchGetTraces][3].
|
2417
|
+
#
|
2418
|
+
#
|
2419
|
+
#
|
2420
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
|
2421
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html
|
2422
|
+
# [3]: https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html
|
2423
|
+
#
|
2424
|
+
# @option params [required, Array<String>] :trace_ids
|
2425
|
+
# Specify the trace IDs of the traces to be retrieved.
|
2426
|
+
#
|
2427
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
2428
|
+
# The start of the time range to retrieve traces. The range is
|
2429
|
+
# inclusive, so the specified start time is included in the query.
|
2430
|
+
# Specified as epoch time, the number of seconds since January 1, 1970,
|
2431
|
+
# 00:00:00 UTC.
|
2432
|
+
#
|
2433
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
2434
|
+
# The end of the time range to retrieve traces. The range is inclusive,
|
2435
|
+
# so the specified end time is included in the query. Specified as epoch
|
2436
|
+
# time, the number of seconds since January 1, 1970, 00:00:00 UTC.
|
2437
|
+
#
|
2438
|
+
# @return [Types::StartTraceRetrievalResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2439
|
+
#
|
2440
|
+
# * {Types::StartTraceRetrievalResult#retrieval_token #retrieval_token} => String
|
2441
|
+
#
|
2442
|
+
# @example Request syntax with placeholder values
|
2443
|
+
#
|
2444
|
+
# resp = client.start_trace_retrieval({
|
2445
|
+
# trace_ids: ["TraceId"], # required
|
2446
|
+
# start_time: Time.now, # required
|
2447
|
+
# end_time: Time.now, # required
|
2448
|
+
# })
|
2449
|
+
#
|
2450
|
+
# @example Response structure
|
2451
|
+
#
|
2452
|
+
# resp.retrieval_token #=> String
|
2453
|
+
#
|
2454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/StartTraceRetrieval AWS API Documentation
|
2455
|
+
#
|
2456
|
+
# @overload start_trace_retrieval(params = {})
|
2457
|
+
# @param [Hash] params ({})
|
2458
|
+
def start_trace_retrieval(params = {}, options = {})
|
2459
|
+
req = build_request(:start_trace_retrieval, params)
|
2460
|
+
req.send_request(options)
|
2461
|
+
end
|
2462
|
+
|
2081
2463
|
# Applies tags to an existing Amazon Web Services X-Ray group or
|
2082
2464
|
# sampling rule.
|
2083
2465
|
#
|
@@ -2216,6 +2598,53 @@ module Aws::XRay
|
|
2216
2598
|
req.send_request(options)
|
2217
2599
|
end
|
2218
2600
|
|
2601
|
+
# Modifies an indexing rule’s configuration.
|
2602
|
+
#
|
2603
|
+
# Indexing rules are used for determining the sampling rate for spans
|
2604
|
+
# indexed from CloudWatch Logs. For more information, see [Transaction
|
2605
|
+
# Search][1].
|
2606
|
+
#
|
2607
|
+
#
|
2608
|
+
#
|
2609
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
|
2610
|
+
#
|
2611
|
+
# @option params [required, String] :name
|
2612
|
+
# Name of the indexing rule to be updated.
|
2613
|
+
#
|
2614
|
+
# @option params [required, Types::IndexingRuleValueUpdate] :rule
|
2615
|
+
# Rule configuration to be updated.
|
2616
|
+
#
|
2617
|
+
# @return [Types::UpdateIndexingRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2618
|
+
#
|
2619
|
+
# * {Types::UpdateIndexingRuleResult#indexing_rule #indexing_rule} => Types::IndexingRule
|
2620
|
+
#
|
2621
|
+
# @example Request syntax with placeholder values
|
2622
|
+
#
|
2623
|
+
# resp = client.update_indexing_rule({
|
2624
|
+
# name: "String", # required
|
2625
|
+
# rule: { # required
|
2626
|
+
# probabilistic: {
|
2627
|
+
# desired_sampling_percentage: 1.0, # required
|
2628
|
+
# },
|
2629
|
+
# },
|
2630
|
+
# })
|
2631
|
+
#
|
2632
|
+
# @example Response structure
|
2633
|
+
#
|
2634
|
+
# resp.indexing_rule.name #=> String
|
2635
|
+
# resp.indexing_rule.modified_at #=> Time
|
2636
|
+
# resp.indexing_rule.rule.probabilistic.desired_sampling_percentage #=> Float
|
2637
|
+
# resp.indexing_rule.rule.probabilistic.actual_sampling_percentage #=> Float
|
2638
|
+
#
|
2639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateIndexingRule AWS API Documentation
|
2640
|
+
#
|
2641
|
+
# @overload update_indexing_rule(params = {})
|
2642
|
+
# @param [Hash] params ({})
|
2643
|
+
def update_indexing_rule(params = {}, options = {})
|
2644
|
+
req = build_request(:update_indexing_rule, params)
|
2645
|
+
req.send_request(options)
|
2646
|
+
end
|
2647
|
+
|
2219
2648
|
# Modifies a sampling rule's configuration.
|
2220
2649
|
#
|
2221
2650
|
# @option params [required, Types::SamplingRuleUpdate] :sampling_rule_update
|
@@ -2274,6 +2703,42 @@ module Aws::XRay
|
|
2274
2703
|
req.send_request(options)
|
2275
2704
|
end
|
2276
2705
|
|
2706
|
+
# Modifies the destination of data sent to `PutTraceSegments`. The
|
2707
|
+
# Transaction Search feature requires the CloudWatchLogs destination.
|
2708
|
+
# For more information, see [Transaction Search][1].
|
2709
|
+
#
|
2710
|
+
#
|
2711
|
+
#
|
2712
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
|
2713
|
+
#
|
2714
|
+
# @option params [String] :destination
|
2715
|
+
# The configured destination of trace segments.
|
2716
|
+
#
|
2717
|
+
# @return [Types::UpdateTraceSegmentDestinationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2718
|
+
#
|
2719
|
+
# * {Types::UpdateTraceSegmentDestinationResult#destination #destination} => String
|
2720
|
+
# * {Types::UpdateTraceSegmentDestinationResult#status #status} => String
|
2721
|
+
#
|
2722
|
+
# @example Request syntax with placeholder values
|
2723
|
+
#
|
2724
|
+
# resp = client.update_trace_segment_destination({
|
2725
|
+
# destination: "XRay", # accepts XRay, CloudWatchLogs
|
2726
|
+
# })
|
2727
|
+
#
|
2728
|
+
# @example Response structure
|
2729
|
+
#
|
2730
|
+
# resp.destination #=> String, one of "XRay", "CloudWatchLogs"
|
2731
|
+
# resp.status #=> String, one of "PENDING", "ACTIVE"
|
2732
|
+
#
|
2733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateTraceSegmentDestination AWS API Documentation
|
2734
|
+
#
|
2735
|
+
# @overload update_trace_segment_destination(params = {})
|
2736
|
+
# @param [Hash] params ({})
|
2737
|
+
def update_trace_segment_destination(params = {}, options = {})
|
2738
|
+
req = build_request(:update_trace_segment_destination, params)
|
2739
|
+
req.send_request(options)
|
2740
|
+
end
|
2741
|
+
|
2277
2742
|
# @!endgroup
|
2278
2743
|
|
2279
2744
|
# @param params ({})
|
@@ -2292,7 +2757,7 @@ module Aws::XRay
|
|
2292
2757
|
tracer: tracer
|
2293
2758
|
)
|
2294
2759
|
context[:gem_name] = 'aws-sdk-xray'
|
2295
|
-
context[:gem_version] = '1.
|
2760
|
+
context[:gem_version] = '1.79.0'
|
2296
2761
|
Seahorse::Client::Request.new(handlers, context)
|
2297
2762
|
end
|
2298
2763
|
|