aws-sdk-xray 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-xray.rb +47 -0
- data/lib/aws-sdk-xray/client.rb +535 -0
- data/lib/aws-sdk-xray/client_api.rb +372 -0
- data/lib/aws-sdk-xray/customizations.rb +0 -0
- data/lib/aws-sdk-xray/errors.rb +23 -0
- data/lib/aws-sdk-xray/resource.rb +25 -0
- data/lib/aws-sdk-xray/types.rb +865 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b2e5e9f4252a43efd98ee7b553dd6423f6ccd399
|
4
|
+
data.tar.gz: 39c9b1d07176225be068202d57816afacd302fee
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: a8ac7705cf232cf0ea23cac539552672e65031d0ea5e9cea7c7266686b533d8f908717850170e4946a8871e58af036431ceeea08ab0649bcc24367aa2f78eb4c
|
7
|
+
data.tar.gz: e6790a7b38818fe2ea0db804d5f00ae219640a93f7c1e7de6a1087886f2285a624bddff49715a47442ab48796a74e21b06287b838caf6b320b8c8f933c7a6226
|
data/lib/aws-sdk-xray.rb
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-xray/types'
|
12
|
+
require_relative 'aws-sdk-xray/client_api'
|
13
|
+
require_relative 'aws-sdk-xray/client'
|
14
|
+
require_relative 'aws-sdk-xray/errors'
|
15
|
+
require_relative 'aws-sdk-xray/resource'
|
16
|
+
require_relative 'aws-sdk-xray/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS X-Ray. This module is available in the
|
19
|
+
# `aws-sdk-xray` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS X-Ray all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::XRay::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::XRay
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,535 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:xray)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module XRay
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :xray
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
50
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
51
|
+
|
52
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
53
|
+
# Your AWS credentials. This can be an instance of any one of the
|
54
|
+
# following classes:
|
55
|
+
#
|
56
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
57
|
+
# credentials.
|
58
|
+
#
|
59
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
60
|
+
# from an EC2 IMDS on an EC2 instance.
|
61
|
+
#
|
62
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
63
|
+
# shared file, such as `~/.aws/config`.
|
64
|
+
#
|
65
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
66
|
+
#
|
67
|
+
# When `:credentials` are not configured directly, the following
|
68
|
+
# locations will be searched for credentials:
|
69
|
+
#
|
70
|
+
# * `Aws.config[:credentials]`
|
71
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
72
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
73
|
+
# * `~/.aws/credentials`
|
74
|
+
# * `~/.aws/config`
|
75
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
76
|
+
# very aggressive. Construct and pass an instance of
|
77
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
78
|
+
# timeouts.
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
# @option options [String] :access_key_id
|
91
|
+
# @option options [Boolean] :convert_params (true)
|
92
|
+
# When `true`, an attempt is made to coerce request parameters into
|
93
|
+
# the required types.
|
94
|
+
# @option options [String] :endpoint
|
95
|
+
# The client endpoint is normally constructed from the `:region`
|
96
|
+
# option. You should only configure an `:endpoint` when connecting
|
97
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
98
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
99
|
+
# The log formatter.
|
100
|
+
# @option options [Symbol] :log_level (:info)
|
101
|
+
# The log level to send messages to the `:logger` at.
|
102
|
+
# @option options [Logger] :logger
|
103
|
+
# The Logger instance to send log messages to. If this option
|
104
|
+
# is not set, logging will be disabled.
|
105
|
+
# @option options [String] :profile ("default")
|
106
|
+
# Used when loading credentials from the shared credentials file
|
107
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
108
|
+
# @option options [Integer] :retry_limit (3)
|
109
|
+
# The maximum number of times to retry failed requests. Only
|
110
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
111
|
+
# are retried. Generally, these are throttling errors, data
|
112
|
+
# checksum errors, networking errors, timeout errors and auth
|
113
|
+
# errors from expired credentials.
|
114
|
+
# @option options [String] :secret_access_key
|
115
|
+
# @option options [String] :session_token
|
116
|
+
# @option options [Boolean] :stub_responses (false)
|
117
|
+
# Causes the client to return stubbed responses. By default
|
118
|
+
# fake responses are generated and returned. You can specify
|
119
|
+
# the response data to return or errors to raise by calling
|
120
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
121
|
+
#
|
122
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
123
|
+
# requests are made, and retries are disabled.
|
124
|
+
# @option options [Boolean] :validate_params (true)
|
125
|
+
# When `true`, request parameters are validated before
|
126
|
+
# sending the request.
|
127
|
+
def initialize(*args)
|
128
|
+
super
|
129
|
+
end
|
130
|
+
|
131
|
+
# @!group API Operations
|
132
|
+
|
133
|
+
# Retrieves a list of traces specified by ID. Each trace is a collection
|
134
|
+
# of segment documents that originates from a single request. Use
|
135
|
+
# `GetTraceSummaries` to get a list of trace IDs.
|
136
|
+
# @option params [required, Array<String>] :trace_ids
|
137
|
+
# Specify the trace IDs of requests for which to retrieve segments.
|
138
|
+
# @option params [String] :next_token
|
139
|
+
# Pagination token. Not used.
|
140
|
+
# @return [Types::BatchGetTracesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
141
|
+
#
|
142
|
+
# * {Types::BatchGetTracesResult#traces #Traces} => Array<Types::Trace>
|
143
|
+
# * {Types::BatchGetTracesResult#unprocessed_trace_ids #UnprocessedTraceIds} => Array<String>
|
144
|
+
# * {Types::BatchGetTracesResult#next_token #NextToken} => String
|
145
|
+
#
|
146
|
+
# @example Request syntax with placeholder values
|
147
|
+
# resp = client.batch_get_traces({
|
148
|
+
# trace_ids: ["TraceId"], # required
|
149
|
+
# next_token: "String",
|
150
|
+
# })
|
151
|
+
#
|
152
|
+
# @example Response structure
|
153
|
+
# resp.traces #=> Array
|
154
|
+
# resp.traces[0].id #=> String
|
155
|
+
# resp.traces[0].duration #=> Float
|
156
|
+
# resp.traces[0].segments #=> Array
|
157
|
+
# resp.traces[0].segments[0].id #=> String
|
158
|
+
# resp.traces[0].segments[0].document #=> String
|
159
|
+
# resp.unprocessed_trace_ids #=> Array
|
160
|
+
# resp.unprocessed_trace_ids[0] #=> String
|
161
|
+
# resp.next_token #=> String
|
162
|
+
# @overload batch_get_traces(params = {})
|
163
|
+
# @param [Hash] params ({})
|
164
|
+
def batch_get_traces(params = {}, options = {})
|
165
|
+
req = build_request(:batch_get_traces, params)
|
166
|
+
req.send_request(options)
|
167
|
+
end
|
168
|
+
|
169
|
+
# Retrieves a document that describes services that process incoming
|
170
|
+
# requests, and downstream services that they call as a result. Root
|
171
|
+
# services process incoming requests and make calls to downstream
|
172
|
+
# services. Root services are applications that use the AWS X-Ray SDK.
|
173
|
+
# Downstream services can be other applications, AWS resources, HTTP web
|
174
|
+
# APIs, or SQL databases.
|
175
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
176
|
+
# The start of the time frame for which to generate a graph.
|
177
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
178
|
+
# The end of the time frame for which to generate a graph.
|
179
|
+
# @option params [String] :next_token
|
180
|
+
# Pagination token. Not used.
|
181
|
+
# @return [Types::GetServiceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
182
|
+
#
|
183
|
+
# * {Types::GetServiceGraphResult#start_time #StartTime} => Time
|
184
|
+
# * {Types::GetServiceGraphResult#end_time #EndTime} => Time
|
185
|
+
# * {Types::GetServiceGraphResult#services #Services} => Array<Types::Service>
|
186
|
+
# * {Types::GetServiceGraphResult#next_token #NextToken} => String
|
187
|
+
#
|
188
|
+
# @example Request syntax with placeholder values
|
189
|
+
# resp = client.get_service_graph({
|
190
|
+
# start_time: Time.now, # required
|
191
|
+
# end_time: Time.now, # required
|
192
|
+
# next_token: "String",
|
193
|
+
# })
|
194
|
+
#
|
195
|
+
# @example Response structure
|
196
|
+
# resp.start_time #=> Time
|
197
|
+
# resp.end_time #=> Time
|
198
|
+
# resp.services #=> Array
|
199
|
+
# resp.services[0].reference_id #=> Integer
|
200
|
+
# resp.services[0].name #=> String
|
201
|
+
# resp.services[0].names #=> Array
|
202
|
+
# resp.services[0].names[0] #=> String
|
203
|
+
# resp.services[0].root #=> Boolean
|
204
|
+
# resp.services[0].account_id #=> String
|
205
|
+
# resp.services[0].type #=> String
|
206
|
+
# resp.services[0].state #=> String
|
207
|
+
# resp.services[0].start_time #=> Time
|
208
|
+
# resp.services[0].end_time #=> Time
|
209
|
+
# resp.services[0].edges #=> Array
|
210
|
+
# resp.services[0].edges[0].reference_id #=> Integer
|
211
|
+
# resp.services[0].edges[0].start_time #=> Time
|
212
|
+
# resp.services[0].edges[0].end_time #=> Time
|
213
|
+
# resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
|
214
|
+
# resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
|
215
|
+
# resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
|
216
|
+
# resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
|
217
|
+
# resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
|
218
|
+
# resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
|
219
|
+
# resp.services[0].edges[0].summary_statistics.total_count #=> Integer
|
220
|
+
# resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
|
221
|
+
# resp.services[0].edges[0].response_time_histogram #=> Array
|
222
|
+
# resp.services[0].edges[0].response_time_histogram[0].value #=> Float
|
223
|
+
# resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
|
224
|
+
# resp.services[0].edges[0].aliases #=> Array
|
225
|
+
# resp.services[0].edges[0].aliases[0].name #=> String
|
226
|
+
# resp.services[0].edges[0].aliases[0].names #=> Array
|
227
|
+
# resp.services[0].edges[0].aliases[0].names[0] #=> String
|
228
|
+
# resp.services[0].edges[0].aliases[0].type #=> String
|
229
|
+
# resp.services[0].summary_statistics.ok_count #=> Integer
|
230
|
+
# resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
|
231
|
+
# resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
|
232
|
+
# resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
|
233
|
+
# resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
|
234
|
+
# resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
|
235
|
+
# resp.services[0].summary_statistics.total_count #=> Integer
|
236
|
+
# resp.services[0].summary_statistics.total_response_time #=> Float
|
237
|
+
# resp.services[0].duration_histogram #=> Array
|
238
|
+
# resp.services[0].duration_histogram[0].value #=> Float
|
239
|
+
# resp.services[0].duration_histogram[0].count #=> Integer
|
240
|
+
# resp.next_token #=> String
|
241
|
+
# @overload get_service_graph(params = {})
|
242
|
+
# @param [Hash] params ({})
|
243
|
+
def get_service_graph(params = {}, options = {})
|
244
|
+
req = build_request(:get_service_graph, params)
|
245
|
+
req.send_request(options)
|
246
|
+
end
|
247
|
+
|
248
|
+
# Retrieves a service graph for one or more specific trace IDs.
|
249
|
+
# @option params [required, Array<String>] :trace_ids
|
250
|
+
# Trace IDs of requests for which to generate a service graph.
|
251
|
+
# @option params [String] :next_token
|
252
|
+
# Pagination token. Not used.
|
253
|
+
# @return [Types::GetTraceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
254
|
+
#
|
255
|
+
# * {Types::GetTraceGraphResult#services #Services} => Array<Types::Service>
|
256
|
+
# * {Types::GetTraceGraphResult#next_token #NextToken} => String
|
257
|
+
#
|
258
|
+
# @example Request syntax with placeholder values
|
259
|
+
# resp = client.get_trace_graph({
|
260
|
+
# trace_ids: ["TraceId"], # required
|
261
|
+
# next_token: "String",
|
262
|
+
# })
|
263
|
+
#
|
264
|
+
# @example Response structure
|
265
|
+
# resp.services #=> Array
|
266
|
+
# resp.services[0].reference_id #=> Integer
|
267
|
+
# resp.services[0].name #=> String
|
268
|
+
# resp.services[0].names #=> Array
|
269
|
+
# resp.services[0].names[0] #=> String
|
270
|
+
# resp.services[0].root #=> Boolean
|
271
|
+
# resp.services[0].account_id #=> String
|
272
|
+
# resp.services[0].type #=> String
|
273
|
+
# resp.services[0].state #=> String
|
274
|
+
# resp.services[0].start_time #=> Time
|
275
|
+
# resp.services[0].end_time #=> Time
|
276
|
+
# resp.services[0].edges #=> Array
|
277
|
+
# resp.services[0].edges[0].reference_id #=> Integer
|
278
|
+
# resp.services[0].edges[0].start_time #=> Time
|
279
|
+
# resp.services[0].edges[0].end_time #=> Time
|
280
|
+
# resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
|
281
|
+
# resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
|
282
|
+
# resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
|
283
|
+
# resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
|
284
|
+
# resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
|
285
|
+
# resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
|
286
|
+
# resp.services[0].edges[0].summary_statistics.total_count #=> Integer
|
287
|
+
# resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
|
288
|
+
# resp.services[0].edges[0].response_time_histogram #=> Array
|
289
|
+
# resp.services[0].edges[0].response_time_histogram[0].value #=> Float
|
290
|
+
# resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
|
291
|
+
# resp.services[0].edges[0].aliases #=> Array
|
292
|
+
# resp.services[0].edges[0].aliases[0].name #=> String
|
293
|
+
# resp.services[0].edges[0].aliases[0].names #=> Array
|
294
|
+
# resp.services[0].edges[0].aliases[0].names[0] #=> String
|
295
|
+
# resp.services[0].edges[0].aliases[0].type #=> String
|
296
|
+
# resp.services[0].summary_statistics.ok_count #=> Integer
|
297
|
+
# resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
|
298
|
+
# resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
|
299
|
+
# resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
|
300
|
+
# resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
|
301
|
+
# resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
|
302
|
+
# resp.services[0].summary_statistics.total_count #=> Integer
|
303
|
+
# resp.services[0].summary_statistics.total_response_time #=> Float
|
304
|
+
# resp.services[0].duration_histogram #=> Array
|
305
|
+
# resp.services[0].duration_histogram[0].value #=> Float
|
306
|
+
# resp.services[0].duration_histogram[0].count #=> Integer
|
307
|
+
# resp.next_token #=> String
|
308
|
+
# @overload get_trace_graph(params = {})
|
309
|
+
# @param [Hash] params ({})
|
310
|
+
def get_trace_graph(params = {}, options = {})
|
311
|
+
req = build_request(:get_trace_graph, params)
|
312
|
+
req.send_request(options)
|
313
|
+
end
|
314
|
+
|
315
|
+
# Retrieves IDs and metadata for traces available for a specified time
|
316
|
+
# frame using an optional filter. To get the full traces, pass the trace
|
317
|
+
# IDs to `BatchGetTraces`.
|
318
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
319
|
+
# The start of the time frame for which to retrieve traces.
|
320
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
321
|
+
# The end of the time frame for which to retrieve traces.
|
322
|
+
# @option params [Boolean] :sampling
|
323
|
+
# Set to `true` to get summaries for only a subset of available traces.
|
324
|
+
# @option params [String] :filter_expression
|
325
|
+
# Specify a filter expression to retrieve trace summaries for services
|
326
|
+
# or requests that meet certain requirements.
|
327
|
+
# @option params [String] :next_token
|
328
|
+
# Specify the pagination token returned by a previous request to
|
329
|
+
# retrieve the next page of results.
|
330
|
+
# @return [Types::GetTraceSummariesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
331
|
+
#
|
332
|
+
# * {Types::GetTraceSummariesResult#trace_summaries #TraceSummaries} => Array<Types::TraceSummary>
|
333
|
+
# * {Types::GetTraceSummariesResult#approximate_time #ApproximateTime} => Time
|
334
|
+
# * {Types::GetTraceSummariesResult#traces_processed_count #TracesProcessedCount} => Integer
|
335
|
+
# * {Types::GetTraceSummariesResult#next_token #NextToken} => String
|
336
|
+
#
|
337
|
+
# @example Request syntax with placeholder values
|
338
|
+
# resp = client.get_trace_summaries({
|
339
|
+
# start_time: Time.now, # required
|
340
|
+
# end_time: Time.now, # required
|
341
|
+
# sampling: false,
|
342
|
+
# filter_expression: "FilterExpression",
|
343
|
+
# next_token: "String",
|
344
|
+
# })
|
345
|
+
#
|
346
|
+
# @example Response structure
|
347
|
+
# resp.trace_summaries #=> Array
|
348
|
+
# resp.trace_summaries[0].id #=> String
|
349
|
+
# resp.trace_summaries[0].duration #=> Float
|
350
|
+
# resp.trace_summaries[0].response_time #=> Float
|
351
|
+
# resp.trace_summaries[0].has_fault #=> Boolean
|
352
|
+
# resp.trace_summaries[0].has_error #=> Boolean
|
353
|
+
# resp.trace_summaries[0].has_throttle #=> Boolean
|
354
|
+
# resp.trace_summaries[0].is_partial #=> Boolean
|
355
|
+
# resp.trace_summaries[0].http.http_url #=> String
|
356
|
+
# resp.trace_summaries[0].http.http_status #=> Integer
|
357
|
+
# resp.trace_summaries[0].http.http_method #=> String
|
358
|
+
# resp.trace_summaries[0].http.user_agent #=> String
|
359
|
+
# resp.trace_summaries[0].http.client_ip #=> String
|
360
|
+
# resp.trace_summaries[0].annotations #=> Hash
|
361
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"] #=> Array
|
362
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.number_value #=> Float
|
363
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.boolean_value #=> Boolean
|
364
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.string_value #=> String
|
365
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids #=> Array
|
366
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].name #=> String
|
367
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names #=> Array
|
368
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names[0] #=> String
|
369
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].account_id #=> String
|
370
|
+
# resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].type #=> String
|
371
|
+
# resp.trace_summaries[0].users #=> Array
|
372
|
+
# resp.trace_summaries[0].users[0].user_name #=> String
|
373
|
+
# resp.trace_summaries[0].users[0].service_ids #=> Array
|
374
|
+
# resp.trace_summaries[0].users[0].service_ids[0].name #=> String
|
375
|
+
# resp.trace_summaries[0].users[0].service_ids[0].names #=> Array
|
376
|
+
# resp.trace_summaries[0].users[0].service_ids[0].names[0] #=> String
|
377
|
+
# resp.trace_summaries[0].users[0].service_ids[0].account_id #=> String
|
378
|
+
# resp.trace_summaries[0].users[0].service_ids[0].type #=> String
|
379
|
+
# resp.trace_summaries[0].service_ids #=> Array
|
380
|
+
# resp.trace_summaries[0].service_ids[0].name #=> String
|
381
|
+
# resp.trace_summaries[0].service_ids[0].names #=> Array
|
382
|
+
# resp.trace_summaries[0].service_ids[0].names[0] #=> String
|
383
|
+
# resp.trace_summaries[0].service_ids[0].account_id #=> String
|
384
|
+
# resp.trace_summaries[0].service_ids[0].type #=> String
|
385
|
+
# resp.approximate_time #=> Time
|
386
|
+
# resp.traces_processed_count #=> Integer
|
387
|
+
# resp.next_token #=> String
|
388
|
+
# @overload get_trace_summaries(params = {})
|
389
|
+
# @param [Hash] params ({})
|
390
|
+
def get_trace_summaries(params = {}, options = {})
|
391
|
+
req = build_request(:get_trace_summaries, params)
|
392
|
+
req.send_request(options)
|
393
|
+
end
|
394
|
+
|
395
|
+
# Used by the AWS X-Ray daemon to upload telemetry.
|
396
|
+
# @option params [required, Array<Types::TelemetryRecord>] :telemetry_records
|
397
|
+
# @option params [String] :ec2_instance_id
|
398
|
+
# @option params [String] :hostname
|
399
|
+
# @option params [String] :resource_arn
|
400
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
401
|
+
#
|
402
|
+
# @example Request syntax with placeholder values
|
403
|
+
# resp = client.put_telemetry_records({
|
404
|
+
# telemetry_records: [ # required
|
405
|
+
# {
|
406
|
+
# timestamp: Time.now,
|
407
|
+
# segments_received_count: 1,
|
408
|
+
# segments_sent_count: 1,
|
409
|
+
# segments_spillover_count: 1,
|
410
|
+
# segments_rejected_count: 1,
|
411
|
+
# backend_connection_errors: {
|
412
|
+
# timeout_count: 1,
|
413
|
+
# connection_refused_count: 1,
|
414
|
+
# http_code_4_xx_count: 1,
|
415
|
+
# http_code_5_xx_count: 1,
|
416
|
+
# unknown_host_count: 1,
|
417
|
+
# other_count: 1,
|
418
|
+
# },
|
419
|
+
# },
|
420
|
+
# ],
|
421
|
+
# ec2_instance_id: "String",
|
422
|
+
# hostname: "String",
|
423
|
+
# resource_arn: "String",
|
424
|
+
# })
|
425
|
+
# @overload put_telemetry_records(params = {})
|
426
|
+
# @param [Hash] params ({})
|
427
|
+
def put_telemetry_records(params = {}, options = {})
|
428
|
+
req = build_request(:put_telemetry_records, params)
|
429
|
+
req.send_request(options)
|
430
|
+
end
|
431
|
+
|
432
|
+
# Uploads segment documents to AWS X-Ray. The X-Ray SDK generates
|
433
|
+
# segment documents and sends them to the X-Ray daemon, which uploads
|
434
|
+
# them in batches. A segment document can be a completed segment, an
|
435
|
+
# in-progress segment, or an array of subsegments.
|
436
|
+
# @option params [required, Array<String>] :trace_segment_documents
|
437
|
+
# A JSON document defining one or more segments or subsegments. Segments
|
438
|
+
# must include the following fields.
|
439
|
+
#
|
440
|
+
# **Required Segment Document Fields**
|
441
|
+
#
|
442
|
+
# * `name` - The name of the service that handled the request.
|
443
|
+
#
|
444
|
+
# * `id` - A 64-bit identifier for the segment, unique among segments in
|
445
|
+
# the same trace, in 16 hexadecimal digits.
|
446
|
+
#
|
447
|
+
# * `trace_id` - A unique identifier that connects all segments and
|
448
|
+
# subsegments originating from a single client request.
|
449
|
+
#
|
450
|
+
# * `start_time` - Time the segment or subsegment was created, in
|
451
|
+
# floating point seconds in epoch time, accurate to milliseconds. For
|
452
|
+
# example, `1480615200.010` or `1.480615200010E9`.
|
453
|
+
#
|
454
|
+
# * `end_time` - Time the segment or subsegment was closed. For example,
|
455
|
+
# `1480615200.090` or `1.480615200090E9`. Specify either an `end_time`
|
456
|
+
# or `in_progress`.
|
457
|
+
#
|
458
|
+
# * `in_progress` - Set to `true` instead of specifying an `end_time` to
|
459
|
+
# record that a segment has been started, but is not complete. Send an
|
460
|
+
# in progress segment when your application receives a request that
|
461
|
+
# will take a long time to serve, to trace the fact that the request
|
462
|
+
# was received. When the response is sent, send the complete segment
|
463
|
+
# to overwrite the in-progress segment.
|
464
|
+
#
|
465
|
+
# A `trace_id` consists of three numbers separated by hyphens. For
|
466
|
+
# example, 1-58406520-a006649127e371903a2de979. This includes:
|
467
|
+
#
|
468
|
+
# **Trace ID Format**
|
469
|
+
#
|
470
|
+
# * The version number, i.e. `1`.
|
471
|
+
#
|
472
|
+
# * The time of the original request, in Unix epoch time, in 8
|
473
|
+
# hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in
|
474
|
+
# epoch time is `1480615200` seconds, or `58406520` in hexadecimal.
|
475
|
+
#
|
476
|
+
# * A 96-bit identifier for the trace, globally unique, in 24
|
477
|
+
# hexadecimal digits.
|
478
|
+
# @return [Types::PutTraceSegmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
479
|
+
#
|
480
|
+
# * {Types::PutTraceSegmentsResult#unprocessed_trace_segments #UnprocessedTraceSegments} => Array<Types::UnprocessedTraceSegment>
|
481
|
+
#
|
482
|
+
# @example Request syntax with placeholder values
|
483
|
+
# resp = client.put_trace_segments({
|
484
|
+
# trace_segment_documents: ["TraceSegmentDocument"], # required
|
485
|
+
# })
|
486
|
+
#
|
487
|
+
# @example Response structure
|
488
|
+
# resp.unprocessed_trace_segments #=> Array
|
489
|
+
# resp.unprocessed_trace_segments[0].id #=> String
|
490
|
+
# resp.unprocessed_trace_segments[0].error_code #=> String
|
491
|
+
# resp.unprocessed_trace_segments[0].message #=> String
|
492
|
+
# @overload put_trace_segments(params = {})
|
493
|
+
# @param [Hash] params ({})
|
494
|
+
def put_trace_segments(params = {}, options = {})
|
495
|
+
req = build_request(:put_trace_segments, params)
|
496
|
+
req.send_request(options)
|
497
|
+
end
|
498
|
+
|
499
|
+
# @!endgroup
|
500
|
+
|
501
|
+
# @param params ({})
|
502
|
+
# @api private
|
503
|
+
def build_request(operation_name, params = {})
|
504
|
+
handlers = @handlers.for(operation_name)
|
505
|
+
context = Seahorse::Client::RequestContext.new(
|
506
|
+
operation_name: operation_name,
|
507
|
+
operation: config.api.operation(operation_name),
|
508
|
+
client: self,
|
509
|
+
params: params,
|
510
|
+
config: config)
|
511
|
+
context[:gem_name] = 'aws-sdk-xray'
|
512
|
+
context[:gem_version] = '1.0.0.rc2'
|
513
|
+
Seahorse::Client::Request.new(handlers, context)
|
514
|
+
end
|
515
|
+
|
516
|
+
# @api private
|
517
|
+
# @deprecated
|
518
|
+
def waiter_names
|
519
|
+
[]
|
520
|
+
end
|
521
|
+
|
522
|
+
class << self
|
523
|
+
|
524
|
+
# @api private
|
525
|
+
attr_reader :identifier
|
526
|
+
|
527
|
+
# @api private
|
528
|
+
def errors_module
|
529
|
+
Errors
|
530
|
+
end
|
531
|
+
|
532
|
+
end
|
533
|
+
end
|
534
|
+
end
|
535
|
+
end
|