package types
import "github.com/aws/aws-sdk-go-v2/service/xray/types"
Index ¶
- type Alias
- type AnnotationValue
- type AvailabilityZoneDetail
- type BackendConnectionErrors
- type Edge
- type EdgeStatistics
- type EncryptionConfig
- type EncryptionStatus
- type EncryptionType
- type ErrorRootCause
- type ErrorRootCauseEntity
- type ErrorRootCauseService
- type ErrorStatistics
- type FaultRootCause
- type FaultRootCauseEntity
- type FaultRootCauseService
- type FaultStatistics
- type Group
- type GroupSummary
- type HistogramEntry
- type Http
- type InstanceIdDetail
- type InvalidRequestException
- func (e *InvalidRequestException) Error() string
- func (e *InvalidRequestException) ErrorCode() string
- func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
- func (e *InvalidRequestException) ErrorMessage() string
- func (e *InvalidRequestException) GetMessage() string
- func (e *InvalidRequestException) HasMessage() bool
- type ResourceARNDetail
- type ResponseTimeRootCause
- type ResponseTimeRootCauseEntity
- type ResponseTimeRootCauseService
- type RootCauseException
- type RuleLimitExceededException
- func (e *RuleLimitExceededException) Error() string
- func (e *RuleLimitExceededException) ErrorCode() string
- func (e *RuleLimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *RuleLimitExceededException) ErrorMessage() string
- func (e *RuleLimitExceededException) GetMessage() string
- func (e *RuleLimitExceededException) HasMessage() bool
- type SamplingRule
- type SamplingRuleRecord
- type SamplingRuleUpdate
- type SamplingStatisticSummary
- type SamplingStatisticsDocument
- type SamplingStrategy
- type SamplingStrategyName
- type SamplingTargetDocument
- type Segment
- type Service
- type ServiceId
- type ServiceStatistics
- type TelemetryRecord
- type ThrottledException
- func (e *ThrottledException) Error() string
- func (e *ThrottledException) ErrorCode() string
- func (e *ThrottledException) ErrorFault() smithy.ErrorFault
- func (e *ThrottledException) ErrorMessage() string
- func (e *ThrottledException) GetMessage() string
- func (e *ThrottledException) HasMessage() bool
- type TimeRangeType
- type TimeSeriesServiceStatistics
- type Trace
- type TraceSummary
- type TraceUser
- type UnprocessedStatistics
- type UnprocessedTraceSegment
- type ValueWithServiceIds
Types ¶
type Alias ¶
type Alias struct { // The canonical name of the alias. Name *string // The type of the alias. Type *string // A list of names for the alias, including the canonical name. Names []*string }
An alias for an edge.
type AnnotationValue ¶
type AnnotationValue struct { // Value for a Number annotation. NumberValue *float64 // Value for a Boolean annotation. BooleanValue *bool // Value for a String annotation. StringValue *string }
Value of a segment annotation. Has one of three value types: Number, Boolean or String.
type AvailabilityZoneDetail ¶
type AvailabilityZoneDetail struct { // The name of a corresponding availability zone. Name *string }
A list of availability zones corresponding to the segments in a trace.
type BackendConnectionErrors ¶
type BackendConnectionErrors struct { // HTTPCode5XXCount *int32 // ConnectionRefusedCount *int32 // HTTPCode4XXCount *int32 // UnknownHostCount *int32 // OtherCount *int32 // TimeoutCount *int32 }
type Edge ¶
type Edge struct { // The end time of the last segment on the edge. EndTime *time.Time // Aliases for the edge. Aliases []*Alias // The start time of the first segment on the edge. StartTime *time.Time // Identifier of the edge. Unique within a service map. ReferenceId *int32 // Response statistics for segments on the edge. SummaryStatistics *EdgeStatistics // A histogram that maps the spread of client response times on an edge. ResponseTimeHistogram []*HistogramEntry }
Information about a connection between two services.
type EdgeStatistics ¶
type EdgeStatistics struct { // The number of requests that completed with a 2xx Success status code. OkCount *int64 // Information about requests that failed with a 5xx Server Error status code. FaultStatistics *FaultStatistics // The aggregate response time of completed requests. TotalResponseTime *float64 // The total number of completed requests. TotalCount *int64 // Information about requests that failed with a 4xx Client Error status code. ErrorStatistics *ErrorStatistics }
Response statistics for an edge.
type EncryptionConfig ¶
type EncryptionConfig struct { // The ID of the customer master key (CMK) 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 CMKs. Set to NONE for // default encryption. Type EncryptionType }
A configuration document that specifies encryption configuration settings.
type EncryptionStatus ¶
type EncryptionStatus string
const ( EncryptionStatusUpdating EncryptionStatus = "UPDATING" EncryptionStatusActive EncryptionStatus = "ACTIVE" )
Enum values for EncryptionStatus
type EncryptionType ¶
type EncryptionType string
const ( EncryptionTypeNone EncryptionType = "NONE" EncryptionTypeKms EncryptionType = "KMS" )
Enum values for EncryptionType
type ErrorRootCause ¶
type ErrorRootCause struct { // 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 // A flag that denotes that the root cause impacts the trace client. ClientImpacting *bool }
The root cause of a trace summary error.
type ErrorRootCauseEntity ¶
type ErrorRootCauseEntity struct { // The types and messages of the exceptions. Exceptions []*RootCauseException // A flag that denotes a remote subsegment. Remote *bool // The name of the entity. Name *string }
A collection of segments and corresponding subsegments associated to a trace summary error.
type ErrorRootCauseService ¶
type ErrorRootCauseService struct { // The service name. Name *string // A Boolean value indicating if the service is inferred from the trace. Inferred *bool // A collection of associated service names. Names []*string // The account ID associated to the service. AccountId *string // The path of root cause entities found on the service. EntityPath []*ErrorRootCauseEntity // The type associated to the service. Type *string }
A collection of fields identifying the services in a trace summary error.
type ErrorStatistics ¶
type ErrorStatistics struct { // The total number of requests that failed with a 4xx Client Error status code. TotalCount *int64 // 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 }
Information about requests that failed with a 4xx Client Error status code.
type FaultRootCause ¶
type FaultRootCause struct { // A list of corresponding services. A service identifies a segment and it contains // a name, account ID, type, and inferred flag. Services []*FaultRootCauseService // A flag that denotes that the root cause impacts the trace client. ClientImpacting *bool }
The root cause information for a trace summary fault.
type FaultRootCauseEntity ¶
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 }
A collection of segments and corresponding subsegments associated to a trace summary fault error.
type FaultRootCauseService ¶
type FaultRootCauseService struct { // A Boolean value indicating if the service is inferred from the trace. Inferred *bool // The account ID associated to the service. AccountId *string // A collection of associated service names. Names []*string // The service name. Name *string // The path of root cause entities found on the service. EntityPath []*FaultRootCauseEntity // The type associated to the service. Type *string }
A collection of fields identifying the services in a trace summary fault.
type FaultStatistics ¶
type FaultStatistics struct { // The total number of requests that failed with a 5xx Server Error status code. TotalCount *int64 // The number of requests that failed with untracked 5xx Server Error status codes. OtherCount *int64 }
Information about requests that failed with a 5xx Server Error status code.
type Group ¶
type Group struct { // The ARN of the group generated based on the GroupName. GroupARN *string // The unique case-sensitive name of the group. GroupName *string // The filter expression defining the parameters to include traces. FilterExpression *string }
Details and metadata for a group.
type GroupSummary ¶
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 }
Details for a group without metadata.
type HistogramEntry ¶
type HistogramEntry struct { // The prevalence of the entry. Count *int32 // The value of the entry. Value *float64 }
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 Http ¶
type Http struct { // The request URL. HttpURL *string // The request method. HttpMethod *string // The IP address of the requestor. ClientIp *string // The request's user agent string. UserAgent *string // The response status. HttpStatus *int32 }
Information about an HTTP request.
type InstanceIdDetail ¶
type InstanceIdDetail struct { // The ID of a corresponding EC2 instance. Id *string }
A list of EC2 instance IDs corresponding to the segments in a trace.
type InvalidRequestException ¶
type InvalidRequestException struct { Message *string }
The request is missing required parameters or has invalid parameters.
func (*InvalidRequestException) Error ¶
func (e *InvalidRequestException) Error() string
func (*InvalidRequestException) ErrorCode ¶
func (e *InvalidRequestException) ErrorCode() string
func (*InvalidRequestException) ErrorFault ¶
func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
func (*InvalidRequestException) ErrorMessage ¶
func (e *InvalidRequestException) ErrorMessage() string
func (*InvalidRequestException) GetMessage ¶
func (e *InvalidRequestException) GetMessage() string
func (*InvalidRequestException) HasMessage ¶
func (e *InvalidRequestException) HasMessage() bool
type ResourceARNDetail ¶
type ResourceARNDetail struct { // The ARN of a corresponding resource. ARN *string }
A list of resources ARNs corresponding to the segments in a trace.
type ResponseTimeRootCause ¶
type ResponseTimeRootCause struct { // A list of corresponding services. A service identifies a segment and contains a // name, account ID, type, and inferred flag. Services []*ResponseTimeRootCauseService // A flag that denotes that the root cause impacts the trace client. ClientImpacting *bool }
The root cause information for a response time warning.
type ResponseTimeRootCauseEntity ¶
type ResponseTimeRootCauseEntity struct { // The types and messages of the exceptions. Coverage *float64 // The name of the entity. Name *string // A flag that denotes a remote subsegment. Remote *bool }
A collection of segments and corresponding subsegments associated to a response time warning.
type ResponseTimeRootCauseService ¶
type ResponseTimeRootCauseService struct { // The service name. Name *string // The type associated to the service. Type *string // A collection of associated service names. Names []*string // The account ID associated to the service. AccountId *string // A Boolean value indicating if the service is inferred from the trace. Inferred *bool // The path of root cause entities found on the service. EntityPath []*ResponseTimeRootCauseEntity }
A collection of fields identifying the service in a response time warning.
type RootCauseException ¶
type RootCauseException struct { // The message of the exception. Message *string // The name of the exception. Name *string }
The exception associated with a root cause.
type RuleLimitExceededException ¶
type RuleLimitExceededException struct { Message *string }
You have reached the maximum number of sampling rules.
func (*RuleLimitExceededException) Error ¶
func (e *RuleLimitExceededException) Error() string
func (*RuleLimitExceededException) ErrorCode ¶
func (e *RuleLimitExceededException) ErrorCode() string
func (*RuleLimitExceededException) ErrorFault ¶
func (e *RuleLimitExceededException) ErrorFault() smithy.ErrorFault
func (*RuleLimitExceededException) ErrorMessage ¶
func (e *RuleLimitExceededException) ErrorMessage() string
func (*RuleLimitExceededException) GetMessage ¶
func (e *RuleLimitExceededException) GetMessage() string
func (*RuleLimitExceededException) HasMessage ¶
func (e *RuleLimitExceededException) HasMessage() bool
type SamplingRule ¶
type SamplingRule struct { // The percentage of matching requests to instrument, after the reservoir is // exhausted. FixedRate *float64 // Matches the origin that the service uses to identify its type in segments. ServiceType *string // Matches attributes derived from the request. Attributes map[string]*string // The version of the sampling rule format (1). Version *int32 // Matches the HTTP method of a request. HTTPMethod *string // Matches the name that the service uses to identify itself in segments. ServiceName *string // 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 // The ARN of the sampling rule. Specify a rule by either name or ARN, but not // both. RuleARN *string // Matches the hostname from a request URL. Host *string // Matches the ARN of the AWS resource on which the service runs. ResourceARN *string // The priority of the sampling rule. Priority *int32 // Matches the path from a request URL. URLPath *string // The name of the sampling rule. Specify a rule by either name or ARN, but not // both. RuleName *string }
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 SamplingRuleRecord ¶
type SamplingRuleRecord struct { // The sampling rule. SamplingRule *SamplingRule // When the rule was created. CreatedAt *time.Time // When the rule was last modified. ModifiedAt *time.Time }
A SamplingRule () and its metadata.
type SamplingRuleUpdate ¶
type SamplingRuleUpdate struct { // 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 name that the service uses to identify itself in segments. ServiceName *string // 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 // Matches the origin that the service uses to identify its type in segments. ServiceType *string // Matches the hostname from a request URL. Host *string // The priority of the sampling rule. Priority *int32 // Matches the ARN of the AWS resource on which the service runs. ResourceARN *string // Matches the path from a request URL. URLPath *string // The name of the sampling rule. Specify a rule by either name or ARN, but not // both. RuleName *string // The percentage of matching requests to instrument, after the reservoir is // exhausted. FixedRate *float64 // Matches the HTTP method of a request. HTTPMethod *string }
A document specifying changes to a sampling rule's configuration.
type SamplingStatisticSummary ¶
type SamplingStatisticSummary struct { // 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 // The number of requests recorded with borrowed reservoir quota. BorrowCount *int32 // The number of requests that matched the rule. RequestCount *int32 }
Aggregated request sampling data for a sampling rule across all services for a 10 second window.
type SamplingStatisticsDocument ¶
type SamplingStatisticsDocument struct { // The number of requests recorded. SampledCount *int32 // The number of requests that matched the rule. RequestCount *int32 // The name of the sampling rule. RuleName *string // The number of requests recorded with borrowed reservoir quota. BorrowCount *int32 // The current time. Timestamp *time.Time // A unique identifier for the service in hexadecimal. ClientID *string }
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 ().
type SamplingStrategy ¶
type SamplingStrategy struct { // The name of a sampling rule. Name SamplingStrategyName // The value of a sampling rule. Value *float64 }
The name and value of a sampling rule to apply to a trace summary.
type SamplingStrategyName ¶
type SamplingStrategyName string
const ( SamplingStrategyNamePartialscan SamplingStrategyName = "PartialScan" SamplingStrategyNameFixedrate SamplingStrategyName = "FixedRate" )
Enum values for SamplingStrategyName
type SamplingTargetDocument ¶
type SamplingTargetDocument struct { // The name of the sampling rule. RuleName *string // When the reservoir quota expires. ReservoirQuotaTTL *time.Time // 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 this service. ReservoirQuota *int32 }
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 ().
type Segment ¶
A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments (), 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 AWS X-Ray Segment Documents (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) in the AWS X-Ray Developer Guide.
type Service ¶
type Service struct { // Aggregated statistics for the service. SummaryStatistics *ServiceStatistics // The service's state. State *string // The start time of the first segment that the service generated. StartTime *time.Time // A histogram that maps the spread of service response times. ResponseTimeHistogram []*HistogramEntry // Identifier of the AWS account in which the service runs. AccountId *string // The canonical name of the service. Name *string // The end time of the last segment that the service generated. EndTime *time.Time // Connections to downstream services. Edges []*Edge // A histogram that maps the spread of service durations. DurationHistogram []*HistogramEntry // Identifier for the service. Unique within the service map. ReferenceId *int32 // Indicates that the service was the first service to process a request. Root *bool // A list of names for the service, including the canonical name. Names []*string // The type of service. // // * AWS Resource - The type of an AWS resource. For // example, AWS::EC2::Instance for a application running on Amazon EC2 or // AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. // // // * AWS Service - The type of an AWS 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 }
Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.
type ServiceId ¶
type ServiceStatistics ¶
type ServiceStatistics struct { // The aggregate response time of completed requests. TotalResponseTime *float64 // The total number of completed requests. TotalCount *int64 // Information about requests that failed with a 4xx Client Error status code. ErrorStatistics *ErrorStatistics // The number of requests that completed with a 2xx Success status code. OkCount *int64 // Information about requests that failed with a 5xx Server Error status code. FaultStatistics *FaultStatistics }
Response statistics for a service.
type TelemetryRecord ¶
type TelemetryRecord struct { // Timestamp *time.Time // SegmentsReceivedCount *int32 // SegmentsSentCount *int32 // SegmentsRejectedCount *int32 // BackendConnectionErrors *BackendConnectionErrors // SegmentsSpilloverCount *int32 }
type ThrottledException ¶
type ThrottledException struct { Message *string }
The request exceeds the maximum number of requests per second.
func (*ThrottledException) Error ¶
func (e *ThrottledException) Error() string
func (*ThrottledException) ErrorCode ¶
func (e *ThrottledException) ErrorCode() string
func (*ThrottledException) ErrorFault ¶
func (e *ThrottledException) ErrorFault() smithy.ErrorFault
func (*ThrottledException) ErrorMessage ¶
func (e *ThrottledException) ErrorMessage() string
func (*ThrottledException) GetMessage ¶
func (e *ThrottledException) GetMessage() string
func (*ThrottledException) HasMessage ¶
func (e *ThrottledException) HasMessage() bool
type TimeRangeType ¶
type TimeRangeType string
const ( TimeRangeTypeTraceid TimeRangeType = "TraceId" TimeRangeTypeEvent TimeRangeType = "Event" )
Enum values for TimeRangeType
type TimeSeriesServiceStatistics ¶
type TimeSeriesServiceStatistics struct { // Response statistics for a service. ServiceSummaryStatistics *ServiceStatistics // Timestamp of the window for which statistics are aggregated. Timestamp *time.Time // Response statistics for an edge. EdgeSummaryStatistics *EdgeStatistics // The response time histogram for the selected entities. ResponseTimeHistogram []*HistogramEntry }
A list of TimeSeriesStatistic structures.
type Trace ¶
type Trace struct { // The unique identifier for the request that generated the trace's segments and // subsegments. Id *string // Segment documents for the segments and subsegments that comprise the trace. Segments []*Segment // The length of time in seconds between the start time of the root segment and the // end time of the last segment that completed. Duration *float64 }
A collection of segment documents with matching trace IDs.
type TraceSummary ¶
type TraceSummary struct { // The root of a trace. EntryPoint *ServiceId // A collection of FaultRootCause structures corresponding to the the trace // segments. FaultRootCauses []*FaultRootCause // Information about the HTTP request served by the trace. Http *Http // A list of availability zones for any zone corresponding to the trace segments. AvailabilityZones []*AvailabilityZoneDetail // A list of EC2 instance IDs for any instance corresponding to the trace segments. InstanceIds []*InstanceIdDetail // The root segment document has a 400 series error. HasError *bool // The matched time stamp of a defined event. MatchedEventTime *time.Time // The unique identifier for the request that generated the trace's segments and // subsegments. Id *string // A list of resource ARNs for any resource corresponding to the trace segments. ResourceARNs []*ResourceARNDetail // The root segment document has a 500 series error. HasFault *bool // Annotations from the trace's segment documents. Annotations map[string][]*ValueWithServiceIds // A collection of ErrorRootCause structures corresponding to the trace segments. ErrorRootCauses []*ErrorRootCause // One or more of the segment documents is in progress. IsPartial *bool // The length of time in seconds between the start time of the root segment and the // end time of the last segment that completed. Duration *float64 // The length of time in seconds between the start and end times of the root // segment. If the service performs work asynchronously, the response time measures // the time before the response is sent to the user, while the duration measures // the amount of time before the last traced activity completes. ResponseTime *float64 // Service IDs from the trace's segment documents. ServiceIds []*ServiceId // A collection of ResponseTimeRootCause structures corresponding to the trace // segments. ResponseTimeRootCauses []*ResponseTimeRootCause // The revision number of a trace. Revision *int32 // One or more of the segment documents has a 429 throttling error. HasThrottle *bool // Users from the trace's segment documents. Users []*TraceUser }
Metadata generated from the segment documents in a trace.
type TraceUser ¶
type TraceUser struct { // The user's name. UserName *string // Services that the user's request hit. ServiceIds []*ServiceId }
Information about a user recorded in segment documents.
type UnprocessedStatistics ¶
type UnprocessedStatistics struct { // The error message. Message *string // The error code. ErrorCode *string // The name of the sampling rule. RuleName *string }
Sampling statistics from a call to GetSamplingTargets () that X-Ray could not process.
type UnprocessedTraceSegment ¶
type UnprocessedTraceSegment struct { // The error message. Message *string // The segment's ID. Id *string // The error that caused processing to fail. ErrorCode *string }
Information about a segment that failed processing.
type ValueWithServiceIds ¶
type ValueWithServiceIds struct { // Services to which the annotation applies. ServiceIds []*ServiceId // Values of the annotation. AnnotationValue *AnnotationValue }
Information about a segment annotation.
Source Files ¶
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- js/wasm
- Imports
- 4 packages
- Last checked
- 2 days ago –
Tools for package owners.