aws-sdk-xray 1.0.0.rc2 → 1.0.0.rc3

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.
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module XRay
10
- module Errors
8
+ module Aws::XRay
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module XRay
10
- class Resource
8
+ module Aws::XRay
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,865 +1,979 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module XRay
10
- module Types
11
-
12
- # An alias for an edge.
13
- # @!attribute [rw] name
14
- # The canonical name of the alias.
15
- # @return [String]
16
- #
17
- # @!attribute [rw] names
18
- # A list of names for the alias, including the canonical name.
19
- # @return [Array<String>]
20
- #
21
- # @!attribute [rw] type
22
- # The type of the alias.
23
- # @return [String]
24
- class Alias < Struct.new(
25
- :name,
26
- :names,
27
- :type)
28
- include Aws::Structure
29
- end
30
-
31
- # Value of a segment annotation. Has one of three value types: Number,
32
- # Boolean or String.
33
- # @!attribute [rw] number_value
34
- # Value for a Number annotation.
35
- # @return [Float]
36
- #
37
- # @!attribute [rw] boolean_value
38
- # Value for a Boolean annotation.
39
- # @return [Boolean]
40
- #
41
- # @!attribute [rw] string_value
42
- # Value for a String annotation.
43
- # @return [String]
44
- class AnnotationValue < Struct.new(
45
- :number_value,
46
- :boolean_value,
47
- :string_value)
48
- include Aws::Structure
49
- end
50
-
51
- # @note When making an API call, pass BackendConnectionErrors
52
- # data as a hash:
53
- #
54
- # {
55
- # timeout_count: 1,
56
- # connection_refused_count: 1,
57
- # http_code_4_xx_count: 1,
58
- # http_code_5_xx_count: 1,
59
- # unknown_host_count: 1,
60
- # other_count: 1,
61
- # }
62
- # @!attribute [rw] timeout_count
63
- # @return [Integer]
64
- #
65
- # @!attribute [rw] connection_refused_count
66
- # @return [Integer]
67
- #
68
- # @!attribute [rw] http_code_4_xx_count
69
- # @return [Integer]
70
- #
71
- # @!attribute [rw] http_code_5_xx_count
72
- # @return [Integer]
73
- #
74
- # @!attribute [rw] unknown_host_count
75
- # @return [Integer]
76
- #
77
- # @!attribute [rw] other_count
78
- # @return [Integer]
79
- class BackendConnectionErrors < Struct.new(
80
- :timeout_count,
81
- :connection_refused_count,
82
- :http_code_4_xx_count,
83
- :http_code_5_xx_count,
84
- :unknown_host_count,
85
- :other_count)
86
- include Aws::Structure
87
- end
88
-
89
- # @note When making an API call, pass BatchGetTracesRequest
90
- # data as a hash:
91
- #
92
- # {
93
- # trace_ids: ["TraceId"], # required
94
- # next_token: "String",
95
- # }
96
- # @!attribute [rw] trace_ids
97
- # Specify the trace IDs of requests for which to retrieve segments.
98
- # @return [Array<String>]
99
- #
100
- # @!attribute [rw] next_token
101
- # Pagination token. Not used.
102
- # @return [String]
103
- class BatchGetTracesRequest < Struct.new(
104
- :trace_ids,
105
- :next_token)
106
- include Aws::Structure
107
- end
108
-
109
- # @!attribute [rw] traces
110
- # Full traces for the specified requests.
111
- # @return [Array<Types::Trace>]
112
- #
113
- # @!attribute [rw] unprocessed_trace_ids
114
- # Trace IDs of requests that haven't been processed.
115
- # @return [Array<String>]
116
- #
117
- # @!attribute [rw] next_token
118
- # Pagination token. Not used.
119
- # @return [String]
120
- class BatchGetTracesResult < Struct.new(
121
- :traces,
122
- :unprocessed_trace_ids,
123
- :next_token)
124
- include Aws::Structure
125
- end
126
-
127
- # Information about a connection between two services.
128
- # @!attribute [rw] reference_id
129
- # Identifier of the edge. Unique within a service map.
130
- # @return [Integer]
131
- #
132
- # @!attribute [rw] start_time
133
- # The start time of the first segment on the edge.
134
- # @return [Time]
135
- #
136
- # @!attribute [rw] end_time
137
- # The end time of the last segment on the edge.
138
- # @return [Time]
139
- #
140
- # @!attribute [rw] summary_statistics
141
- # Response statistics for segments on the edge.
142
- # @return [Types::EdgeStatistics]
143
- #
144
- # @!attribute [rw] response_time_histogram
145
- # Histogram describing the prominence of response times on the edge.
146
- # @return [Array<Types::HistogramEntry>]
147
- #
148
- # @!attribute [rw] aliases
149
- # Aliases for the edge.
150
- # @return [Array<Types::Alias>]
151
- class Edge < Struct.new(
152
- :reference_id,
153
- :start_time,
154
- :end_time,
155
- :summary_statistics,
156
- :response_time_histogram,
157
- :aliases)
158
- include Aws::Structure
159
- end
160
-
161
- # Response statistics for an edge.
162
- # @!attribute [rw] ok_count
163
- # The number of requests that completed with a 2xx Success status
164
- # code.
165
- # @return [Integer]
166
- #
167
- # @!attribute [rw] error_statistics
168
- # Information about requests that failed with a 4xx Client Error
169
- # status code.
170
- # @return [Types::ErrorStatistics]
171
- #
172
- # @!attribute [rw] fault_statistics
173
- # Information about requests that failed with a 5xx Server Error
174
- # status code.
175
- # @return [Types::FaultStatistics]
176
- #
177
- # @!attribute [rw] total_count
178
- # The total number of completed requests.
179
- # @return [Integer]
180
- #
181
- # @!attribute [rw] total_response_time
182
- # The aggregate response time of completed requests.
183
- # @return [Float]
184
- class EdgeStatistics < Struct.new(
185
- :ok_count,
186
- :error_statistics,
187
- :fault_statistics,
188
- :total_count,
189
- :total_response_time)
190
- include Aws::Structure
191
- end
192
-
193
- # Information about requests that failed with a 4xx Client Error status
194
- # code.
195
- # @!attribute [rw] throttle_count
196
- # The number of requests that failed with a 419 throttling status
197
- # code.
198
- # @return [Integer]
199
- #
200
- # @!attribute [rw] other_count
201
- # The number of requests that failed with untracked 4xx Client Error
202
- # status codes.
203
- # @return [Integer]
204
- #
205
- # @!attribute [rw] total_count
206
- # The total number of requests that failed with a 4xx Client Error
207
- # status code.
208
- # @return [Integer]
209
- class ErrorStatistics < Struct.new(
210
- :throttle_count,
211
- :other_count,
212
- :total_count)
213
- include Aws::Structure
214
- end
215
-
216
- # Information about requests that failed with a 5xx Server Error status
217
- # code.
218
- # @!attribute [rw] other_count
219
- # The number of requests that failed with untracked 5xx Server Error
220
- # status codes.
221
- # @return [Integer]
222
- #
223
- # @!attribute [rw] total_count
224
- # The total number of requests that failed with a 5xx Server Error
225
- # status code.
226
- # @return [Integer]
227
- class FaultStatistics < Struct.new(
228
- :other_count,
229
- :total_count)
230
- include Aws::Structure
231
- end
232
-
233
- # @note When making an API call, pass GetServiceGraphRequest
234
- # data as a hash:
235
- #
236
- # {
237
- # start_time: Time.now, # required
238
- # end_time: Time.now, # required
239
- # next_token: "String",
240
- # }
241
- # @!attribute [rw] start_time
242
- # The start of the time frame for which to generate a graph.
243
- # @return [Time]
244
- #
245
- # @!attribute [rw] end_time
246
- # The end of the time frame for which to generate a graph.
247
- # @return [Time]
248
- #
249
- # @!attribute [rw] next_token
250
- # Pagination token. Not used.
251
- # @return [String]
252
- class GetServiceGraphRequest < Struct.new(
253
- :start_time,
254
- :end_time,
255
- :next_token)
256
- include Aws::Structure
257
- end
258
-
259
- # @!attribute [rw] start_time
260
- # The start of the time frame for which the graph was generated.
261
- # @return [Time]
262
- #
263
- # @!attribute [rw] end_time
264
- # The end of the time frame for which the graph was generated.
265
- # @return [Time]
266
- #
267
- # @!attribute [rw] services
268
- # The services that have processed a traced request during the
269
- # specified time frame.
270
- # @return [Array<Types::Service>]
271
- #
272
- # @!attribute [rw] next_token
273
- # Pagination token. Not used.
274
- # @return [String]
275
- class GetServiceGraphResult < Struct.new(
276
- :start_time,
277
- :end_time,
278
- :services,
279
- :next_token)
280
- include Aws::Structure
281
- end
282
-
283
- # @note When making an API call, pass GetTraceGraphRequest
284
- # data as a hash:
285
- #
286
- # {
287
- # trace_ids: ["TraceId"], # required
288
- # next_token: "String",
289
- # }
290
- # @!attribute [rw] trace_ids
291
- # Trace IDs of requests for which to generate a service graph.
292
- # @return [Array<String>]
293
- #
294
- # @!attribute [rw] next_token
295
- # Pagination token. Not used.
296
- # @return [String]
297
- class GetTraceGraphRequest < Struct.new(
298
- :trace_ids,
299
- :next_token)
300
- include Aws::Structure
301
- end
302
-
303
- # @!attribute [rw] services
304
- # The services that have processed one of the specified requests.
305
- # @return [Array<Types::Service>]
306
- #
307
- # @!attribute [rw] next_token
308
- # Pagination token. Not used.
309
- # @return [String]
310
- class GetTraceGraphResult < Struct.new(
311
- :services,
312
- :next_token)
313
- include Aws::Structure
314
- end
315
-
316
- # @note When making an API call, pass GetTraceSummariesRequest
317
- # data as a hash:
318
- #
319
- # {
320
- # start_time: Time.now, # required
321
- # end_time: Time.now, # required
322
- # sampling: false,
323
- # filter_expression: "FilterExpression",
324
- # next_token: "String",
325
- # }
326
- # @!attribute [rw] start_time
327
- # The start of the time frame for which to retrieve traces.
328
- # @return [Time]
329
- #
330
- # @!attribute [rw] end_time
331
- # The end of the time frame for which to retrieve traces.
332
- # @return [Time]
333
- #
334
- # @!attribute [rw] sampling
335
- # Set to `true` to get summaries for only a subset of available
336
- # traces.
337
- # @return [Boolean]
338
- #
339
- # @!attribute [rw] filter_expression
340
- # Specify a filter expression to retrieve trace summaries for services
341
- # or requests that meet certain requirements.
342
- # @return [String]
343
- #
344
- # @!attribute [rw] next_token
345
- # Specify the pagination token returned by a previous request to
346
- # retrieve the next page of results.
347
- # @return [String]
348
- class GetTraceSummariesRequest < Struct.new(
349
- :start_time,
350
- :end_time,
351
- :sampling,
352
- :filter_expression,
353
- :next_token)
354
- include Aws::Structure
355
- end
356
-
357
- # @!attribute [rw] trace_summaries
358
- # Trace IDs and metadata for traces that were found in the specified
359
- # time frame.
360
- # @return [Array<Types::TraceSummary>]
361
- #
362
- # @!attribute [rw] approximate_time
363
- # The start time of this page of results.
364
- # @return [Time]
365
- #
366
- # @!attribute [rw] traces_processed_count
367
- # The number of traces that were processed to get this set of
368
- # summaries.
369
- # @return [Integer]
370
- #
371
- # @!attribute [rw] next_token
372
- # If the requested time frame contained more than one page of results,
373
- # you can use this token to retrieve the next page. The first page
374
- # contains the most most recent results, closest to the end of the
375
- # time frame.
376
- # @return [String]
377
- class GetTraceSummariesResult < Struct.new(
378
- :trace_summaries,
379
- :approximate_time,
380
- :traces_processed_count,
381
- :next_token)
382
- include Aws::Structure
383
- end
384
-
385
- # An entry in a histogram for a statistic. A histogram maps the range of
386
- # observed values on the X axis, and the prevalence of each value on the
387
- # Y axis.
388
- # @!attribute [rw] value
389
- # The value of the entry.
390
- # @return [Float]
391
- #
392
- # @!attribute [rw] count
393
- # The prevalence of the entry.
394
- # @return [Integer]
395
- class HistogramEntry < Struct.new(
396
- :value,
397
- :count)
398
- include Aws::Structure
399
- end
400
-
401
- # Information about an HTTP request.
402
- # @!attribute [rw] http_url
403
- # The request URL.
404
- # @return [String]
405
- #
406
- # @!attribute [rw] http_status
407
- # The response status.
408
- # @return [Integer]
409
- #
410
- # @!attribute [rw] http_method
411
- # The request method.
412
- # @return [String]
413
- #
414
- # @!attribute [rw] user_agent
415
- # The request's user agent string.
416
- # @return [String]
417
- #
418
- # @!attribute [rw] client_ip
419
- # The IP address of the requestor.
420
- # @return [String]
421
- class Http < Struct.new(
422
- :http_url,
423
- :http_status,
424
- :http_method,
425
- :user_agent,
426
- :client_ip)
427
- include Aws::Structure
428
- end
429
-
430
- # @note When making an API call, pass PutTelemetryRecordsRequest
431
- # data as a hash:
432
- #
433
- # {
434
- # telemetry_records: [ # required
435
- # {
436
- # timestamp: Time.now,
437
- # segments_received_count: 1,
438
- # segments_sent_count: 1,
439
- # segments_spillover_count: 1,
440
- # segments_rejected_count: 1,
441
- # backend_connection_errors: {
442
- # timeout_count: 1,
443
- # connection_refused_count: 1,
444
- # http_code_4_xx_count: 1,
445
- # http_code_5_xx_count: 1,
446
- # unknown_host_count: 1,
447
- # other_count: 1,
448
- # },
449
- # },
450
- # ],
451
- # ec2_instance_id: "String",
452
- # hostname: "String",
453
- # resource_arn: "String",
454
- # }
455
- # @!attribute [rw] telemetry_records
456
- # @return [Array<Types::TelemetryRecord>]
457
- #
458
- # @!attribute [rw] ec2_instance_id
459
- # @return [String]
460
- #
461
- # @!attribute [rw] hostname
462
- # @return [String]
463
- #
464
- # @!attribute [rw] resource_arn
465
- # @return [String]
466
- class PutTelemetryRecordsRequest < Struct.new(
467
- :telemetry_records,
468
- :ec2_instance_id,
469
- :hostname,
470
- :resource_arn)
471
- include Aws::Structure
472
- end
473
-
474
- class PutTelemetryRecordsResult < Aws::EmptyStructure; end
475
-
476
- # @note When making an API call, pass PutTraceSegmentsRequest
477
- # data as a hash:
478
- #
479
- # {
480
- # trace_segment_documents: ["TraceSegmentDocument"], # required
481
- # }
482
- # @!attribute [rw] trace_segment_documents
483
- # A JSON document defining one or more segments or subsegments.
484
- # Segments must include the following fields.
485
- #
486
- # **Required Segment Document Fields**
487
- #
488
- # * `name` - The name of the service that handled the request.
489
- #
490
- # * `id` - A 64-bit identifier for the segment, unique among segments
491
- # in the same trace, in 16 hexadecimal digits.
492
- #
493
- # * `trace_id` - A unique identifier that connects all segments and
494
- # subsegments originating from a single client request.
495
- #
496
- # * `start_time` - Time the segment or subsegment was created, in
497
- # floating point seconds in epoch time, accurate to milliseconds.
498
- # For example, `1480615200.010` or `1.480615200010E9`.
499
- #
500
- # * `end_time` - Time the segment or subsegment was closed. For
501
- # example, `1480615200.090` or `1.480615200090E9`. Specify either an
502
- # `end_time` or `in_progress`.
503
- #
504
- # * `in_progress` - Set to `true` instead of specifying an `end_time`
505
- # to record that a segment has been started, but is not complete.
506
- # Send an in progress segment when your application receives a
507
- # request that will take a long time to serve, to trace the fact
508
- # that the request was received. When the response is sent, send the
509
- # complete segment to overwrite the in-progress segment.
510
- #
511
- # A `trace_id` consists of three numbers separated by hyphens. For
512
- # example, 1-58406520-a006649127e371903a2de979. This includes:
513
- #
514
- # **Trace ID Format**
515
- #
516
- # * The version number, i.e. `1`.
517
- #
518
- # * The time of the original request, in Unix epoch time, in 8
519
- # hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in
520
- # epoch time is `1480615200` seconds, or `58406520` in hexadecimal.
521
- #
522
- # * A 96-bit identifier for the trace, globally unique, in 24
523
- # hexadecimal digits.
524
- # @return [Array<String>]
525
- class PutTraceSegmentsRequest < Struct.new(
526
- :trace_segment_documents)
527
- include Aws::Structure
528
- end
529
-
530
- # @!attribute [rw] unprocessed_trace_segments
531
- # Segments that failed processing.
532
- # @return [Array<Types::UnprocessedTraceSegment>]
533
- class PutTraceSegmentsResult < Struct.new(
534
- :unprocessed_trace_segments)
535
- include Aws::Structure
536
- end
537
-
538
- # Information about a segment
539
- # @!attribute [rw] id
540
- # The segment's ID.
541
- # @return [String]
542
- #
543
- # @!attribute [rw] document
544
- # The segment document.
545
- # @return [String]
546
- class Segment < Struct.new(
547
- :id,
548
- :document)
549
- include Aws::Structure
550
- end
551
-
552
- # Information about an application that processed requests, users that
553
- # made requests, or downstream services, resources and applications that
554
- # an application used.
555
- # @!attribute [rw] reference_id
556
- # Identifier for the service. Unique within the service map.
557
- # @return [Integer]
558
- #
559
- # @!attribute [rw] name
560
- # The canonical name of the service.
561
- # @return [String]
562
- #
563
- # @!attribute [rw] names
564
- # A list of names for the service, including the canonical name.
565
- # @return [Array<String>]
566
- #
567
- # @!attribute [rw] root
568
- # Indicates that the service was the first service to process a
569
- # request.
570
- # @return [Boolean]
571
- #
572
- # @!attribute [rw] account_id
573
- # Identifier of the AWS account in which the service runs.
574
- # @return [String]
575
- #
576
- # @!attribute [rw] type
577
- # The type of service.
578
- #
579
- # * AWS Resource - The type of an AWS resource. For example,
580
- # `AWS::EC2::Instance` for a application running on Amazon EC2 or
581
- # `AWS::DynamoDB::Table` for an Amazon DynamoDB table that the
582
- # application used.
583
- #
584
- # * AWS Service - The type of an AWS service. For example,
585
- # `AWS::DynamoDB` for downstream calls to Amazon DynamoDB that
586
- # didn't target a specific table.
587
- #
588
- # * `client` - Represents the clients that sent requests to a root
589
- # service.
590
- #
591
- # * `remote` - A downstream service of indeterminate type.
592
- # @return [String]
593
- #
594
- # @!attribute [rw] state
595
- # The service's state.
596
- # @return [String]
597
- #
598
- # @!attribute [rw] start_time
599
- # The start time of the first segment that the service generated.
600
- # @return [Time]
601
- #
602
- # @!attribute [rw] end_time
603
- # The end time of the last segment that the service generated.
604
- # @return [Time]
605
- #
606
- # @!attribute [rw] edges
607
- # Connections to downstream services.
608
- # @return [Array<Types::Edge>]
609
- #
610
- # @!attribute [rw] summary_statistics
611
- # Aggregated statistics for the service.
612
- # @return [Types::ServiceStatistics]
613
- #
614
- # @!attribute [rw] duration_histogram
615
- # Histogram mapping the spread of trace durations
616
- # @return [Array<Types::HistogramEntry>]
617
- class Service < Struct.new(
618
- :reference_id,
619
- :name,
620
- :names,
621
- :root,
622
- :account_id,
623
- :type,
624
- :state,
625
- :start_time,
626
- :end_time,
627
- :edges,
628
- :summary_statistics,
629
- :duration_histogram)
630
- include Aws::Structure
631
- end
632
-
633
- # @!attribute [rw] name
634
- # @return [String]
635
- #
636
- # @!attribute [rw] names
637
- # @return [Array<String>]
638
- #
639
- # @!attribute [rw] account_id
640
- # @return [String]
641
- #
642
- # @!attribute [rw] type
643
- # @return [String]
644
- class ServiceId < Struct.new(
645
- :name,
646
- :names,
647
- :account_id,
648
- :type)
649
- include Aws::Structure
650
- end
651
-
652
- # Response statistics for a service.
653
- # @!attribute [rw] ok_count
654
- # The number of requests that completed with a 2xx Success status
655
- # code.
656
- # @return [Integer]
657
- #
658
- # @!attribute [rw] error_statistics
659
- # Information about requests that failed with a 4xx Client Error
660
- # status code.
661
- # @return [Types::ErrorStatistics]
662
- #
663
- # @!attribute [rw] fault_statistics
664
- # Information about requests that failed with a 5xx Server Error
665
- # status code.
666
- # @return [Types::FaultStatistics]
667
- #
668
- # @!attribute [rw] total_count
669
- # The total number of completed requests.
670
- # @return [Integer]
671
- #
672
- # @!attribute [rw] total_response_time
673
- # The aggregate response time of completed requests.
674
- # @return [Float]
675
- class ServiceStatistics < Struct.new(
676
- :ok_count,
677
- :error_statistics,
678
- :fault_statistics,
679
- :total_count,
680
- :total_response_time)
681
- include Aws::Structure
682
- end
683
-
684
- # @note When making an API call, pass TelemetryRecord
685
- # data as a hash:
686
- #
687
- # {
688
- # timestamp: Time.now,
689
- # segments_received_count: 1,
690
- # segments_sent_count: 1,
691
- # segments_spillover_count: 1,
692
- # segments_rejected_count: 1,
693
- # backend_connection_errors: {
694
- # timeout_count: 1,
695
- # connection_refused_count: 1,
696
- # http_code_4_xx_count: 1,
697
- # http_code_5_xx_count: 1,
698
- # unknown_host_count: 1,
699
- # other_count: 1,
700
- # },
701
- # }
702
- # @!attribute [rw] timestamp
703
- # @return [Time]
704
- #
705
- # @!attribute [rw] segments_received_count
706
- # @return [Integer]
707
- #
708
- # @!attribute [rw] segments_sent_count
709
- # @return [Integer]
710
- #
711
- # @!attribute [rw] segments_spillover_count
712
- # @return [Integer]
713
- #
714
- # @!attribute [rw] segments_rejected_count
715
- # @return [Integer]
716
- #
717
- # @!attribute [rw] backend_connection_errors
718
- # @return [Types::BackendConnectionErrors]
719
- class TelemetryRecord < Struct.new(
720
- :timestamp,
721
- :segments_received_count,
722
- :segments_sent_count,
723
- :segments_spillover_count,
724
- :segments_rejected_count,
725
- :backend_connection_errors)
726
- include Aws::Structure
727
- end
728
-
729
- # A collection of segment documents with matching trace IDs.
730
- # @!attribute [rw] id
731
- # The unique identifier for the request that generated the trace's
732
- # segments and subsegments.
733
- # @return [String]
734
- #
735
- # @!attribute [rw] duration
736
- # The length of time in seconds between the start time of the root
737
- # segment and the end time of the last segment that completed.
738
- # @return [Float]
739
- #
740
- # @!attribute [rw] segments
741
- # Segment documents for the segments and subsegments that comprise the
742
- # trace.
743
- # @return [Array<Types::Segment>]
744
- class Trace < Struct.new(
745
- :id,
746
- :duration,
747
- :segments)
748
- include Aws::Structure
749
- end
750
-
751
- # Metadata generated from the segment documents in a trace.
752
- # @!attribute [rw] id
753
- # The unique identifier for the request that generated the trace's
754
- # segments and subsegments.
755
- # @return [String]
756
- #
757
- # @!attribute [rw] duration
758
- # The length of time in seconds between the start time of the root
759
- # segment and the end time of the last segment that completed.
760
- # @return [Float]
761
- #
762
- # @!attribute [rw] response_time
763
- # The length of time in seconds between the start and end times of the
764
- # root segment. If the service performs work asynchronously, the
765
- # response time measures the time before the response is sent to the
766
- # user, while the duration measures the amount of time before the last
767
- # traced activity completes.
768
- # @return [Float]
769
- #
770
- # @!attribute [rw] has_fault
771
- # One or more of the segment documents has a 500 series error.
772
- # @return [Boolean]
773
- #
774
- # @!attribute [rw] has_error
775
- # One or more of the segment documents has a 400 series error.
776
- # @return [Boolean]
777
- #
778
- # @!attribute [rw] has_throttle
779
- # One or more of the segment documents has a 429 throttling error.
780
- # @return [Boolean]
781
- #
782
- # @!attribute [rw] is_partial
783
- # One or more of the segment documents is in progress.
784
- # @return [Boolean]
785
- #
786
- # @!attribute [rw] http
787
- # Information about the HTTP request served by the trace.
788
- # @return [Types::Http]
789
- #
790
- # @!attribute [rw] annotations
791
- # Annotations from the trace's segment documents.
792
- # @return [Hash<String,Array<Types::ValueWithServiceIds>>]
793
- #
794
- # @!attribute [rw] users
795
- # Users from the trace's segment documents.
796
- # @return [Array<Types::TraceUser>]
797
- #
798
- # @!attribute [rw] service_ids
799
- # Service IDs from the trace's segment documents.
800
- # @return [Array<Types::ServiceId>]
801
- class TraceSummary < Struct.new(
802
- :id,
803
- :duration,
804
- :response_time,
805
- :has_fault,
806
- :has_error,
807
- :has_throttle,
808
- :is_partial,
809
- :http,
810
- :annotations,
811
- :users,
812
- :service_ids)
813
- include Aws::Structure
814
- end
815
-
816
- # Information about a user recorded in segment documents.
817
- # @!attribute [rw] user_name
818
- # The user's name.
819
- # @return [String]
820
- #
821
- # @!attribute [rw] service_ids
822
- # Services that the user's request hit.
823
- # @return [Array<Types::ServiceId>]
824
- class TraceUser < Struct.new(
825
- :user_name,
826
- :service_ids)
827
- include Aws::Structure
828
- end
829
-
830
- # Information about a segment that failed processing.
831
- # @!attribute [rw] id
832
- # The segment's ID.
833
- # @return [String]
834
- #
835
- # @!attribute [rw] error_code
836
- # The error that caused processing to fail.
837
- # @return [String]
838
- #
839
- # @!attribute [rw] message
840
- # The error message.
841
- # @return [String]
842
- class UnprocessedTraceSegment < Struct.new(
843
- :id,
844
- :error_code,
845
- :message)
846
- include Aws::Structure
847
- end
848
-
849
- # Information about a segment annotation.
850
- # @!attribute [rw] annotation_value
851
- # Values of the annotation.
852
- # @return [Types::AnnotationValue]
853
- #
854
- # @!attribute [rw] service_ids
855
- # Services to which the annotation applies.
856
- # @return [Array<Types::ServiceId>]
857
- class ValueWithServiceIds < Struct.new(
858
- :annotation_value,
859
- :service_ids)
860
- include Aws::Structure
861
- end
8
+ module Aws::XRay
9
+ module Types
10
+
11
+ # An alias for an edge.
12
+ #
13
+ # @!attribute [rw] name
14
+ # The canonical name of the alias.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] names
18
+ # A list of names for the alias, including the canonical name.
19
+ # @return [Array<String>]
20
+ #
21
+ # @!attribute [rw] type
22
+ # The type of the alias.
23
+ # @return [String]
24
+ #
25
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Alias AWS API Documentation
26
+ #
27
+ class Alias < Struct.new(
28
+ :name,
29
+ :names,
30
+ :type)
31
+ include Aws::Structure
32
+ end
33
+
34
+ # Value of a segment annotation. Has one of three value types: Number,
35
+ # Boolean or String.
36
+ #
37
+ # @!attribute [rw] number_value
38
+ # Value for a Number annotation.
39
+ # @return [Float]
40
+ #
41
+ # @!attribute [rw] boolean_value
42
+ # Value for a Boolean annotation.
43
+ # @return [Boolean]
44
+ #
45
+ # @!attribute [rw] string_value
46
+ # Value for a String annotation.
47
+ # @return [String]
48
+ #
49
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/AnnotationValue AWS API Documentation
50
+ #
51
+ class AnnotationValue < Struct.new(
52
+ :number_value,
53
+ :boolean_value,
54
+ :string_value)
55
+ include Aws::Structure
56
+ end
57
+
58
+ # @note When making an API call, you may pass BackendConnectionErrors
59
+ # data as a hash:
60
+ #
61
+ # {
62
+ # timeout_count: 1,
63
+ # connection_refused_count: 1,
64
+ # http_code_4_xx_count: 1,
65
+ # http_code_5_xx_count: 1,
66
+ # unknown_host_count: 1,
67
+ # other_count: 1,
68
+ # }
69
+ #
70
+ # @!attribute [rw] timeout_count
71
+ # @return [Integer]
72
+ #
73
+ # @!attribute [rw] connection_refused_count
74
+ # @return [Integer]
75
+ #
76
+ # @!attribute [rw] http_code_4_xx_count
77
+ # @return [Integer]
78
+ #
79
+ # @!attribute [rw] http_code_5_xx_count
80
+ # @return [Integer]
81
+ #
82
+ # @!attribute [rw] unknown_host_count
83
+ # @return [Integer]
84
+ #
85
+ # @!attribute [rw] other_count
86
+ # @return [Integer]
87
+ #
88
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BackendConnectionErrors AWS API Documentation
89
+ #
90
+ class BackendConnectionErrors < Struct.new(
91
+ :timeout_count,
92
+ :connection_refused_count,
93
+ :http_code_4_xx_count,
94
+ :http_code_5_xx_count,
95
+ :unknown_host_count,
96
+ :other_count)
97
+ include Aws::Structure
98
+ end
99
+
100
+ # @note When making an API call, you may pass BatchGetTracesRequest
101
+ # data as a hash:
102
+ #
103
+ # {
104
+ # trace_ids: ["TraceId"], # required
105
+ # next_token: "String",
106
+ # }
107
+ #
108
+ # @!attribute [rw] trace_ids
109
+ # Specify the trace IDs of requests for which to retrieve segments.
110
+ # @return [Array<String>]
111
+ #
112
+ # @!attribute [rw] next_token
113
+ # Pagination token. Not used.
114
+ # @return [String]
115
+ #
116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTracesRequest AWS API Documentation
117
+ #
118
+ class BatchGetTracesRequest < Struct.new(
119
+ :trace_ids,
120
+ :next_token)
121
+ include Aws::Structure
122
+ end
123
+
124
+ # @!attribute [rw] traces
125
+ # Full traces for the specified requests.
126
+ # @return [Array<Types::Trace>]
127
+ #
128
+ # @!attribute [rw] unprocessed_trace_ids
129
+ # Trace IDs of requests that haven't been processed.
130
+ # @return [Array<String>]
131
+ #
132
+ # @!attribute [rw] next_token
133
+ # Pagination token. Not used.
134
+ # @return [String]
135
+ #
136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTracesResult AWS API Documentation
137
+ #
138
+ class BatchGetTracesResult < Struct.new(
139
+ :traces,
140
+ :unprocessed_trace_ids,
141
+ :next_token)
142
+ include Aws::Structure
143
+ end
144
+
145
+ # Information about a connection between two services.
146
+ #
147
+ # @!attribute [rw] reference_id
148
+ # Identifier of the edge. Unique within a service map.
149
+ # @return [Integer]
150
+ #
151
+ # @!attribute [rw] start_time
152
+ # The start time of the first segment on the edge.
153
+ # @return [Time]
154
+ #
155
+ # @!attribute [rw] end_time
156
+ # The end time of the last segment on the edge.
157
+ # @return [Time]
158
+ #
159
+ # @!attribute [rw] summary_statistics
160
+ # Response statistics for segments on the edge.
161
+ # @return [Types::EdgeStatistics]
162
+ #
163
+ # @!attribute [rw] response_time_histogram
164
+ # Histogram describing the prominence of response times on the edge.
165
+ # @return [Array<Types::HistogramEntry>]
166
+ #
167
+ # @!attribute [rw] aliases
168
+ # Aliases for the edge.
169
+ # @return [Array<Types::Alias>]
170
+ #
171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Edge AWS API Documentation
172
+ #
173
+ class Edge < Struct.new(
174
+ :reference_id,
175
+ :start_time,
176
+ :end_time,
177
+ :summary_statistics,
178
+ :response_time_histogram,
179
+ :aliases)
180
+ include Aws::Structure
181
+ end
182
+
183
+ # Response statistics for an edge.
184
+ #
185
+ # @!attribute [rw] ok_count
186
+ # The number of requests that completed with a 2xx Success status
187
+ # code.
188
+ # @return [Integer]
189
+ #
190
+ # @!attribute [rw] error_statistics
191
+ # Information about requests that failed with a 4xx Client Error
192
+ # status code.
193
+ # @return [Types::ErrorStatistics]
194
+ #
195
+ # @!attribute [rw] fault_statistics
196
+ # Information about requests that failed with a 5xx Server Error
197
+ # status code.
198
+ # @return [Types::FaultStatistics]
199
+ #
200
+ # @!attribute [rw] total_count
201
+ # The total number of completed requests.
202
+ # @return [Integer]
203
+ #
204
+ # @!attribute [rw] total_response_time
205
+ # The aggregate response time of completed requests.
206
+ # @return [Float]
207
+ #
208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/EdgeStatistics AWS API Documentation
209
+ #
210
+ class EdgeStatistics < Struct.new(
211
+ :ok_count,
212
+ :error_statistics,
213
+ :fault_statistics,
214
+ :total_count,
215
+ :total_response_time)
216
+ include Aws::Structure
217
+ end
218
+
219
+ # Information about requests that failed with a 4xx Client Error status
220
+ # code.
221
+ #
222
+ # @!attribute [rw] throttle_count
223
+ # The number of requests that failed with a 419 throttling status
224
+ # code.
225
+ # @return [Integer]
226
+ #
227
+ # @!attribute [rw] other_count
228
+ # The number of requests that failed with untracked 4xx Client Error
229
+ # status codes.
230
+ # @return [Integer]
231
+ #
232
+ # @!attribute [rw] total_count
233
+ # The total number of requests that failed with a 4xx Client Error
234
+ # status code.
235
+ # @return [Integer]
236
+ #
237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ErrorStatistics AWS API Documentation
238
+ #
239
+ class ErrorStatistics < Struct.new(
240
+ :throttle_count,
241
+ :other_count,
242
+ :total_count)
243
+ include Aws::Structure
244
+ end
245
+
246
+ # Information about requests that failed with a 5xx Server Error status
247
+ # code.
248
+ #
249
+ # @!attribute [rw] other_count
250
+ # The number of requests that failed with untracked 5xx Server Error
251
+ # status codes.
252
+ # @return [Integer]
253
+ #
254
+ # @!attribute [rw] total_count
255
+ # The total number of requests that failed with a 5xx Server Error
256
+ # status code.
257
+ # @return [Integer]
258
+ #
259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/FaultStatistics AWS API Documentation
260
+ #
261
+ class FaultStatistics < Struct.new(
262
+ :other_count,
263
+ :total_count)
264
+ include Aws::Structure
265
+ end
266
+
267
+ # @note When making an API call, you may pass GetServiceGraphRequest
268
+ # data as a hash:
269
+ #
270
+ # {
271
+ # start_time: Time.now, # required
272
+ # end_time: Time.now, # required
273
+ # next_token: "String",
274
+ # }
275
+ #
276
+ # @!attribute [rw] start_time
277
+ # The start of the time frame for which to generate a graph.
278
+ # @return [Time]
279
+ #
280
+ # @!attribute [rw] end_time
281
+ # The end of the time frame for which to generate a graph.
282
+ # @return [Time]
283
+ #
284
+ # @!attribute [rw] next_token
285
+ # Pagination token. Not used.
286
+ # @return [String]
287
+ #
288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraphRequest AWS API Documentation
289
+ #
290
+ class GetServiceGraphRequest < Struct.new(
291
+ :start_time,
292
+ :end_time,
293
+ :next_token)
294
+ include Aws::Structure
295
+ end
296
+
297
+ # @!attribute [rw] start_time
298
+ # The start of the time frame for which the graph was generated.
299
+ # @return [Time]
300
+ #
301
+ # @!attribute [rw] end_time
302
+ # The end of the time frame for which the graph was generated.
303
+ # @return [Time]
304
+ #
305
+ # @!attribute [rw] services
306
+ # The services that have processed a traced request during the
307
+ # specified time frame.
308
+ # @return [Array<Types::Service>]
309
+ #
310
+ # @!attribute [rw] next_token
311
+ # Pagination token. Not used.
312
+ # @return [String]
313
+ #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraphResult AWS API Documentation
315
+ #
316
+ class GetServiceGraphResult < Struct.new(
317
+ :start_time,
318
+ :end_time,
319
+ :services,
320
+ :next_token)
321
+ include Aws::Structure
322
+ end
323
+
324
+ # @note When making an API call, you may pass GetTraceGraphRequest
325
+ # data as a hash:
326
+ #
327
+ # {
328
+ # trace_ids: ["TraceId"], # required
329
+ # next_token: "String",
330
+ # }
331
+ #
332
+ # @!attribute [rw] trace_ids
333
+ # Trace IDs of requests for which to generate a service graph.
334
+ # @return [Array<String>]
335
+ #
336
+ # @!attribute [rw] next_token
337
+ # Pagination token. Not used.
338
+ # @return [String]
339
+ #
340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraphRequest AWS API Documentation
341
+ #
342
+ class GetTraceGraphRequest < Struct.new(
343
+ :trace_ids,
344
+ :next_token)
345
+ include Aws::Structure
346
+ end
347
+
348
+ # @!attribute [rw] services
349
+ # The services that have processed one of the specified requests.
350
+ # @return [Array<Types::Service>]
351
+ #
352
+ # @!attribute [rw] next_token
353
+ # Pagination token. Not used.
354
+ # @return [String]
355
+ #
356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraphResult AWS API Documentation
357
+ #
358
+ class GetTraceGraphResult < Struct.new(
359
+ :services,
360
+ :next_token)
361
+ include Aws::Structure
362
+ end
363
+
364
+ # @note When making an API call, you may pass GetTraceSummariesRequest
365
+ # data as a hash:
366
+ #
367
+ # {
368
+ # start_time: Time.now, # required
369
+ # end_time: Time.now, # required
370
+ # sampling: false,
371
+ # filter_expression: "FilterExpression",
372
+ # next_token: "String",
373
+ # }
374
+ #
375
+ # @!attribute [rw] start_time
376
+ # The start of the time frame for which to retrieve traces.
377
+ # @return [Time]
378
+ #
379
+ # @!attribute [rw] end_time
380
+ # The end of the time frame for which to retrieve traces.
381
+ # @return [Time]
382
+ #
383
+ # @!attribute [rw] sampling
384
+ # Set to `true` to get summaries for only a subset of available
385
+ # traces.
386
+ # @return [Boolean]
387
+ #
388
+ # @!attribute [rw] filter_expression
389
+ # Specify a filter expression to retrieve trace summaries for services
390
+ # or requests that meet certain requirements.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] next_token
394
+ # Specify the pagination token returned by a previous request to
395
+ # retrieve the next page of results.
396
+ # @return [String]
397
+ #
398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummariesRequest AWS API Documentation
399
+ #
400
+ class GetTraceSummariesRequest < Struct.new(
401
+ :start_time,
402
+ :end_time,
403
+ :sampling,
404
+ :filter_expression,
405
+ :next_token)
406
+ include Aws::Structure
407
+ end
408
+
409
+ # @!attribute [rw] trace_summaries
410
+ # Trace IDs and metadata for traces that were found in the specified
411
+ # time frame.
412
+ # @return [Array<Types::TraceSummary>]
413
+ #
414
+ # @!attribute [rw] approximate_time
415
+ # The start time of this page of results.
416
+ # @return [Time]
417
+ #
418
+ # @!attribute [rw] traces_processed_count
419
+ # The number of traces that were processed to get this set of
420
+ # summaries.
421
+ # @return [Integer]
422
+ #
423
+ # @!attribute [rw] next_token
424
+ # If the requested time frame contained more than one page of results,
425
+ # you can use this token to retrieve the next page. The first page
426
+ # contains the most most recent results, closest to the end of the
427
+ # time frame.
428
+ # @return [String]
429
+ #
430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummariesResult AWS API Documentation
431
+ #
432
+ class GetTraceSummariesResult < Struct.new(
433
+ :trace_summaries,
434
+ :approximate_time,
435
+ :traces_processed_count,
436
+ :next_token)
437
+ include Aws::Structure
438
+ end
862
439
 
440
+ # An entry in a histogram for a statistic. A histogram maps the range of
441
+ # observed values on the X axis, and the prevalence of each value on the
442
+ # Y axis.
443
+ #
444
+ # @!attribute [rw] value
445
+ # The value of the entry.
446
+ # @return [Float]
447
+ #
448
+ # @!attribute [rw] count
449
+ # The prevalence of the entry.
450
+ # @return [Integer]
451
+ #
452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/HistogramEntry AWS API Documentation
453
+ #
454
+ class HistogramEntry < Struct.new(
455
+ :value,
456
+ :count)
457
+ include Aws::Structure
863
458
  end
459
+
460
+ # Information about an HTTP request.
461
+ #
462
+ # @!attribute [rw] http_url
463
+ # The request URL.
464
+ # @return [String]
465
+ #
466
+ # @!attribute [rw] http_status
467
+ # The response status.
468
+ # @return [Integer]
469
+ #
470
+ # @!attribute [rw] http_method
471
+ # The request method.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] user_agent
475
+ # The request's user agent string.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] client_ip
479
+ # The IP address of the requestor.
480
+ # @return [String]
481
+ #
482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Http AWS API Documentation
483
+ #
484
+ class Http < Struct.new(
485
+ :http_url,
486
+ :http_status,
487
+ :http_method,
488
+ :user_agent,
489
+ :client_ip)
490
+ include Aws::Structure
491
+ end
492
+
493
+ # @note When making an API call, you may pass PutTelemetryRecordsRequest
494
+ # data as a hash:
495
+ #
496
+ # {
497
+ # telemetry_records: [ # required
498
+ # {
499
+ # timestamp: Time.now,
500
+ # segments_received_count: 1,
501
+ # segments_sent_count: 1,
502
+ # segments_spillover_count: 1,
503
+ # segments_rejected_count: 1,
504
+ # backend_connection_errors: {
505
+ # timeout_count: 1,
506
+ # connection_refused_count: 1,
507
+ # http_code_4_xx_count: 1,
508
+ # http_code_5_xx_count: 1,
509
+ # unknown_host_count: 1,
510
+ # other_count: 1,
511
+ # },
512
+ # },
513
+ # ],
514
+ # ec2_instance_id: "String",
515
+ # hostname: "String",
516
+ # resource_arn: "String",
517
+ # }
518
+ #
519
+ # @!attribute [rw] telemetry_records
520
+ # @return [Array<Types::TelemetryRecord>]
521
+ #
522
+ # @!attribute [rw] ec2_instance_id
523
+ # @return [String]
524
+ #
525
+ # @!attribute [rw] hostname
526
+ # @return [String]
527
+ #
528
+ # @!attribute [rw] resource_arn
529
+ # @return [String]
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTelemetryRecordsRequest AWS API Documentation
532
+ #
533
+ class PutTelemetryRecordsRequest < Struct.new(
534
+ :telemetry_records,
535
+ :ec2_instance_id,
536
+ :hostname,
537
+ :resource_arn)
538
+ include Aws::Structure
539
+ end
540
+
541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTelemetryRecordsResult AWS API Documentation
542
+ #
543
+ class PutTelemetryRecordsResult < Aws::EmptyStructure; end
544
+
545
+ # @note When making an API call, you may pass PutTraceSegmentsRequest
546
+ # data as a hash:
547
+ #
548
+ # {
549
+ # trace_segment_documents: ["TraceSegmentDocument"], # required
550
+ # }
551
+ #
552
+ # @!attribute [rw] trace_segment_documents
553
+ # A JSON document defining one or more segments or subsegments.
554
+ # Segments must include the following fields.
555
+ #
556
+ # **Required Segment Document Fields**
557
+ #
558
+ # * `name` - The name of the service that handled the request.
559
+ #
560
+ # * `id` - A 64-bit identifier for the segment, unique among segments
561
+ # in the same trace, in 16 hexadecimal digits.
562
+ #
563
+ # * `trace_id` - A unique identifier that connects all segments and
564
+ # subsegments originating from a single client request.
565
+ #
566
+ # * `start_time` - Time the segment or subsegment was created, in
567
+ # floating point seconds in epoch time, accurate to milliseconds.
568
+ # For example, `1480615200.010` or `1.480615200010E9`.
569
+ #
570
+ # * `end_time` - Time the segment or subsegment was closed. For
571
+ # example, `1480615200.090` or `1.480615200090E9`. Specify either an
572
+ # `end_time` or `in_progress`.
573
+ #
574
+ # * `in_progress` - Set to `true` instead of specifying an `end_time`
575
+ # to record that a segment has been started, but is not complete.
576
+ # Send an in progress segment when your application receives a
577
+ # request that will take a long time to serve, to trace the fact
578
+ # that the request was received. When the response is sent, send the
579
+ # complete segment to overwrite the in-progress segment.
580
+ #
581
+ # A `trace_id` consists of three numbers separated by hyphens. For
582
+ # example, 1-58406520-a006649127e371903a2de979. This includes:
583
+ #
584
+ # **Trace ID Format**
585
+ #
586
+ # * The version number, i.e. `1`.
587
+ #
588
+ # * The time of the original request, in Unix epoch time, in 8
589
+ # hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in
590
+ # epoch time is `1480615200` seconds, or `58406520` in hexadecimal.
591
+ #
592
+ # * A 96-bit identifier for the trace, globally unique, in 24
593
+ # hexadecimal digits.
594
+ # @return [Array<String>]
595
+ #
596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTraceSegmentsRequest AWS API Documentation
597
+ #
598
+ class PutTraceSegmentsRequest < Struct.new(
599
+ :trace_segment_documents)
600
+ include Aws::Structure
601
+ end
602
+
603
+ # @!attribute [rw] unprocessed_trace_segments
604
+ # Segments that failed processing.
605
+ # @return [Array<Types::UnprocessedTraceSegment>]
606
+ #
607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTraceSegmentsResult AWS API Documentation
608
+ #
609
+ class PutTraceSegmentsResult < Struct.new(
610
+ :unprocessed_trace_segments)
611
+ include Aws::Structure
612
+ end
613
+
614
+ # Information about a segment
615
+ #
616
+ # @!attribute [rw] id
617
+ # The segment's ID.
618
+ # @return [String]
619
+ #
620
+ # @!attribute [rw] document
621
+ # The segment document.
622
+ # @return [String]
623
+ #
624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Segment AWS API Documentation
625
+ #
626
+ class Segment < Struct.new(
627
+ :id,
628
+ :document)
629
+ include Aws::Structure
630
+ end
631
+
632
+ # Information about an application that processed requests, users that
633
+ # made requests, or downstream services, resources and applications that
634
+ # an application used.
635
+ #
636
+ # @!attribute [rw] reference_id
637
+ # Identifier for the service. Unique within the service map.
638
+ # @return [Integer]
639
+ #
640
+ # @!attribute [rw] name
641
+ # The canonical name of the service.
642
+ # @return [String]
643
+ #
644
+ # @!attribute [rw] names
645
+ # A list of names for the service, including the canonical name.
646
+ # @return [Array<String>]
647
+ #
648
+ # @!attribute [rw] root
649
+ # Indicates that the service was the first service to process a
650
+ # request.
651
+ # @return [Boolean]
652
+ #
653
+ # @!attribute [rw] account_id
654
+ # Identifier of the AWS account in which the service runs.
655
+ # @return [String]
656
+ #
657
+ # @!attribute [rw] type
658
+ # The type of service.
659
+ #
660
+ # * AWS Resource - The type of an AWS resource. For example,
661
+ # `AWS::EC2::Instance` for a application running on Amazon EC2 or
662
+ # `AWS::DynamoDB::Table` for an Amazon DynamoDB table that the
663
+ # application used.
664
+ #
665
+ # * AWS Service - The type of an AWS service. For example,
666
+ # `AWS::DynamoDB` for downstream calls to Amazon DynamoDB that
667
+ # didn't target a specific table.
668
+ #
669
+ # * `client` - Represents the clients that sent requests to a root
670
+ # service.
671
+ #
672
+ # * `remote` - A downstream service of indeterminate type.
673
+ # @return [String]
674
+ #
675
+ # @!attribute [rw] state
676
+ # The service's state.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] start_time
680
+ # The start time of the first segment that the service generated.
681
+ # @return [Time]
682
+ #
683
+ # @!attribute [rw] end_time
684
+ # The end time of the last segment that the service generated.
685
+ # @return [Time]
686
+ #
687
+ # @!attribute [rw] edges
688
+ # Connections to downstream services.
689
+ # @return [Array<Types::Edge>]
690
+ #
691
+ # @!attribute [rw] summary_statistics
692
+ # Aggregated statistics for the service.
693
+ # @return [Types::ServiceStatistics]
694
+ #
695
+ # @!attribute [rw] duration_histogram
696
+ # Histogram mapping the spread of trace durations
697
+ # @return [Array<Types::HistogramEntry>]
698
+ #
699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Service AWS API Documentation
700
+ #
701
+ class Service < Struct.new(
702
+ :reference_id,
703
+ :name,
704
+ :names,
705
+ :root,
706
+ :account_id,
707
+ :type,
708
+ :state,
709
+ :start_time,
710
+ :end_time,
711
+ :edges,
712
+ :summary_statistics,
713
+ :duration_histogram)
714
+ include Aws::Structure
715
+ end
716
+
717
+ # @!attribute [rw] name
718
+ # @return [String]
719
+ #
720
+ # @!attribute [rw] names
721
+ # @return [Array<String>]
722
+ #
723
+ # @!attribute [rw] account_id
724
+ # @return [String]
725
+ #
726
+ # @!attribute [rw] type
727
+ # @return [String]
728
+ #
729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ServiceId AWS API Documentation
730
+ #
731
+ class ServiceId < Struct.new(
732
+ :name,
733
+ :names,
734
+ :account_id,
735
+ :type)
736
+ include Aws::Structure
737
+ end
738
+
739
+ # Response statistics for a service.
740
+ #
741
+ # @!attribute [rw] ok_count
742
+ # The number of requests that completed with a 2xx Success status
743
+ # code.
744
+ # @return [Integer]
745
+ #
746
+ # @!attribute [rw] error_statistics
747
+ # Information about requests that failed with a 4xx Client Error
748
+ # status code.
749
+ # @return [Types::ErrorStatistics]
750
+ #
751
+ # @!attribute [rw] fault_statistics
752
+ # Information about requests that failed with a 5xx Server Error
753
+ # status code.
754
+ # @return [Types::FaultStatistics]
755
+ #
756
+ # @!attribute [rw] total_count
757
+ # The total number of completed requests.
758
+ # @return [Integer]
759
+ #
760
+ # @!attribute [rw] total_response_time
761
+ # The aggregate response time of completed requests.
762
+ # @return [Float]
763
+ #
764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ServiceStatistics AWS API Documentation
765
+ #
766
+ class ServiceStatistics < Struct.new(
767
+ :ok_count,
768
+ :error_statistics,
769
+ :fault_statistics,
770
+ :total_count,
771
+ :total_response_time)
772
+ include Aws::Structure
773
+ end
774
+
775
+ # @note When making an API call, you may pass TelemetryRecord
776
+ # data as a hash:
777
+ #
778
+ # {
779
+ # timestamp: Time.now,
780
+ # segments_received_count: 1,
781
+ # segments_sent_count: 1,
782
+ # segments_spillover_count: 1,
783
+ # segments_rejected_count: 1,
784
+ # backend_connection_errors: {
785
+ # timeout_count: 1,
786
+ # connection_refused_count: 1,
787
+ # http_code_4_xx_count: 1,
788
+ # http_code_5_xx_count: 1,
789
+ # unknown_host_count: 1,
790
+ # other_count: 1,
791
+ # },
792
+ # }
793
+ #
794
+ # @!attribute [rw] timestamp
795
+ # @return [Time]
796
+ #
797
+ # @!attribute [rw] segments_received_count
798
+ # @return [Integer]
799
+ #
800
+ # @!attribute [rw] segments_sent_count
801
+ # @return [Integer]
802
+ #
803
+ # @!attribute [rw] segments_spillover_count
804
+ # @return [Integer]
805
+ #
806
+ # @!attribute [rw] segments_rejected_count
807
+ # @return [Integer]
808
+ #
809
+ # @!attribute [rw] backend_connection_errors
810
+ # @return [Types::BackendConnectionErrors]
811
+ #
812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TelemetryRecord AWS API Documentation
813
+ #
814
+ class TelemetryRecord < Struct.new(
815
+ :timestamp,
816
+ :segments_received_count,
817
+ :segments_sent_count,
818
+ :segments_spillover_count,
819
+ :segments_rejected_count,
820
+ :backend_connection_errors)
821
+ include Aws::Structure
822
+ end
823
+
824
+ # A collection of segment documents with matching trace IDs.
825
+ #
826
+ # @!attribute [rw] id
827
+ # The unique identifier for the request that generated the trace's
828
+ # segments and subsegments.
829
+ # @return [String]
830
+ #
831
+ # @!attribute [rw] duration
832
+ # The length of time in seconds between the start time of the root
833
+ # segment and the end time of the last segment that completed.
834
+ # @return [Float]
835
+ #
836
+ # @!attribute [rw] segments
837
+ # Segment documents for the segments and subsegments that comprise the
838
+ # trace.
839
+ # @return [Array<Types::Segment>]
840
+ #
841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Trace AWS API Documentation
842
+ #
843
+ class Trace < Struct.new(
844
+ :id,
845
+ :duration,
846
+ :segments)
847
+ include Aws::Structure
848
+ end
849
+
850
+ # Metadata generated from the segment documents in a trace.
851
+ #
852
+ # @!attribute [rw] id
853
+ # The unique identifier for the request that generated the trace's
854
+ # segments and subsegments.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] duration
858
+ # The length of time in seconds between the start time of the root
859
+ # segment and the end time of the last segment that completed.
860
+ # @return [Float]
861
+ #
862
+ # @!attribute [rw] response_time
863
+ # The length of time in seconds between the start and end times of the
864
+ # root segment. If the service performs work asynchronously, the
865
+ # response time measures the time before the response is sent to the
866
+ # user, while the duration measures the amount of time before the last
867
+ # traced activity completes.
868
+ # @return [Float]
869
+ #
870
+ # @!attribute [rw] has_fault
871
+ # One or more of the segment documents has a 500 series error.
872
+ # @return [Boolean]
873
+ #
874
+ # @!attribute [rw] has_error
875
+ # One or more of the segment documents has a 400 series error.
876
+ # @return [Boolean]
877
+ #
878
+ # @!attribute [rw] has_throttle
879
+ # One or more of the segment documents has a 429 throttling error.
880
+ # @return [Boolean]
881
+ #
882
+ # @!attribute [rw] is_partial
883
+ # One or more of the segment documents is in progress.
884
+ # @return [Boolean]
885
+ #
886
+ # @!attribute [rw] http
887
+ # Information about the HTTP request served by the trace.
888
+ # @return [Types::Http]
889
+ #
890
+ # @!attribute [rw] annotations
891
+ # Annotations from the trace's segment documents.
892
+ # @return [Hash<String,Array<Types::ValueWithServiceIds>>]
893
+ #
894
+ # @!attribute [rw] users
895
+ # Users from the trace's segment documents.
896
+ # @return [Array<Types::TraceUser>]
897
+ #
898
+ # @!attribute [rw] service_ids
899
+ # Service IDs from the trace's segment documents.
900
+ # @return [Array<Types::ServiceId>]
901
+ #
902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TraceSummary AWS API Documentation
903
+ #
904
+ class TraceSummary < Struct.new(
905
+ :id,
906
+ :duration,
907
+ :response_time,
908
+ :has_fault,
909
+ :has_error,
910
+ :has_throttle,
911
+ :is_partial,
912
+ :http,
913
+ :annotations,
914
+ :users,
915
+ :service_ids)
916
+ include Aws::Structure
917
+ end
918
+
919
+ # Information about a user recorded in segment documents.
920
+ #
921
+ # @!attribute [rw] user_name
922
+ # The user's name.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] service_ids
926
+ # Services that the user's request hit.
927
+ # @return [Array<Types::ServiceId>]
928
+ #
929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TraceUser AWS API Documentation
930
+ #
931
+ class TraceUser < Struct.new(
932
+ :user_name,
933
+ :service_ids)
934
+ include Aws::Structure
935
+ end
936
+
937
+ # Information about a segment that failed processing.
938
+ #
939
+ # @!attribute [rw] id
940
+ # The segment's ID.
941
+ # @return [String]
942
+ #
943
+ # @!attribute [rw] error_code
944
+ # The error that caused processing to fail.
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] message
948
+ # The error message.
949
+ # @return [String]
950
+ #
951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UnprocessedTraceSegment AWS API Documentation
952
+ #
953
+ class UnprocessedTraceSegment < Struct.new(
954
+ :id,
955
+ :error_code,
956
+ :message)
957
+ include Aws::Structure
958
+ end
959
+
960
+ # Information about a segment annotation.
961
+ #
962
+ # @!attribute [rw] annotation_value
963
+ # Values of the annotation.
964
+ # @return [Types::AnnotationValue]
965
+ #
966
+ # @!attribute [rw] service_ids
967
+ # Services to which the annotation applies.
968
+ # @return [Array<Types::ServiceId>]
969
+ #
970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ValueWithServiceIds AWS API Documentation
971
+ #
972
+ class ValueWithServiceIds < Struct.new(
973
+ :annotation_value,
974
+ :service_ids)
975
+ include Aws::Structure
976
+ end
977
+
864
978
  end
865
979
  end