/
types.go
1279 lines (905 loc) · 33.6 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// An alias for an edge.
type Alias struct {
// The canonical name of the alias.
Name *string
// A list of names for the alias, including the canonical name.
Names []string
// The type of the alias.
Type *string
noSmithyDocumentSerde
}
// Value of a segment annotation. Has one of three value types: Number, Boolean,
// or String.
//
// The following types satisfy this interface:
//
// AnnotationValueMemberBooleanValue
// AnnotationValueMemberNumberValue
// AnnotationValueMemberStringValue
type AnnotationValue interface {
isAnnotationValue()
}
// Value for a Boolean annotation.
type AnnotationValueMemberBooleanValue struct {
Value bool
noSmithyDocumentSerde
}
func (*AnnotationValueMemberBooleanValue) isAnnotationValue() {}
// Value for a Number annotation.
type AnnotationValueMemberNumberValue struct {
Value float64
noSmithyDocumentSerde
}
func (*AnnotationValueMemberNumberValue) isAnnotationValue() {}
// Value for a String annotation.
type AnnotationValueMemberStringValue struct {
Value string
noSmithyDocumentSerde
}
func (*AnnotationValueMemberStringValue) isAnnotationValue() {}
// The service within the service graph that has anomalously high fault rates.
type AnomalousService struct {
//
ServiceId *ServiceId
noSmithyDocumentSerde
}
// A list of Availability Zones corresponding to the segments in a trace.
type AvailabilityZoneDetail struct {
// The name of a corresponding Availability Zone.
Name *string
noSmithyDocumentSerde
}
type BackendConnectionErrors struct {
//
ConnectionRefusedCount *int32
//
HTTPCode4XXCount *int32
//
HTTPCode5XXCount *int32
//
OtherCount *int32
//
TimeoutCount *int32
//
UnknownHostCount *int32
noSmithyDocumentSerde
}
// Information about a connection between two services. An edge can be a
// synchronous connection, such as typical call between client and service, or an
// asynchronous link, such as a Lambda function which retrieves an event from an
// SNS queue.
type Edge struct {
// Aliases for the edge.
Aliases []Alias
// Describes an asynchronous connection, with a value of link .
EdgeType *string
// The end time of the last segment on the edge.
EndTime *time.Time
// A histogram that maps the spread of event age when received by consumers. Age
// is calculated each time an event is received. Only populated when EdgeType is
// link .
ReceivedEventAgeHistogram []HistogramEntry
// Identifier of the edge. Unique within a service map.
ReferenceId *int32
// A histogram that maps the spread of client response times on an edge. Only
// populated for synchronous edges.
ResponseTimeHistogram []HistogramEntry
// The start time of the first segment on the edge.
StartTime *time.Time
// Response statistics for segments on the edge.
SummaryStatistics *EdgeStatistics
noSmithyDocumentSerde
}
// Response statistics for an edge.
type EdgeStatistics struct {
// Information about requests that failed with a 4xx Client Error status code.
ErrorStatistics *ErrorStatistics
// Information about requests that failed with a 5xx Server Error status code.
FaultStatistics *FaultStatistics
// The number of requests that completed with a 2xx Success status code.
OkCount *int64
// The total number of completed requests.
TotalCount *int64
// The aggregate response time of completed requests.
TotalResponseTime *float64
noSmithyDocumentSerde
}
// A configuration document that specifies encryption configuration settings.
type EncryptionConfig struct {
// The ID of the KMS key used for encryption, if applicable.
KeyId *string
// The encryption status. While the status is UPDATING , X-Ray may encrypt data
// with a combination of the new and old settings.
Status EncryptionStatus
// The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE
// for default encryption.
Type EncryptionType
noSmithyDocumentSerde
}
// The root cause of a trace summary error.
type ErrorRootCause struct {
// A flag that denotes that the root cause impacts the trace client.
ClientImpacting *bool
// A list of services corresponding to an error. A service identifies a segment
// and it contains a name, account ID, type, and inferred flag.
Services []ErrorRootCauseService
noSmithyDocumentSerde
}
// A collection of segments and corresponding subsegments associated to a trace
// summary error.
type ErrorRootCauseEntity struct {
// The types and messages of the exceptions.
Exceptions []RootCauseException
// The name of the entity.
Name *string
// A flag that denotes a remote subsegment.
Remote *bool
noSmithyDocumentSerde
}
// A collection of fields identifying the services in a trace summary error.
type ErrorRootCauseService struct {
// The account ID associated to the service.
AccountId *string
// The path of root cause entities found on the service.
EntityPath []ErrorRootCauseEntity
// A Boolean value indicating if the service is inferred from the trace.
Inferred *bool
// The service name.
Name *string
// A collection of associated service names.
Names []string
// The type associated to the service.
Type *string
noSmithyDocumentSerde
}
// Information about requests that failed with a 4xx Client Error status code.
type ErrorStatistics struct {
// The number of requests that failed with untracked 4xx Client Error status codes.
OtherCount *int64
// The number of requests that failed with a 419 throttling status code.
ThrottleCount *int64
// The total number of requests that failed with a 4xx Client Error status code.
TotalCount *int64
noSmithyDocumentSerde
}
// The root cause information for a trace summary fault.
type FaultRootCause struct {
// A flag that denotes that the root cause impacts the trace client.
ClientImpacting *bool
// A list of corresponding services. A service identifies a segment and it
// contains a name, account ID, type, and inferred flag.
Services []FaultRootCauseService
noSmithyDocumentSerde
}
// A collection of segments and corresponding subsegments associated to a trace
// summary fault error.
type FaultRootCauseEntity struct {
// The types and messages of the exceptions.
Exceptions []RootCauseException
// The name of the entity.
Name *string
// A flag that denotes a remote subsegment.
Remote *bool
noSmithyDocumentSerde
}
// A collection of fields identifying the services in a trace summary fault.
type FaultRootCauseService struct {
// The account ID associated to the service.
AccountId *string
// The path of root cause entities found on the service.
EntityPath []FaultRootCauseEntity
// A Boolean value indicating if the service is inferred from the trace.
Inferred *bool
// The service name.
Name *string
// A collection of associated service names.
Names []string
// The type associated to the service.
Type *string
noSmithyDocumentSerde
}
// Information about requests that failed with a 5xx Server Error status code.
type FaultStatistics struct {
// The number of requests that failed with untracked 5xx Server Error status codes.
OtherCount *int64
// The total number of requests that failed with a 5xx Server Error status code.
TotalCount *int64
noSmithyDocumentSerde
}
// The predicted high and low fault count. This is used to determine if a service
// has become anomalous and if an insight should be created.
type ForecastStatistics struct {
// The upper limit of fault counts for a service.
FaultCountHigh *int64
// The lower limit of fault counts for a service.
FaultCountLow *int64
noSmithyDocumentSerde
}
// Details and metadata for a group.
type Group struct {
// The filter expression defining the parameters to include traces.
FilterExpression *string
// The Amazon Resource Name (ARN) of the group generated based on the GroupName.
GroupARN *string
// The unique case-sensitive name of the group.
GroupName *string
// The structure containing configurations related to insights.
// - The InsightsEnabled boolean can be set to true to enable insights for the
// group or false to disable insights for the group.
// - The NotificationsEnabled boolean can be set to true to enable insights
// notifications through Amazon EventBridge for the group.
InsightsConfiguration *InsightsConfiguration
noSmithyDocumentSerde
}
// Details for a group without metadata.
type GroupSummary struct {
// The filter expression defining the parameters to include traces.
FilterExpression *string
// The ARN of the group generated based on the GroupName.
GroupARN *string
// The unique case-sensitive name of the group.
GroupName *string
// The structure containing configurations related to insights.
// - The InsightsEnabled boolean can be set to true to enable insights for the
// group or false to disable insights for the group.
// - The NotificationsEnabled boolean can be set to true to enable insights
// notifications. Notifications can only be enabled on a group with InsightsEnabled
// set to true.
InsightsConfiguration *InsightsConfiguration
noSmithyDocumentSerde
}
// An entry in a histogram for a statistic. A histogram maps the range of observed
// values on the X axis, and the prevalence of each value on the Y axis.
type HistogramEntry struct {
// The prevalence of the entry.
Count int32
// The value of the entry.
Value float64
noSmithyDocumentSerde
}
// Information about an HTTP request.
type Http struct {
// The IP address of the requestor.
ClientIp *string
// The request method.
HttpMethod *string
// The response status.
HttpStatus *int32
// The request URL.
HttpURL *string
// The request's user agent string.
UserAgent *string
noSmithyDocumentSerde
}
// When fault rates go outside of the expected range, X-Ray creates an insight.
// Insights tracks emergent issues within your applications.
type Insight struct {
// The categories that label and describe the type of insight.
Categories []InsightCategory
// The impact statistics of the client side service. This includes the number of
// requests to the client service and whether the requests were faults or okay.
ClientRequestImpactStatistics *RequestImpactStatistics
// The time, in Unix seconds, at which the insight ended.
EndTime *time.Time
// The Amazon Resource Name (ARN) of the group that the insight belongs to.
GroupARN *string
// The name of the group that the insight belongs to.
GroupName *string
// The insights unique identifier.
InsightId *string
//
RootCauseServiceId *ServiceId
// The impact statistics of the root cause service. This includes the number of
// requests to the client service and whether the requests were faults or okay.
RootCauseServiceRequestImpactStatistics *RequestImpactStatistics
// The time, in Unix seconds, at which the insight began.
StartTime *time.Time
// The current state of the insight.
State InsightState
// A brief description of the insight.
Summary *string
// The service within the insight that is most impacted by the incident.
TopAnomalousServices []AnomalousService
noSmithyDocumentSerde
}
// X-Ray reevaluates insights periodically until they are resolved, and records
// each intermediate state in an event. You can review incident events in the
// Impact Timeline on the Inspect page in the X-Ray console.
type InsightEvent struct {
// The impact statistics of the client side service. This includes the number of
// requests to the client service and whether the requests were faults or okay.
ClientRequestImpactStatistics *RequestImpactStatistics
// The time, in Unix seconds, at which the event was recorded.
EventTime *time.Time
// The impact statistics of the root cause service. This includes the number of
// requests to the client service and whether the requests were faults or okay.
RootCauseServiceRequestImpactStatistics *RequestImpactStatistics
// A brief description of the event.
Summary *string
// The service during the event that is most impacted by the incident.
TopAnomalousServices []AnomalousService
noSmithyDocumentSerde
}
// The connection between two service in an insight impact graph.
type InsightImpactGraphEdge struct {
// Identifier of the edge. Unique within a service map.
ReferenceId *int32
noSmithyDocumentSerde
}
// Information about an application that processed requests, users that made
// requests, or downstream services, resources, and applications that an
// application used.
type InsightImpactGraphService struct {
// Identifier of the Amazon Web Services account in which the service runs.
AccountId *string
// Connections to downstream services.
Edges []InsightImpactGraphEdge
// The canonical name of the service.
Name *string
// A list of names for the service, including the canonical name.
Names []string
// Identifier for the service. Unique within the service map.
ReferenceId *int32
// Identifier for the service. Unique within the service map.
// - Amazon Web Services Resource - The type of an Amazon Web Services resource.
// For example, AWS::EC2::Instance for an application running on Amazon EC2 or
// AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
// - Amazon Web Services Service - The type of an Amazon Web Services service.
// For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't
// target a specific table.
// - Amazon Web Services Service - The type of an Amazon Web Services service.
// For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't
// target a specific table.
// - remote - A downstream service of indeterminate type.
Type *string
noSmithyDocumentSerde
}
// The structure containing configurations related to insights.
type InsightsConfiguration struct {
// Set the InsightsEnabled value to true to enable insights or false to disable
// insights.
InsightsEnabled *bool
// Set the NotificationsEnabled value to true to enable insights notifications.
// Notifications can only be enabled on a group with InsightsEnabled set to true.
NotificationsEnabled *bool
noSmithyDocumentSerde
}
// Information that describes an insight.
type InsightSummary struct {
// Categories The categories that label and describe the type of insight.
Categories []InsightCategory
// The impact statistics of the client side service. This includes the number of
// requests to the client service and whether the requests were faults or okay.
ClientRequestImpactStatistics *RequestImpactStatistics
// The time, in Unix seconds, at which the insight ended.
EndTime *time.Time
// The Amazon Resource Name (ARN) of the group that the insight belongs to.
GroupARN *string
// The name of the group that the insight belongs to.
GroupName *string
// The insights unique identifier.
InsightId *string
// The time, in Unix seconds, that the insight was last updated.
LastUpdateTime *time.Time
//
RootCauseServiceId *ServiceId
// The impact statistics of the root cause service. This includes the number of
// requests to the client service and whether the requests were faults or okay.
RootCauseServiceRequestImpactStatistics *RequestImpactStatistics
// The time, in Unix seconds, at which the insight began.
StartTime *time.Time
// The current state of the insight.
State InsightState
// A brief description of the insight.
Summary *string
// The service within the insight that is most impacted by the incident.
TopAnomalousServices []AnomalousService
noSmithyDocumentSerde
}
// A list of EC2 instance IDs corresponding to the segments in a trace.
type InstanceIdDetail struct {
// The ID of a corresponding EC2 instance.
Id *string
noSmithyDocumentSerde
}
// Statistics that describe how the incident has impacted a service.
type RequestImpactStatistics struct {
// The number of requests that have resulted in a fault,
FaultCount *int64
// The number of successful requests.
OkCount *int64
// The total number of requests to the service.
TotalCount *int64
noSmithyDocumentSerde
}
// A list of resources ARNs corresponding to the segments in a trace.
type ResourceARNDetail struct {
// The ARN of a corresponding resource.
ARN *string
noSmithyDocumentSerde
}
// A resource policy grants one or more Amazon Web Services services and accounts
// permissions to access X-Ray. Each resource policy is associated with a specific
// Amazon Web Services account.
type ResourcePolicy struct {
// When the policy was last updated, in Unix time seconds.
LastUpdatedTime *time.Time
// The resource policy document, which can be up to 5kb in size.
PolicyDocument *string
// The name of the resource policy. Must be unique within a specific Amazon Web
// Services account.
PolicyName *string
// Returns the current policy revision id for this policy name.
PolicyRevisionId *string
noSmithyDocumentSerde
}
// The root cause information for a response time warning.
type ResponseTimeRootCause struct {
// A flag that denotes that the root cause impacts the trace client.
ClientImpacting *bool
// A list of corresponding services. A service identifies a segment and contains a
// name, account ID, type, and inferred flag.
Services []ResponseTimeRootCauseService
noSmithyDocumentSerde
}
// A collection of segments and corresponding subsegments associated to a response
// time warning.
type ResponseTimeRootCauseEntity struct {
// The type and messages of the exceptions.
Coverage *float64
// The name of the entity.
Name *string
// A flag that denotes a remote subsegment.
Remote *bool
noSmithyDocumentSerde
}
// A collection of fields identifying the service in a response time warning.
type ResponseTimeRootCauseService struct {
// The account ID associated to the service.
AccountId *string
// The path of root cause entities found on the service.
EntityPath []ResponseTimeRootCauseEntity
// A Boolean value indicating if the service is inferred from the trace.
Inferred *bool
// The service name.
Name *string
// A collection of associated service names.
Names []string
// The type associated to the service.
Type *string
noSmithyDocumentSerde
}
// The exception associated with a root cause.
type RootCauseException struct {
// The message of the exception.
Message *string
// The name of the exception.
Name *string
noSmithyDocumentSerde
}
// A sampling rule that services use to decide whether to instrument a request.
// Rule fields can match properties of the service, or properties of a request. The
// service can ignore rules that don't match its properties.
type SamplingRule struct {
// The percentage of matching requests to instrument, after the reservoir is
// exhausted.
//
// This member is required.
FixedRate float64
// Matches the HTTP method of a request.
//
// This member is required.
HTTPMethod *string
// Matches the hostname from a request URL.
//
// This member is required.
Host *string
// The priority of the sampling rule.
//
// This member is required.
Priority *int32
// A fixed number of matching requests to instrument per second, prior to applying
// the fixed rate. The reservoir is not used directly by services, but applies to
// all services using the rule collectively.
//
// This member is required.
ReservoirSize int32
// Matches the ARN of the Amazon Web Services resource on which the service runs.
//
// This member is required.
ResourceARN *string
// Matches the name that the service uses to identify itself in segments.
//
// This member is required.
ServiceName *string
// Matches the origin that the service uses to identify its type in segments.
//
// This member is required.
ServiceType *string
// Matches the path from a request URL.
//
// This member is required.
URLPath *string
// The version of the sampling rule format ( 1 ).
//
// This member is required.
Version *int32
// Matches attributes derived from the request.
Attributes map[string]string
// The ARN of the sampling rule. Specify a rule by either name or ARN, but not
// both.
RuleARN *string
// The name of the sampling rule. Specify a rule by either name or ARN, but not
// both.
RuleName *string
noSmithyDocumentSerde
}
// A SamplingRule (https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html)
// and its metadata.
type SamplingRuleRecord struct {
// When the rule was created.
CreatedAt *time.Time
// When the rule was last modified.
ModifiedAt *time.Time
// The sampling rule.
SamplingRule *SamplingRule
noSmithyDocumentSerde
}
// A document specifying changes to a sampling rule's configuration.
type SamplingRuleUpdate struct {
// Matches attributes derived from the request.
Attributes map[string]string
// The percentage of matching requests to instrument, after the reservoir is
// exhausted.
FixedRate *float64
// Matches the HTTP method of a request.
HTTPMethod *string
// Matches the hostname from a request URL.
Host *string
// The priority of the sampling rule.
Priority *int32
// A fixed number of matching requests to instrument per second, prior to applying
// the fixed rate. The reservoir is not used directly by services, but applies to
// all services using the rule collectively.
ReservoirSize *int32
// Matches the ARN of the Amazon Web Services resource on which the service runs.
ResourceARN *string
// The ARN of the sampling rule. Specify a rule by either name or ARN, but not
// both.
RuleARN *string
// The name of the sampling rule. Specify a rule by either name or ARN, but not
// both.
RuleName *string
// Matches the name that the service uses to identify itself in segments.
ServiceName *string
// Matches the origin that the service uses to identify its type in segments.
ServiceType *string
// Matches the path from a request URL.
URLPath *string
noSmithyDocumentSerde
}
// Request sampling results for a single rule from a service. Results are for the
// last 10 seconds unless the service has been assigned a longer reporting interval
// after a previous call to GetSamplingTargets (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html)
// .
type SamplingStatisticsDocument struct {
// A unique identifier for the service in hexadecimal.
//
// This member is required.
ClientID *string
// The number of requests that matched the rule.
//
// This member is required.
RequestCount int32
// The name of the sampling rule.
//
// This member is required.
RuleName *string
// The number of requests recorded.
//
// This member is required.
SampledCount int32
// The current time.
//
// This member is required.
Timestamp *time.Time
// The number of requests recorded with borrowed reservoir quota.
BorrowCount int32
noSmithyDocumentSerde
}
// Aggregated request sampling data for a sampling rule across all services for a
// 10-second window.
type SamplingStatisticSummary struct {
// The number of requests recorded with borrowed reservoir quota.
BorrowCount int32
// The number of requests that matched the rule.
RequestCount int32
// The name of the sampling rule.
RuleName *string
// The number of requests recorded.
SampledCount int32
// The start time of the reporting window.
Timestamp *time.Time
noSmithyDocumentSerde
}
// The name and value of a sampling rule to apply to a trace summary.
type SamplingStrategy struct {
// The name of a sampling rule.
Name SamplingStrategyName
// The value of a sampling rule.
Value *float64
noSmithyDocumentSerde
}
// Temporary changes to a sampling rule configuration. To meet the global sampling
// target for a rule, X-Ray calculates a new reservoir for each service based on
// the recent sampling results of all services that called GetSamplingTargets (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html)
// .
type SamplingTargetDocument struct {
// The percentage of matching requests to instrument, after the reservoir is
// exhausted.
FixedRate float64
// The number of seconds for the service to wait before getting sampling targets
// again.
Interval *int32
// The number of requests per second that X-Ray allocated for this service.
ReservoirQuota *int32
// When the reservoir quota expires.
ReservoirQuotaTTL *time.Time
// The name of the sampling rule.
RuleName *string
noSmithyDocumentSerde
}
// A segment from a trace that has been ingested by the X-Ray service. The segment
// can be compiled from documents uploaded with PutTraceSegments (https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html)
// , or an inferred segment for a downstream service, generated from a subsegment
// sent by the service that called it. For the full segment document schema, see
// Amazon Web Services X-Ray Segment Documents (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html)
// in the Amazon Web Services X-Ray Developer Guide.
type Segment struct {
// The segment document.
Document *string
// The segment's ID.
Id *string
noSmithyDocumentSerde
}
// Information about an application that processed requests, users that made
// requests, or downstream services, resources, and applications that an
// application used.
type Service struct {
// Identifier of the Amazon Web Services account in which the service runs.
AccountId *string
// A histogram that maps the spread of service durations.
DurationHistogram []HistogramEntry
// Connections to downstream services.
Edges []Edge
// The end time of the last segment that the service generated.
EndTime *time.Time
// The canonical name of the service.
Name *string
// A list of names for the service, including the canonical name.
Names []string
// Identifier for the service. Unique within the service map.
ReferenceId *int32
// A histogram that maps the spread of service response times.
ResponseTimeHistogram []HistogramEntry
// Indicates that the service was the first service to process a request.
Root *bool
// The start time of the first segment that the service generated.
StartTime *time.Time
// The service's state.
State *string
// Aggregated statistics for the service.
SummaryStatistics *ServiceStatistics
// The type of service.
// - Amazon Web Services Resource - The type of an Amazon Web Services resource.
// For example, AWS::EC2::Instance for an application running on Amazon EC2 or
// AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
// - Amazon Web Services Service - The type of an Amazon Web Services service.
// For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't
// target a specific table.
// - client - Represents the clients that sent requests to a root service.
// - remote - A downstream service of indeterminate type.
Type *string
noSmithyDocumentSerde