String name
The name of a corresponding availability zone.
Group group
The group that was created. Contains the name of the group that was created, the ARN of the group that was generated based on the group name, and the filter expression that was assigned to the group.
SamplingRule samplingRule
The rule definition.
SamplingRuleRecord samplingRuleRecord
The saved rule definition and metadata.
SamplingRuleRecord samplingRuleRecord
The deleted rule definition and metadata.
Integer referenceId
Identifier of the edge. Unique within a service map.
Date startTime
The start time of the first segment on the edge.
Date endTime
The end time of the last segment on the edge.
EdgeStatistics summaryStatistics
Response statistics for segments on the edge.
List<E> responseTimeHistogram
A histogram that maps the spread of client response times on an edge.
List<E> aliases
Aliases for the edge.
Long okCount
The number of requests that completed with a 2xx Success status code.
ErrorStatistics errorStatistics
Information about requests that failed with a 4xx Client Error status code.
FaultStatistics faultStatistics
Information about requests that failed with a 5xx Server Error status code.
Long totalCount
The total number of completed requests.
Double totalResponseTime
The aggregate response time of completed requests.
String keyId
The ID of the customer master key (CMK) used for encryption, if applicable.
String status
The encryption status. While the status is UPDATING
, X-Ray may encrypt data with a combination of
the new and old settings.
String type
The type of encryption. Set to KMS
for encryption with CMKs. Set to NONE
for default
encryption.
String name
The service name.
List<E> names
A collection of associated service names.
String type
The type associated to the service.
String accountId
The account ID associated to the service.
List<E> entityPath
The path of root cause entities found on the service.
Boolean inferred
A Boolean value indicating if the service is inferred from the trace.
Long throttleCount
The number of requests that failed with a 419 throttling status code.
Long otherCount
The number of requests that failed with untracked 4xx Client Error status codes.
Long totalCount
The total number of requests that failed with a 4xx Client Error status code.
String name
The service name.
List<E> names
A collection of associated service names.
String type
The type associated to the service.
String accountId
The account ID associated to the service.
List<E> entityPath
The path of root cause entities found on the service.
Boolean inferred
A Boolean value indicating if the service is inferred from the trace.
EncryptionConfig encryptionConfig
The encryption configuration document.
Group group
The group that was requested. Contains the name of the group, the ARN of the group, and the filter expression that assigned to the group.
String nextToken
Pagination token.
String nextToken
Pagination token.
String nextToken
Pagination token.
List<E> samplingTargetDocuments
Updated rules that the service should use to sample requests.
Date lastRuleModification
The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.
List<E> unprocessedStatistics
Information about SamplingStatisticsDocument that X-Ray could not process.
Date startTime
The start of the time frame for which to generate a graph.
Date endTime
The end of the timeframe for which to generate a graph.
String groupName
The name of a group to generate a graph based on.
String groupARN
The ARN of a group to generate a graph based on.
String nextToken
Pagination token.
Date startTime
The start of the time frame for which the graph was generated.
Date endTime
The end of the time frame for which the graph was generated.
List<E> services
The services that have processed a traced request during the specified time frame.
Boolean containsOldGroupVersions
A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.
String nextToken
Pagination token.
Date startTime
The start of the time frame for which to aggregate statistics.
Date endTime
The end of the time frame for which to aggregate statistics.
String groupName
The case-sensitive name of the group for which to pull statistics from.
String groupARN
The ARN of the group for which to pull statistics from.
String entitySelectorExpression
A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.
Integer period
Aggregation period in seconds.
String nextToken
Pagination token.
List<E> timeSeriesServiceStatistics
The collection of statistics.
Boolean containsOldGroupVersions
A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation may show statistics from an older version of the group's filter expression.
String nextToken
Pagination token.
Date startTime
The start of the time frame for which to retrieve traces.
Date endTime
The end of the time frame for which to retrieve traces.
String timeRangeType
A parameter to indicate whether to query trace summaries by TraceId or Event time.
Boolean sampling
Set to true
to get summaries for only a subset of available traces.
SamplingStrategy samplingStrategy
A paramater to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
String filterExpression
Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
String nextToken
Specify the pagination token returned by a previous request to retrieve the next page of results.
List<E> traceSummaries
Trace IDs and annotations for traces that were found in the specified time frame.
Date approximateTime
The start time of this page of results.
Long tracesProcessedCount
The total number of traces processed, including traces that did not match the specified filter expression.
String nextToken
If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most most recent results, closest to the end of the time frame.
String id
The ID of a corresponding EC2 instance.
String keyId
An AWS KMS customer master key (CMK) in one of the following formats:
Alias - The name of the key. For example, alias/MyKey
.
Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
. AWS
X-Ray does not support asymmetric CMKs.
ARN - The full Amazon Resource Name of the key ID or alias. For example,
arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
. Use this format to
specify a key in a different account.
Omit this key if you set Type
to NONE
.
String type
The type of encryption. Set to KMS
to use your own key for encryption. Set to NONE
for
default encryption.
EncryptionConfig encryptionConfig
The new encryption configuration.
String aRN
The ARN of a corresponding resource.
String name
The service name.
List<E> names
A collection of associated service names.
String type
The type associated to the service.
String accountId
The account ID associated to the service.
List<E> entityPath
The path of root cause entities found on the service.
Boolean inferred
A Boolean value indicating if the service is inferred from the trace.
String ruleName
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
String ruleARN
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
String resourceARN
Matches the ARN of the AWS resource on which the service runs.
Integer priority
The priority of the sampling rule.
Double fixedRate
The percentage of matching requests to instrument, after the reservoir is exhausted.
Integer reservoirSize
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.
String serviceName
Matches the name
that the service uses to identify itself in segments.
String serviceType
Matches the origin
that the service uses to identify its type in segments.
String host
Matches the hostname from a request URL.
String hTTPMethod
Matches the HTTP method of a request.
String uRLPath
Matches the path from a request URL.
Integer version
The version of the sampling rule format (1
).
Map<K,V> attributes
Matches attributes derived from the request.
SamplingRule samplingRule
The sampling rule.
Date createdAt
When the rule was created.
Date modifiedAt
When the rule was last modified.
String ruleName
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
String ruleARN
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
String resourceARN
Matches the ARN of the AWS resource on which the service runs.
Integer priority
The priority of the sampling rule.
Double fixedRate
The percentage of matching requests to instrument, after the reservoir is exhausted.
Integer reservoirSize
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.
String host
Matches the hostname from a request URL.
String serviceName
Matches the name
that the service uses to identify itself in segments.
String serviceType
Matches the origin
that the service uses to identify its type in segments.
String hTTPMethod
Matches the HTTP method of a request.
String uRLPath
Matches the path from a request URL.
Map<K,V> attributes
Matches attributes derived from the request.
String ruleName
The name of the sampling rule.
String clientID
A unique identifier for the service in hexadecimal.
Date timestamp
The current time.
Integer requestCount
The number of requests that matched the rule.
Integer sampledCount
The number of requests recorded.
Integer borrowCount
The number of requests recorded with borrowed reservoir quota.
String ruleName
The name of the sampling rule.
Date timestamp
The start time of the reporting window.
Integer requestCount
The number of requests that matched the rule.
Integer borrowCount
The number of requests recorded with borrowed reservoir quota.
Integer sampledCount
The number of requests recorded.
String ruleName
The name of the sampling rule.
Double fixedRate
The percentage of matching requests to instrument, after the reservoir is exhausted.
Integer reservoirQuota
The number of requests per second that X-Ray allocated this service.
Date reservoirQuotaTTL
When the reservoir quota expires.
Integer interval
The number of seconds for the service to wait before getting sampling targets again.
Integer referenceId
Identifier for the service. Unique within the service map.
String name
The canonical name of the service.
List<E> names
A list of names for the service, including the canonical name.
Boolean root
Indicates that the service was the first service to process a request.
String accountId
Identifier of the AWS account in which the service runs.
String type
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.
String state
The service's state.
Date startTime
The start time of the first segment that the service generated.
Date endTime
The end time of the last segment that the service generated.
List<E> edges
Connections to downstream services.
ServiceStatistics summaryStatistics
Aggregated statistics for the service.
List<E> durationHistogram
A histogram that maps the spread of service durations.
List<E> responseTimeHistogram
A histogram that maps the spread of service response times.
Long okCount
The number of requests that completed with a 2xx Success status code.
ErrorStatistics errorStatistics
Information about requests that failed with a 4xx Client Error status code.
FaultStatistics faultStatistics
Information about requests that failed with a 5xx Server Error status code.
Long totalCount
The total number of completed requests.
Double totalResponseTime
The aggregate response time of completed requests.
Date timestamp
Timestamp of the window for which statistics are aggregated.
EdgeStatistics edgeSummaryStatistics
ServiceStatistics serviceSummaryStatistics
List<E> responseTimeHistogram
The response time histogram for the selected entities.
String id
The unique identifier for the request that generated the trace's segments and subsegments.
Double duration
The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
List<E> segments
Segment documents for the segments and subsegments that comprise the trace.
String id
The unique identifier for the request that generated the trace's segments and subsegments.
Double duration
The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
Double responseTime
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.
Boolean hasFault
The root segment document has a 500 series error.
Boolean hasError
The root segment document has a 400 series error.
Boolean hasThrottle
One or more of the segment documents has a 429 throttling error.
Boolean isPartial
One or more of the segment documents is in progress.
Http http
Information about the HTTP request served by the trace.
Map<K,V> annotations
Annotations from the trace's segment documents.
List<E> users
Users from the trace's segment documents.
List<E> serviceIds
Service IDs from the trace's segment documents.
List<E> resourceARNs
A list of resource ARNs for any resource corresponding to the trace segments.
List<E> instanceIds
A list of EC2 instance IDs for any instance corresponding to the trace segments.
List<E> availabilityZones
A list of availability zones for any zone corresponding to the trace segments.
ServiceId entryPoint
The root of a trace.
List<E> faultRootCauses
A collection of FaultRootCause structures corresponding to the the trace segments.
List<E> errorRootCauses
A collection of ErrorRootCause structures corresponding to the trace segments.
List<E> responseTimeRootCauses
A collection of ResponseTimeRootCause structures corresponding to the trace segments.
Integer revision
The revision number of a trace.
Date matchedEventTime
The matched time stamp of a defined event.
Group group
The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, and the updated filter expression assigned to the group.
SamplingRuleUpdate samplingRuleUpdate
The rule and fields to change.
SamplingRuleRecord samplingRuleRecord
The updated rule definition and metadata.
AnnotationValue annotationValue
Values of the annotation.
List<E> serviceIds
Services to which the annotation applies.
Copyright © 2020. All rights reserved.