aws-sdk-xray 1.21.0 → 1.26.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 +5 -5
- data/lib/aws-sdk-xray.rb +7 -4
- data/lib/aws-sdk-xray/client.rb +110 -31
- data/lib/aws-sdk-xray/client_api.rb +3 -0
- data/lib/aws-sdk-xray/errors.rb +25 -3
- data/lib/aws-sdk-xray/resource.rb +1 -0
- data/lib/aws-sdk-xray/types.rb +38 -22
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 659a22894ed80783defa44fffde04ed165ef81a1ef2b42b0a2a5041973aa83e5
|
4
|
+
data.tar.gz: 56c119d3ed3330099bc9b7fbac1bd55c183bc42513980dbe9cd9b755708e0a62
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8b6ab02daeb04cd804245e42d2f877699d6ee8c8369c77631d4efc4bd122a2b01889f844a4cbb993ac09d9b73e73ccc09a6af4567445bf7821f78027ee2c470e
|
7
|
+
data.tar.gz: 200c9f98d622a490c13f463aea42f3ff187d90267d0ce613fe5ca62d072fc1027dd6255a59ab8dc3a9377773a11e7849f4e47112ea2bab21e0e384bd44dfb107
|
data/lib/aws-sdk-xray.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-xray/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# x_ray = Aws::XRay::Client.new
|
28
|
+
# resp = x_ray.batch_get_traces(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS X-Ray
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS X-Ray are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::XRay::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS X-Ray API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-xray/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::XRay
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.26.0'
|
46
49
|
|
47
50
|
end
|
data/lib/aws-sdk-xray/client.rb
CHANGED
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:xray)
|
31
31
|
|
32
32
|
module Aws::XRay
|
33
|
+
# An API client for XRay. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::XRay::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::XRay
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::XRay
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::XRay
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::XRay
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::XRay
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::XRay
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::XRay
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::XRay
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::XRay
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -262,7 +316,7 @@ module Aws::XRay
|
|
262
316
|
# Specify the trace IDs of requests for which to retrieve segments.
|
263
317
|
#
|
264
318
|
# @option params [String] :next_token
|
265
|
-
# Pagination token.
|
319
|
+
# Pagination token.
|
266
320
|
#
|
267
321
|
# @return [Types::BatchGetTracesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
268
322
|
#
|
@@ -270,6 +324,8 @@ module Aws::XRay
|
|
270
324
|
# * {Types::BatchGetTracesResult#unprocessed_trace_ids #unprocessed_trace_ids} => Array<String>
|
271
325
|
# * {Types::BatchGetTracesResult#next_token #next_token} => String
|
272
326
|
#
|
327
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
328
|
+
#
|
273
329
|
# @example Request syntax with placeholder values
|
274
330
|
#
|
275
331
|
# resp = client.batch_get_traces({
|
@@ -532,13 +588,15 @@ module Aws::XRay
|
|
532
588
|
# Retrieves all active group details.
|
533
589
|
#
|
534
590
|
# @option params [String] :next_token
|
535
|
-
# Pagination token.
|
591
|
+
# Pagination token.
|
536
592
|
#
|
537
593
|
# @return [Types::GetGroupsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
538
594
|
#
|
539
595
|
# * {Types::GetGroupsResult#groups #groups} => Array<Types::GroupSummary>
|
540
596
|
# * {Types::GetGroupsResult#next_token #next_token} => String
|
541
597
|
#
|
598
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
599
|
+
#
|
542
600
|
# @example Request syntax with placeholder values
|
543
601
|
#
|
544
602
|
# resp = client.get_groups({
|
@@ -565,13 +623,15 @@ module Aws::XRay
|
|
565
623
|
# Retrieves all sampling rules.
|
566
624
|
#
|
567
625
|
# @option params [String] :next_token
|
568
|
-
# Pagination token.
|
626
|
+
# Pagination token.
|
569
627
|
#
|
570
628
|
# @return [Types::GetSamplingRulesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
571
629
|
#
|
572
630
|
# * {Types::GetSamplingRulesResult#sampling_rule_records #sampling_rule_records} => Array<Types::SamplingRuleRecord>
|
573
631
|
# * {Types::GetSamplingRulesResult#next_token #next_token} => String
|
574
632
|
#
|
633
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
634
|
+
#
|
575
635
|
# @example Request syntax with placeholder values
|
576
636
|
#
|
577
637
|
# resp = client.get_sampling_rules({
|
@@ -612,13 +672,15 @@ module Aws::XRay
|
|
612
672
|
# rules.
|
613
673
|
#
|
614
674
|
# @option params [String] :next_token
|
615
|
-
# Pagination token.
|
675
|
+
# Pagination token.
|
616
676
|
#
|
617
677
|
# @return [Types::GetSamplingStatisticSummariesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
618
678
|
#
|
619
679
|
# * {Types::GetSamplingStatisticSummariesResult#sampling_statistic_summaries #sampling_statistic_summaries} => Array<Types::SamplingStatisticSummary>
|
620
680
|
# * {Types::GetSamplingStatisticSummariesResult#next_token #next_token} => String
|
621
681
|
#
|
682
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
683
|
+
#
|
622
684
|
# @example Request syntax with placeholder values
|
623
685
|
#
|
624
686
|
# resp = client.get_sampling_statistic_summaries({
|
@@ -697,9 +759,13 @@ module Aws::XRay
|
|
697
759
|
# Retrieves a document that describes services that process incoming
|
698
760
|
# requests, and downstream services that they call as a result. Root
|
699
761
|
# services process incoming requests and make calls to downstream
|
700
|
-
# services. Root services are applications that use the AWS X-Ray
|
701
|
-
# Downstream services can be other applications, AWS resources,
|
702
|
-
# APIs, or SQL databases.
|
762
|
+
# services. Root services are applications that use the [AWS X-Ray
|
763
|
+
# SDK][1]. Downstream services can be other applications, AWS resources,
|
764
|
+
# HTTP web APIs, or SQL databases.
|
765
|
+
#
|
766
|
+
#
|
767
|
+
#
|
768
|
+
# [1]: https://docs.aws.amazon.com/xray/index.html
|
703
769
|
#
|
704
770
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
705
771
|
# The start of the time frame for which to generate a graph.
|
@@ -714,7 +780,7 @@ module Aws::XRay
|
|
714
780
|
# The ARN of a group to generate a graph based on.
|
715
781
|
#
|
716
782
|
# @option params [String] :next_token
|
717
|
-
# Pagination token.
|
783
|
+
# Pagination token.
|
718
784
|
#
|
719
785
|
# @return [Types::GetServiceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
720
786
|
#
|
@@ -724,6 +790,8 @@ module Aws::XRay
|
|
724
790
|
# * {Types::GetServiceGraphResult#contains_old_group_versions #contains_old_group_versions} => Boolean
|
725
791
|
# * {Types::GetServiceGraphResult#next_token #next_token} => String
|
726
792
|
#
|
793
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
794
|
+
#
|
727
795
|
# @example Request syntax with placeholder values
|
728
796
|
#
|
729
797
|
# resp = client.get_service_graph({
|
@@ -820,7 +888,7 @@ module Aws::XRay
|
|
820
888
|
# Aggregation period in seconds.
|
821
889
|
#
|
822
890
|
# @option params [String] :next_token
|
823
|
-
# Pagination token.
|
891
|
+
# Pagination token.
|
824
892
|
#
|
825
893
|
# @return [Types::GetTimeSeriesServiceStatisticsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
826
894
|
#
|
@@ -828,6 +896,8 @@ module Aws::XRay
|
|
828
896
|
# * {Types::GetTimeSeriesServiceStatisticsResult#contains_old_group_versions #contains_old_group_versions} => Boolean
|
829
897
|
# * {Types::GetTimeSeriesServiceStatisticsResult#next_token #next_token} => String
|
830
898
|
#
|
899
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
900
|
+
#
|
831
901
|
# @example Request syntax with placeholder values
|
832
902
|
#
|
833
903
|
# resp = client.get_time_series_service_statistics({
|
@@ -881,13 +951,15 @@ module Aws::XRay
|
|
881
951
|
# Trace IDs of requests for which to generate a service graph.
|
882
952
|
#
|
883
953
|
# @option params [String] :next_token
|
884
|
-
# Pagination token.
|
954
|
+
# Pagination token.
|
885
955
|
#
|
886
956
|
# @return [Types::GetTraceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
887
957
|
#
|
888
958
|
# * {Types::GetTraceGraphResult#services #services} => Array<Types::Service>
|
889
959
|
# * {Types::GetTraceGraphResult#next_token #next_token} => String
|
890
960
|
#
|
961
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
962
|
+
#
|
891
963
|
# @example Request syntax with placeholder values
|
892
964
|
#
|
893
965
|
# resp = client.get_trace_graph({
|
@@ -953,9 +1025,9 @@ module Aws::XRay
|
|
953
1025
|
req.send_request(options)
|
954
1026
|
end
|
955
1027
|
|
956
|
-
# Retrieves IDs and
|
957
|
-
# frame using an optional filter. To get the full traces, pass the
|
958
|
-
# IDs to `BatchGetTraces`.
|
1028
|
+
# Retrieves IDs and annotations for traces available for a specified
|
1029
|
+
# time frame using an optional filter. To get the full traces, pass the
|
1030
|
+
# trace IDs to `BatchGetTraces`.
|
959
1031
|
#
|
960
1032
|
# A filter expression can target traced requests that hit specific
|
961
1033
|
# service nodes or edges, have errors, or come from a known user. For
|
@@ -1009,6 +1081,8 @@ module Aws::XRay
|
|
1009
1081
|
# * {Types::GetTraceSummariesResult#traces_processed_count #traces_processed_count} => Integer
|
1010
1082
|
# * {Types::GetTraceSummariesResult#next_token #next_token} => String
|
1011
1083
|
#
|
1084
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1085
|
+
#
|
1012
1086
|
# @example Request syntax with placeholder values
|
1013
1087
|
#
|
1014
1088
|
# resp = client.get_trace_summaries({
|
@@ -1089,6 +1163,7 @@ module Aws::XRay
|
|
1089
1163
|
# resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].exceptions[0].message #=> String
|
1090
1164
|
# resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].remote #=> Boolean
|
1091
1165
|
# resp.trace_summaries[0].fault_root_causes[0].services[0].inferred #=> Boolean
|
1166
|
+
# resp.trace_summaries[0].fault_root_causes[0].client_impacting #=> Boolean
|
1092
1167
|
# resp.trace_summaries[0].error_root_causes #=> Array
|
1093
1168
|
# resp.trace_summaries[0].error_root_causes[0].services #=> Array
|
1094
1169
|
# resp.trace_summaries[0].error_root_causes[0].services[0].name #=> String
|
@@ -1103,6 +1178,7 @@ module Aws::XRay
|
|
1103
1178
|
# resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].exceptions[0].message #=> String
|
1104
1179
|
# resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].remote #=> Boolean
|
1105
1180
|
# resp.trace_summaries[0].error_root_causes[0].services[0].inferred #=> Boolean
|
1181
|
+
# resp.trace_summaries[0].error_root_causes[0].client_impacting #=> Boolean
|
1106
1182
|
# resp.trace_summaries[0].response_time_root_causes #=> Array
|
1107
1183
|
# resp.trace_summaries[0].response_time_root_causes[0].services #=> Array
|
1108
1184
|
# resp.trace_summaries[0].response_time_root_causes[0].services[0].name #=> String
|
@@ -1115,6 +1191,7 @@ module Aws::XRay
|
|
1115
1191
|
# resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].coverage #=> Float
|
1116
1192
|
# resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].remote #=> Boolean
|
1117
1193
|
# resp.trace_summaries[0].response_time_root_causes[0].services[0].inferred #=> Boolean
|
1194
|
+
# resp.trace_summaries[0].response_time_root_causes[0].client_impacting #=> Boolean
|
1118
1195
|
# resp.trace_summaries[0].revision #=> Integer
|
1119
1196
|
# resp.trace_summaries[0].matched_event_time #=> Time
|
1120
1197
|
# resp.approximate_time #=> Time
|
@@ -1138,7 +1215,8 @@ module Aws::XRay
|
|
1138
1215
|
# * **Alias** - The name of the key. For example, `alias/MyKey`.
|
1139
1216
|
#
|
1140
1217
|
# * **Key ID** - The KMS key ID of the key. For example,
|
1141
|
-
# `ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`.
|
1218
|
+
# `ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. AWS X-Ray does not support
|
1219
|
+
# asymmetric CMKs.
|
1142
1220
|
#
|
1143
1221
|
# * **ARN** - The full Amazon Resource Name of the key ID or alias. For
|
1144
1222
|
# example,
|
@@ -1223,13 +1301,13 @@ module Aws::XRay
|
|
1223
1301
|
req.send_request(options)
|
1224
1302
|
end
|
1225
1303
|
|
1226
|
-
# Uploads segment documents to AWS X-Ray. The X-Ray SDK generates
|
1304
|
+
# Uploads segment documents to AWS X-Ray. The [X-Ray SDK][1] generates
|
1227
1305
|
# segment documents and sends them to the X-Ray daemon, which uploads
|
1228
1306
|
# them in batches. A segment document can be a completed segment, an
|
1229
1307
|
# in-progress segment, or an array of subsegments.
|
1230
1308
|
#
|
1231
1309
|
# Segments must include the following fields. For the full segment
|
1232
|
-
# document schema, see [AWS X-Ray Segment Documents][
|
1310
|
+
# document schema, see [AWS X-Ray Segment Documents][2] in the *AWS
|
1233
1311
|
# X-Ray Developer Guide*.
|
1234
1312
|
#
|
1235
1313
|
# **Required Segment Document Fields**
|
@@ -1273,7 +1351,8 @@ module Aws::XRay
|
|
1273
1351
|
#
|
1274
1352
|
#
|
1275
1353
|
#
|
1276
|
-
# [1]: https://docs.aws.amazon.com/xray/
|
1354
|
+
# [1]: https://docs.aws.amazon.com/xray/index.html
|
1355
|
+
# [2]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
|
1277
1356
|
#
|
1278
1357
|
# @option params [required, Array<String>] :trace_segment_documents
|
1279
1358
|
# A string containing a JSON document defining one or more segments or
|
@@ -1415,7 +1494,7 @@ module Aws::XRay
|
|
1415
1494
|
params: params,
|
1416
1495
|
config: config)
|
1417
1496
|
context[:gem_name] = 'aws-sdk-xray'
|
1418
|
-
context[:gem_version] = '1.
|
1497
|
+
context[:gem_version] = '1.26.0'
|
1419
1498
|
Seahorse::Client::Request.new(handlers, context)
|
1420
1499
|
end
|
1421
1500
|
|
@@ -271,6 +271,7 @@ module Aws::XRay
|
|
271
271
|
EncryptionConfig.struct_class = Types::EncryptionConfig
|
272
272
|
|
273
273
|
ErrorRootCause.add_member(:services, Shapes::ShapeRef.new(shape: ErrorRootCauseServices, location_name: "Services"))
|
274
|
+
ErrorRootCause.add_member(:client_impacting, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ClientImpacting"))
|
274
275
|
ErrorRootCause.struct_class = Types::ErrorRootCause
|
275
276
|
|
276
277
|
ErrorRootCauseEntity.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
|
@@ -298,6 +299,7 @@ module Aws::XRay
|
|
298
299
|
ErrorStatistics.struct_class = Types::ErrorStatistics
|
299
300
|
|
300
301
|
FaultRootCause.add_member(:services, Shapes::ShapeRef.new(shape: FaultRootCauseServices, location_name: "Services"))
|
302
|
+
FaultRootCause.add_member(:client_impacting, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ClientImpacting"))
|
301
303
|
FaultRootCause.struct_class = Types::FaultRootCause
|
302
304
|
|
303
305
|
FaultRootCauseEntity.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
|
@@ -471,6 +473,7 @@ module Aws::XRay
|
|
471
473
|
ResourceARNDetail.struct_class = Types::ResourceARNDetail
|
472
474
|
|
473
475
|
ResponseTimeRootCause.add_member(:services, Shapes::ShapeRef.new(shape: ResponseTimeRootCauseServices, location_name: "Services"))
|
476
|
+
ResponseTimeRootCause.add_member(:client_impacting, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ClientImpacting"))
|
474
477
|
ResponseTimeRootCause.struct_class = Types::ResponseTimeRootCause
|
475
478
|
|
476
479
|
ResponseTimeRootCauseEntity.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
|
data/lib/aws-sdk-xray/errors.rb
CHANGED
@@ -6,6 +6,31 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::XRay
|
9
|
+
|
10
|
+
# When XRay returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::XRay::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all XRay errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::XRay::Errors::ServiceError
|
18
|
+
# # rescues all XRay API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {InvalidRequestException}
|
29
|
+
# * {RuleLimitExceededException}
|
30
|
+
# * {ThrottledException}
|
31
|
+
#
|
32
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
33
|
+
# if they are not defined above.
|
9
34
|
module Errors
|
10
35
|
|
11
36
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +48,6 @@ module Aws::XRay
|
|
23
48
|
def message
|
24
49
|
@message || @data[:message]
|
25
50
|
end
|
26
|
-
|
27
51
|
end
|
28
52
|
|
29
53
|
class RuleLimitExceededException < ServiceError
|
@@ -39,7 +63,6 @@ module Aws::XRay
|
|
39
63
|
def message
|
40
64
|
@message || @data[:message]
|
41
65
|
end
|
42
|
-
|
43
66
|
end
|
44
67
|
|
45
68
|
class ThrottledException < ServiceError
|
@@ -55,7 +78,6 @@ module Aws::XRay
|
|
55
78
|
def message
|
56
79
|
@message || @data[:message]
|
57
80
|
end
|
58
|
-
|
59
81
|
end
|
60
82
|
|
61
83
|
end
|
data/lib/aws-sdk-xray/types.rb
CHANGED
@@ -123,7 +123,7 @@ module Aws::XRay
|
|
123
123
|
# @return [Array<String>]
|
124
124
|
#
|
125
125
|
# @!attribute [rw] next_token
|
126
|
-
# Pagination token.
|
126
|
+
# Pagination token.
|
127
127
|
# @return [String]
|
128
128
|
#
|
129
129
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTracesRequest AWS API Documentation
|
@@ -143,7 +143,7 @@ module Aws::XRay
|
|
143
143
|
# @return [Array<String>]
|
144
144
|
#
|
145
145
|
# @!attribute [rw] next_token
|
146
|
-
# Pagination token.
|
146
|
+
# Pagination token.
|
147
147
|
# @return [String]
|
148
148
|
#
|
149
149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTracesResult AWS API Documentation
|
@@ -412,10 +412,15 @@ module Aws::XRay
|
|
412
412
|
# segment and it contains a name, account ID, type, and inferred flag.
|
413
413
|
# @return [Array<Types::ErrorRootCauseService>]
|
414
414
|
#
|
415
|
+
# @!attribute [rw] client_impacting
|
416
|
+
# A flag that denotes that the root cause impacts the trace client.
|
417
|
+
# @return [Boolean]
|
418
|
+
#
|
415
419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ErrorRootCause AWS API Documentation
|
416
420
|
#
|
417
421
|
class ErrorRootCause < Struct.new(
|
418
|
-
:services
|
422
|
+
:services,
|
423
|
+
:client_impacting)
|
419
424
|
include Aws::Structure
|
420
425
|
end
|
421
426
|
|
@@ -517,10 +522,15 @@ module Aws::XRay
|
|
517
522
|
# it contains a name, account ID, type, and inferred flag.
|
518
523
|
# @return [Array<Types::FaultRootCauseService>]
|
519
524
|
#
|
525
|
+
# @!attribute [rw] client_impacting
|
526
|
+
# A flag that denotes that the root cause impacts the trace client.
|
527
|
+
# @return [Boolean]
|
528
|
+
#
|
520
529
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/FaultRootCause AWS API Documentation
|
521
530
|
#
|
522
531
|
class FaultRootCause < Struct.new(
|
523
|
-
:services
|
532
|
+
:services,
|
533
|
+
:client_impacting)
|
524
534
|
include Aws::Structure
|
525
535
|
end
|
526
536
|
|
@@ -671,7 +681,7 @@ module Aws::XRay
|
|
671
681
|
# }
|
672
682
|
#
|
673
683
|
# @!attribute [rw] next_token
|
674
|
-
# Pagination token.
|
684
|
+
# Pagination token.
|
675
685
|
# @return [String]
|
676
686
|
#
|
677
687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroupsRequest AWS API Documentation
|
@@ -686,7 +696,7 @@ module Aws::XRay
|
|
686
696
|
# @return [Array<Types::GroupSummary>]
|
687
697
|
#
|
688
698
|
# @!attribute [rw] next_token
|
689
|
-
# Pagination token.
|
699
|
+
# Pagination token.
|
690
700
|
# @return [String]
|
691
701
|
#
|
692
702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroupsResult AWS API Documentation
|
@@ -705,7 +715,7 @@ module Aws::XRay
|
|
705
715
|
# }
|
706
716
|
#
|
707
717
|
# @!attribute [rw] next_token
|
708
|
-
# Pagination token.
|
718
|
+
# Pagination token.
|
709
719
|
# @return [String]
|
710
720
|
#
|
711
721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingRulesRequest AWS API Documentation
|
@@ -720,7 +730,7 @@ module Aws::XRay
|
|
720
730
|
# @return [Array<Types::SamplingRuleRecord>]
|
721
731
|
#
|
722
732
|
# @!attribute [rw] next_token
|
723
|
-
# Pagination token.
|
733
|
+
# Pagination token.
|
724
734
|
# @return [String]
|
725
735
|
#
|
726
736
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingRulesResult AWS API Documentation
|
@@ -739,7 +749,7 @@ module Aws::XRay
|
|
739
749
|
# }
|
740
750
|
#
|
741
751
|
# @!attribute [rw] next_token
|
742
|
-
# Pagination token.
|
752
|
+
# Pagination token.
|
743
753
|
# @return [String]
|
744
754
|
#
|
745
755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingStatisticSummariesRequest AWS API Documentation
|
@@ -755,7 +765,7 @@ module Aws::XRay
|
|
755
765
|
# @return [Array<Types::SamplingStatisticSummary>]
|
756
766
|
#
|
757
767
|
# @!attribute [rw] next_token
|
758
|
-
# Pagination token.
|
768
|
+
# Pagination token.
|
759
769
|
# @return [String]
|
760
770
|
#
|
761
771
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingStatisticSummariesResult AWS API Documentation
|
@@ -847,7 +857,7 @@ module Aws::XRay
|
|
847
857
|
# @return [String]
|
848
858
|
#
|
849
859
|
# @!attribute [rw] next_token
|
850
|
-
# Pagination token.
|
860
|
+
# Pagination token.
|
851
861
|
# @return [String]
|
852
862
|
#
|
853
863
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraphRequest AWS API Documentation
|
@@ -881,7 +891,7 @@ module Aws::XRay
|
|
881
891
|
# @return [Boolean]
|
882
892
|
#
|
883
893
|
# @!attribute [rw] next_token
|
884
|
-
# Pagination token.
|
894
|
+
# Pagination token.
|
885
895
|
# @return [String]
|
886
896
|
#
|
887
897
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraphResult AWS API Documentation
|
@@ -936,7 +946,7 @@ module Aws::XRay
|
|
936
946
|
# @return [Integer]
|
937
947
|
#
|
938
948
|
# @!attribute [rw] next_token
|
939
|
-
# Pagination token.
|
949
|
+
# Pagination token.
|
940
950
|
# @return [String]
|
941
951
|
#
|
942
952
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTimeSeriesServiceStatisticsRequest AWS API Documentation
|
@@ -963,7 +973,7 @@ module Aws::XRay
|
|
963
973
|
# @return [Boolean]
|
964
974
|
#
|
965
975
|
# @!attribute [rw] next_token
|
966
|
-
# Pagination token.
|
976
|
+
# Pagination token.
|
967
977
|
# @return [String]
|
968
978
|
#
|
969
979
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTimeSeriesServiceStatisticsResult AWS API Documentation
|
@@ -988,7 +998,7 @@ module Aws::XRay
|
|
988
998
|
# @return [Array<String>]
|
989
999
|
#
|
990
1000
|
# @!attribute [rw] next_token
|
991
|
-
# Pagination token.
|
1001
|
+
# Pagination token.
|
992
1002
|
# @return [String]
|
993
1003
|
#
|
994
1004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraphRequest AWS API Documentation
|
@@ -1004,7 +1014,7 @@ module Aws::XRay
|
|
1004
1014
|
# @return [Array<Types::Service>]
|
1005
1015
|
#
|
1006
1016
|
# @!attribute [rw] next_token
|
1007
|
-
# Pagination token.
|
1017
|
+
# Pagination token.
|
1008
1018
|
# @return [String]
|
1009
1019
|
#
|
1010
1020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraphResult AWS API Documentation
|
@@ -1078,8 +1088,8 @@ module Aws::XRay
|
|
1078
1088
|
end
|
1079
1089
|
|
1080
1090
|
# @!attribute [rw] trace_summaries
|
1081
|
-
# Trace IDs and
|
1082
|
-
# time frame.
|
1091
|
+
# Trace IDs and annotations for traces that were found in the
|
1092
|
+
# specified time frame.
|
1083
1093
|
# @return [Array<Types::TraceSummary>]
|
1084
1094
|
#
|
1085
1095
|
# @!attribute [rw] approximate_time
|
@@ -1247,7 +1257,8 @@ module Aws::XRay
|
|
1247
1257
|
# * **Alias** - The name of the key. For example, `alias/MyKey`.
|
1248
1258
|
#
|
1249
1259
|
# * **Key ID** - The KMS key ID of the key. For example,
|
1250
|
-
# `ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`.
|
1260
|
+
# `ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. AWS X-Ray does not
|
1261
|
+
# support asymmetric CMKs.
|
1251
1262
|
#
|
1252
1263
|
# * **ARN** - The full Amazon Resource Name of the key ID or alias.
|
1253
1264
|
# For example,
|
@@ -1383,10 +1394,15 @@ module Aws::XRay
|
|
1383
1394
|
# contains a name, account ID, type, and inferred flag.
|
1384
1395
|
# @return [Array<Types::ResponseTimeRootCauseService>]
|
1385
1396
|
#
|
1397
|
+
# @!attribute [rw] client_impacting
|
1398
|
+
# A flag that denotes that the root cause impacts the trace client.
|
1399
|
+
# @return [Boolean]
|
1400
|
+
#
|
1386
1401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ResponseTimeRootCause AWS API Documentation
|
1387
1402
|
#
|
1388
1403
|
class ResponseTimeRootCause < Struct.new(
|
1389
|
-
:services
|
1404
|
+
:services,
|
1405
|
+
:client_impacting)
|
1390
1406
|
include Aws::Structure
|
1391
1407
|
end
|
1392
1408
|
|
@@ -2168,11 +2184,11 @@ module Aws::XRay
|
|
2168
2184
|
# @return [Float]
|
2169
2185
|
#
|
2170
2186
|
# @!attribute [rw] has_fault
|
2171
|
-
#
|
2187
|
+
# The root segment document has a 500 series error.
|
2172
2188
|
# @return [Boolean]
|
2173
2189
|
#
|
2174
2190
|
# @!attribute [rw] has_error
|
2175
|
-
#
|
2191
|
+
# The root segment document has a 400 series error.
|
2176
2192
|
# @return [Boolean]
|
2177
2193
|
#
|
2178
2194
|
# @!attribute [rw] has_throttle
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-xray
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.26.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-05-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
83
|
rubyforge_project:
|
84
|
-
rubygems_version: 2.
|
84
|
+
rubygems_version: 2.7.6.2
|
85
85
|
signing_key:
|
86
86
|
specification_version: 4
|
87
87
|
summary: AWS SDK for Ruby - AWS X-Ray
|