id stringlengths 8 78 | source stringclasses 743
values | chunk_id int64 1 5.05k | text stringlengths 593 49.7k |
|---|---|---|---|
workspacesweb-api-046 | workspacesweb-api.pdf | 46 | strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: ^((([a-zA-Z][a-zA-Z0-9+.-]*):\/\/(\*|[\w%._\-\+~#=@]+)?(\/[^@ \s]*)?(?:\?([^*\s]+(?:\*?)))?)|(\*|[\w%._\-\+~#=@]+\.[\w%._\-\+~#=@]+) InlineRedactionConfiguration API Version 2020-07-08 285 Amazon WorkSpaces Secure Browser API Referenc... |
workspacesweb-api-047 | workspacesweb-api.pdf | 47 | Contents API Version 2020-07-08 291 Amazon WorkSpaces Secure Browser API Reference ipRules The IP rules of the IP access settings. Type: Array of IpRule objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No See Also For more information about using this API in one of the language-sp... |
workspacesweb-api-048 | workspacesweb-api.pdf | 48 | for Ruby V3 NetworkSettingsSummary API Version 2020-07-08 298 Amazon WorkSpaces Secure Browser API Reference Portal The web portal. Contents portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA... |
workspacesweb-api-049 | workspacesweb-api.pdf | 49 | Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 304 API Reference Amazon WorkSpaces Secure Browser PortalSummary The summary of the portal. Contents portalArn The ARN of the web portal. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]... |
workspacesweb-api-050 | workspacesweb-api.pdf | 50 | SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RedactionPlaceHolder API Version 2020-07-08 310 Amazon WorkSpaces Secure Browser API Reference Session Information about a secure browser session. Contents clientIpAddresses The IP address of the client. Type: Array of strings Array Members: Minimum number of 1 it... |
workspacesweb-api-051 | workspacesweb-api.pdf | 51 | SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-07-08 318 Amazon WorkSpaces Secure Browser TrustStore API Reference A trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a ... |
workspacesweb-api-052 | workspacesweb-api.pdf | 52 | WorkSpaces Secure Browser API Reference Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9] {1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ Required: No cookieSynchronizationConfiguration The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser... |
workspacesweb-api-053 | workspacesweb-api.pdf | 53 | end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences. Type: ToolbarConfiguration object Required: No uploadAllowed Specifies whether the user can upload files from the local device to the streaming session. Type: String Valid Values: Disab... |
workspacesweb-api-054 | workspacesweb-api.pdf | 54 | this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standar... |
xray-api-001 | xray-api.pdf | 1 | API Reference AWS X-Ray API Version 2016-04-12 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS X-Ray API Reference AWS X-Ray: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in... |
xray-api-002 | xray-api.pdf | 2 | 64 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 65 See Al... |
xray-api-003 | xray-api.pdf | 3 | 151 Contents ............................................................................................................................................... 151 See Also ................................................................................................................................................ 151 B... |
xray-api-004 | xray-api.pdf | 4 | Actions The following actions are supported: • BatchGetTraces • CancelTraceRetrieval • CreateGroup • CreateSamplingRule • DeleteGroup • DeleteResourcePolicy • DeleteSamplingRule • GetEncryptionConfig • GetGroup • GetGroups • GetIndexingRules • GetInsight • GetInsightEvents • GetInsightImpactGraph • GetInsightSummaries •... |
xray-api-005 | xray-api.pdf | 5 | for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2016-04-12 9 AWS X-Ray CreateGroup Creates a group resource with a name and a filter expression. API Reference Request Syntax POST /CreateG... |
xray-api-006 | xray-api.pdf | 6 | HTTP/1.1 Content-type: application/json { "SamplingRule": { "Attributes": { "string" : "string" }, "FixedRate": number, "Host": "string", "HTTPMethod": "string", "Priority": number, "ReservoirSize": number, "ResourceARN": "string", "RuleARN": "string", "RuleName": "string", "ServiceName": "string", "ServiceType": "stri... |
xray-api-007 | xray-api.pdf | 7 | Response Syntax API Version 2016-04-12 19 AWS X-Ray • AWS SDK for Ruby V3 API Reference See Also API Version 2016-04-12 20 AWS X-Ray API Reference DeleteResourcePolicy Deletes a resource policy from the target AWS account. Request Syntax POST /DeleteResourcePolicy HTTP/1.1 Content-type: application/json { "PolicyName":... |
xray-api-008 | xray-api.pdf | 8 | body. Response Syntax HTTP/1.1 200 Content-type: application/json { "EncryptionConfig": { "KeyId": "string", "Status": "string", "Type": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EncryptionConfig ... |
xray-api-009 | xray-api.pdf | 9 | about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Versi... |
xray-api-010 | xray-api.pdf | 10 | • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2016-04-12 40 AWS X-Ray GetInsightEvents API Reference X-Ray reevaluates insights periodically until they're resolved, and recor... |
xray-api-011 | xray-api.pdf | 11 | Type: Timestamp Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "EndTime": number, "InsightId": "string", "NextToken": "string", "ServiceGraphEndTime": number, "ServiceGraphStartTime": number, "Services": [ { "AccountId": "string", "Edges": [ { "ReferenceId": number } ], "Name": "string", Re... |
xray-api-012 | xray-api.pdf | 12 | the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight. Type: Array of InsightSummary objects NextToken Pagination token. Type: String Length Constraints: Minimum length o... |
xray-api-013 | xray-api.pdf | 13 | parameters or has invalid parameters. HTTP Status Code: 400 ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct. HTTP Status Code: 404 ThrottledException The request exceeds the maximum number of requests per second. HTTP Status Code: 429 S... |
xray-api-014 | xray-api.pdf | 14 | Requests a sampling quota for rules that the service is using to sample requests. Request Syntax POST /SamplingTargets HTTP/1.1 Content-type: application/json { "SamplingStatisticsDocuments": [ { "BorrowCount": number, "ClientID": "string", "RequestCount": number, "RuleName": "string", "SampledCount": number, "Timestam... |
xray-api-015 | xray-api.pdf | 15 | "Names": [ "string" ], Response Syntax API Version 2016-04-12 73 AWS X-Ray API Reference "ReferenceId": number, "ResponseTimeHistogram": [ { "Count": number, "Value": number } ], "Root": boolean, "StartTime": number, "State": "string", "SummaryStatistics": { "ErrorStatistics": { "OtherCount": number, "ThrottleCount": n... |
xray-api-016 | xray-api.pdf | 16 | A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group's filter expression. Type: Boolean NextToken Pagination token. Type: String TimeSeriesServiceStatistics The collection of statistics. Type: Array of TimeSe... |
xray-api-017 | xray-api.pdf | 17 | Response Syntax HTTP/1.1 200 Content-type: application/json { "Destination": "string", "Status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Destination Retrieves the current destination. Type: Strin... |
xray-api-018 | xray-api.pdf | 18 | boolean, "Name": "string", "Names": [ "string" ], "Type": "string" } ] } ], "HasError": boolean, "HasFault": boolean, "HasThrottle": boolean, "Http": { "ClientIp": "string", "HttpMethod": "string", "HttpStatus": number, "HttpURL": "string", "UserAgent": "string" }, "Id": "string", "InstanceIds": [ { "Id": "string" } ],... |
xray-api-019 | xray-api.pdf | 19 | X-Ray ListRetrievedTraces API Reference Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces. This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval... |
xray-api-020 | xray-api.pdf | 20 | JSON format by the service. NextToken A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results to get the next page of results. Type: String Tags A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling r... |
xray-api-021 | xray-api.pdf | 21 | following data in JSON format. BypassPolicyLockoutCheck A flag to indicate whether to bypass the resource policy lockout safety check. Important Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately. Use this parameter only when you include a p... |
xray-api-022 | xray-api.pdf | 22 | 2016-04-12 116 AWS X-Ray InvalidRequestException API Reference The request is missing required parameters or has invalid parameters. HTTP Status Code: 400 ThrottledException The request exceeds the maximum number of requests per second. HTTP Status Code: 429 See Also For more information about using this API in one of ... |
xray-api-023 | xray-api.pdf | 23 | AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-04-12 121 AWS X-Ray StartTraceRetrieval API Reference Initiates a trace retrieval process using the specified time range and... |
xray-api-024 | xray-api.pdf | 24 | per resource: 50 • Maximum tag key length: 128 Unicode characters • Maximum tag value length: 256 Unicode characters • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ • Tag keys and values are case sensitive. • Don't use aws: as a prefix for keys; it's reserved for... |
xray-api-025 | xray-api.pdf | 25 | Type: String Length Constraints: Minimum length of 1. Maximum length of 400. Required: No UpdateGroup API Version 2016-04-12 132 AWS X-Ray GroupName The case-sensitive name of the group. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 32. Required: No InsightsConfiguration The struc... |
xray-api-026 | xray-api.pdf | 26 | "string", "HTTPMethod": "string", "Priority": number, "ReservoirSize": number, "ResourceARN": "string", "RuleARN": "string", "RuleName": "string", "ServiceName": "string", "ServiceType": "string", "URLPath": "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accept... |
xray-api-027 | xray-api.pdf | 27 | • ResponseTimeRootCause • ResponseTimeRootCauseEntity • ResponseTimeRootCauseService • RetrievedService • RetrievedTrace • RootCauseException • SamplingRule • SamplingRuleRecord • SamplingRuleUpdate • SamplingStatisticsDocument • SamplingStatisticSummary • SamplingStrategy • SamplingTargetDocument API Reference API Ver... |
xray-api-028 | xray-api.pdf | 28 | for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-04-12 155 API Reference AWS X-Ray EdgeStatistics Response statistics for an edge. Contents ErrorStatistics Information about requests that failed with a 4xx Client Error status code. Type: ErrorStatistics object Required: No FaultStatistics Information about r... |
xray-api-029 | xray-api.pdf | 29 | requests that failed with a 4xx Client Error status code. Type: Long Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ErrorStatistics API Version 2016-04-12 164 API Reference AWS X-Ra... |
xray-api-030 | xray-api.pdf | 30 | Group Details and metadata for a group. Contents FilterExpression API Reference The filter expression defining the parameters to include traces. Type: String Required: No GroupARN The Amazon Resource Name (ARN) of the group generated based on the GroupName. Type: String Required: No GroupName The unique case-sensitive na... |
xray-api-031 | xray-api.pdf | 31 | Probabilistic Indexing rule configuration that is used to probabilistically sample traceIds. Type: ProbabilisticRuleValue object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Indexi... |
xray-api-032 | xray-api.pdf | 32 | about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InsightImpactGraphEdge API Version 2016-04-12 188 AWS X-Ray API Reference InsightImpactGraphService Information about an application that processed requests, users that made req... |
xray-api-033 | xray-api.pdf | 33 | for Ruby V3 See Also API Version 2016-04-12 194 AWS X-Ray InstanceIdDetail A list of EC2 instance IDs corresponding to the segments in a trace. API Reference Contents Id The ID of a corresponding EC2 instance. Type: String Required: No See Also For more information about using this API in one of the language-specific AW... |
xray-api-034 | xray-api.pdf | 34 | Type: Double Required: No Name The name of the entity. Type: String Required: No Remote A flag that denotes a remote subsegment. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for ... |
xray-api-035 | xray-api.pdf | 35 | fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively. Type: Integer Valid Range: Minimum value of 0. Required: Yes ResourceARN Matches the ARN of the AWS resource on which the service runs. Type: String Length Constraints: Maximum length of 500. Required: Ye... |
xray-api-036 | xray-api.pdf | 36 | 128. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-04-12 217 AWS X-Ray API Reference SamplingStatisticsDocument Request sampling results for a single rule... |
xray-api-037 | xray-api.pdf | 37 | segment document. Type: String Length Constraints: Minimum length of 1. Required: No Id The segment's ID. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Segment API Ver... |
xray-api-038 | xray-api.pdf | 38 | AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Span API Version 2016-04-12 232 AWS X-Ray Tag API Reference A map that contains tag keys and tag values to attach to an AWS X-Ray group or sampling rule. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference. The f... |
xray-api-039 | xray-api.pdf | 39 | AvailabilityZones A list of Availability Zones for any zone corresponding to the trace segments. Type: Array of AvailabilityZoneDetail objects Required: No Duration The length of time in seconds between the start time of the earliest segment that started and the end time of the last segment that completed. Type: Double... |
xray-api-040 | xray-api.pdf | 40 | for Java V2 • AWS SDK for Ruby V3 UnprocessedTraceSegment API Version 2016-04-12 248 AWS X-Ray API Reference ValueWithServiceIds Information about a segment annotation. Contents AnnotationValue Values of the annotation. Type: AnnotationValue object Required: No ServiceIds Services to which the annotation applies. Type:... |
xray-api-041 | xray-api.pdf | 41 | NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2016-04-12 253 AWS X-Ray HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborte... |
xray-guide-001 | xray-guide.pdf | 1 | Developer Guide AWS X-Ray Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS X-Ray Developer Guide AWS X-Ray: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with ... |
xray-guide-002 | xray-guide.pdf | 2 | in CloudTrail ...................................................................................................... 271 X-Ray event examples ....................................................................................................................... 273 CloudWatch .............................................. |
xray-guide-003 | xray-guide.pdf | 3 | 504 Troubleshooting ........................................................................................................................... 505 X-Ray trace map and trace details pages ........................................................................................... 505 I don't see all of my CloudWatch log... |
xray-guide-004 | xray-guide.pdf | 4 | For more information about choosing a console, see Use a console. The following diagram shows how to get started using X-Ray: 4 AWS X-Ray Developer Guide For an example of the data and maps that are available in the console, launch a sample application that is already instrumented to generate trace data. In a few minut... |
xray-guide-005 | xray-guide.pdf | 5 | you are using the ADOT SDK, you have the following options, in combination with an agent: • Use the ADOT SDK with the CloudWatch agent – recommended. Use the ADOT SDK 8 AWS X-Ray Developer Guide • Use the ADOT SDK with the ADOT Collector – recommended if you want to use vendor agnostic software with AWS layers of secur... |
xray-guide-006 | xray-guide.pdf | 6 | errors and set up monitoring based on specific log values. • Metrics – Measure and monitor your application performance using metrics that your resources emit or create your own metrics. View these metrics in graphs and charts. • Monitoring networks and infrastructure – Monitor major networks for outages and the health ... |
xray-guide-007 | xray-guide.pdf | 7 | that were unsuccessful. Trace map 14 AWS X-Ray Note Developer Guide CloudWatch now includes Application Signals, which can discover and monitor your application services, clients, synthetics canaries, and service dependencies. Use Application Signals to see a list or visual map of your services, view health metrics bas... |
xray-guide-008 | xray-guide.pdf | 8 | Choose a group name from the group filter on the top-left of the trace map. X-Ray console Choose a group name from the drop-down menu to the left of the search bar. Trace map 20 AWS X-Ray Developer Guide The service map will now be filtered to display traces that match the filter expression of the selected group. Trace ma... |
xray-guide-009 | xray-guide.pdf | 9 | that are created with a W3C-format trace ID, the console displays the matching trace in X-Ray format. For example, if you query for 4efaaf4d1e8720b39541901950019ee5 in W3C format, the console displays the X-Ray equivalent: 1-4efaaf4d-1e8720b39541901950019ee5. 5. Choose Run query at any time to display a list of matchin... |
xray-guide-010 | xray-guide.pdf | 10 | when available. • The Duration column: Lists how long the segment or subsegment ran. • The Hosted in column: Lists the namespace or environment where the segment or subsegment is ran, if applicable. For more information, see Dimensions collected and dimension combinations. • The last column: Displays horizontal bars th... |
xray-guide-011 | xray-guide.pdf | 11 | recorded on the subsegment. Exceptions are captured automatically when they are generated from an instrumented request. Annotations and metadata contain additional information that you record by using the operations that the X-Ray SDK provides. Use the X-Ray SDK to add annotations or metadata to your segments. For more... |
xray-guide-012 | xray-guide.pdf | 12 | create and modify groups by using the dropdown menu to the left of the filter expression search bar. Note If the service encounters an error in qualifying a group, that group is no longer included in processing incoming traces and an error metric is recorded. For more information about groups, see Configuring groups. Fil... |
xray-guide-013 | xray-guide.pdf | 13 | the total duration was 5–8 seconds duration >= 5 AND duration <= 8 Example – requests that completed successfully in less than 3 seconds, including all downstream calls ok !partial duration <3 Example – enumerated list entity that has an index greater than 5 rootcause.fault.service { index > 5 } Filter expressions 35 A... |
xray-guide-014 | xray-guide.pdf | 14 | keyword. • edge(source, destination) {filter} – Connection between services source and destination. Optional curly braces can contain a filter expression that applies to segments on this connection. • annotation[key] – Value of an annotation with field key. The value of an annotation can be a Boolean, number, or string, ... |
xray-guide-015 | xray-guide.pdf | 15 | Requests that include an error on a service named random-name with type AWS::Lambda::Function. Filter expressions 41 AWS X-Ray Developer Guide service(id(name: "random-name", type: "AWS::Lambda::Function")) { error } To search for nodes by type, you can also exclude the name entirely. Example – service filter with id fu... |
xray-guide-016 | xray-guide.pdf | 16 | X-Ray Trace Map, and then choosing View traces from the node details pane. The Traces page supports querying by account ID. To get started, enter a query that includes one or more account IDs. The following example queries for traces that have passed through account ID X or Y: service(id(account.id:"X")) OR service(id(... |
xray-guide-017 | xray-guide.pdf | 17 | node or edge on an AWS X-Ray trace map, the X-Ray console shows a latency distribution histogram. Latency Latency is the amount of time between when a request starts and when it completes. A histogram shows a distribution of latencies. It shows duration on the x-axis, and the percentage of requests that match each dura... |
xray-guide-018 | xray-guide.pdf | 18 | "Statement": [ { "Effect": "Allow", "Action": [ "xray:GetInsightSummaries", "xray:GetInsight", "xray:GetInsightEvents", "xray:GetInsightImpactGraph" ], "Resource": [ "*" ] } ] } For more information, see How AWS X-Ray works with IAM. Insights 54 AWS X-Ray Developer Guide Enable insights notifications With insights notifi... |
xray-guide-019 | xray-guide.pdf | 19 | client experience for the entire group. This experience is calculated based on percentages of the following states: Fault, Error, Throttle, and Okay. This example shows an increase in traces with a fault at the root node during the time of an incident. Incidents in downstream services don't always correspond to an incr... |
xray-guide-020 | xray-guide.pdf | 20 | expressions you apply to the main search bar refine and update the retrieved traces. A toggle to compare the active group against the retrieved traces. To compare the data related to the group against any active filters, choose Show in charts. To remove this view from the charts, choose Hide from charts. Through interact... |
xray-guide-021 | xray-guide.pdf | 21 | traces of interest to determine what is damaging the health of your service. Observe faults on the service graph The trace map indicates the health of each node by coloring it based on the ratio of successful calls to errors and faults. When you see a percentage of red on your node, it signals a fault. Use the X- Ray A... |
xray-guide-022 | xray-guide.pdf | 22 | • Apply a group • Edit a group • Clone a group • Delete a group • View group metrics in Amazon CloudWatch Groups 68 AWS X-Ray Create a group Note Developer Guide You can now configure X-Ray groups from within the Amazon CloudWatch console. You can also continue to use the X-Ray console. CloudWatch console 1. Sign in to ... |
xray-guide-023 | xray-guide.pdf | 23 | 5. Although you can't rename a group, you can update the filter expression. For more information about how to build a filter expression, see Using filter expressions. In the following example, the group filters for fault traces from the service api.example.com, where the request URL address contains example/game, and respo... |
xray-guide-024 | xray-guide.pdf | 24 | menu. Groups 74 AWS X-Ray Developer Guide 4. On the Create group page, the name of the group is group-name-clone. Optionally, enter a new name for the group. A group name can have a maximum of 32 characters, and contain alphanumeric characters and dashes. Group names are case sensitive. 5. You can keep the filter expres... |
xray-guide-025 | xray-guide.pdf | 25 | latest X-Ray SDK. Customizing sampling rules By customizing sampling rules, you can control the amount of data that you record. You can also modify sampling behavior without modifying or redeploying your code. Sampling rules tell the X- Ray SDK how many requests to record for a set of criteria. By default, the X-Ray SD... |
xray-guide-026 | xray-guide.pdf | 26 | the appropriate plugin: • AWS::ElasticBeanstalk::Environment – An AWS Elastic Beanstalk environment (plugin). • AWS::EC2::Instance – An Amazon EC2 instance (plugin). • AWS::ECS::Container – An Amazon ECS container (plugin). • AWS::APIGateway::Stage – An Amazon API Gateway stage. • AWS::AppSync::GraphQLAPI – An AWS AppS... |
xray-guide-027 | xray-guide.pdf | 27 | rules based on priority, and borrow from the reservoir when a request matches a rule for which X-Ray has not yet assigned the service a quota. For more detail about how a service uses the API for sampling, see Using sampling rules with the X-Ray API. When the X-Ray SDK calls sampling APIs, it uses the X-Ray daemon as a... |
xray-guide-028 | xray-guide.pdf | 28 | for other AWS services. The following functions are versions of the API operations listed previously with a simpler format: • put-trace-segments – Uploads segment documents to X-Ray. Use the X-Ray API 86 AWS X-Ray Developer Guide • batch-get-traces – Retrieves a list of traces in a list of trace IDs. Each retrieved tra... |
xray-guide-029 | xray-guide.pdf | 29 | ./bin/trace-urls.sh [ "http://scorekeep.elasticbeanstalk.com/api/game/6Q0UE1DG/5FGLM9U3/ endtime/1479069438", "http://scorekeep.elasticbeanstalk.com/api/session/KH4341QH", "http://scorekeep.elasticbeanstalk.com/api/game/GLQBJ3K5/153AHDIA", "http://scorekeep.elasticbeanstalk.com/api/game/VPDL672J/G2V41HM6/ endtime/14790... |
xray-guide-030 | xray-guide.pdf | 30 | import binascii START_TIME = time.time() HEX=hex(int(START_TIME))[2:] TRACE_ID="1-{}-{}".format(HEX, binascii.hexlify(os.urandom(12)).decode('utf-8')) Bash START_TIME=$(date +%s) HEX_TIME=$(printf '%x\n' $START_TIME) GUID=$(dd if=/dev/random bs=12 count=1 2>/dev/null | od -An -tx1 | tr -d ' \t\n') TRACE_ID="1-$HEX_TIME... |
xray-guide-031 | xray-guide.pdf | 31 | { Developer Guide "ReferenceId": 1, "Name": "awseb-e-dixzws4s9p-stack-StartupSignupsTable-4IMSMHAYX2BA", "Names": [ "awseb-e-dixzws4s9p-stack-StartupSignupsTable-4IMSMHAYX2BA" ], "Type": "AWS::DynamoDB::Table", "State": "unknown", "StartTime": 1528317583.0, "EndTime": 1528317589.0, "Edges": [], "SummaryStatistics": { "... |
xray-guide-032 | xray-guide.pdf | 32 | x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36", "HttpMethod": "POST" }, "Users": [ { "UserName": "5M388M1E" } ], "HasFault": false, "Annotations": { "UserID": [ { "AnnotationValue": { "StringValue": "5M388M1E" } } ], "Name": [ { "AnnotationValue": { Getting data 105 AWS X-Ray Developer ... |
xray-guide-033 | xray-guide.pdf | 33 | Refer to the Filter Expressions chapter for more details about querying with filter expressions. Example Example JSON filter rootcause.json = #[{ "Services": [ { "Name": "GetWeatherData", "EntityPath": [{ "Name": "GetWeatherData" }, { "Name": "get_temperature" } ] }, { "Name": "GetTemperature", "EntityPath": [ { "Name": ... |
xray-guide-034 | xray-guide.pdf | 34 | "Version": 1, "Attributes": {} }, "CreatedAt": 1530574399.0, "ModifiedAt": 1530574399.0 } Configuration 115 AWS X-Ray Developer Guide } $ aws xray create-sampling-rule --cli-input-json file://9000-base-scorekeep.json { "SamplingRuleRecord": { "SamplingRule": { "RuleName": "base-scorekeep", "RuleARN": "arn:aws:xray:us-ea... |
xray-guide-035 | xray-guide.pdf | 35 | requests. The fixed rate is a decimal between 0 and 1.00 (100%). The following example shows a call to GetSamplingTargets with details about sampling decisions made over the last 10 seconds. $ aws xray get-sampling-targets --sampling-statistics-documents '[ { "RuleName": "base-scorekeep", "ClientID": "ABCDEF1234567890AB... |
xray-guide-036 | xray-guide.pdf | 36 | 250 characters) unless noted otherwise. Required Segment Fields • name – The logical name of the service that handled the request, up to 200 characters. For example, your application's name or domain name. Names can contain Unicode letters, numbers, and whitespace, and the following symbols: _, ., :, /, %, &, #, =, +, ... |
xray-guide-037 | xray-guide.pdf | 37 | error, throttle, fault, and cause – error fields that indicate an error occurred and that include information about the exception that caused the error. • annotations – annotations object with key-value pairs that you want X-Ray to index for search. • metadata – metadata object with any additional data that you want to ... |
xray-guide-038 | xray-guide.pdf | 38 | the subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify an end_time or in_progress. • in_progress – boolean that is set to true instead of specifying an end_time to record that a subsegment is started, but is not complete. Only send one complete subsegment, and one or zero in-progress subseg... |
xray-guide-039 | xray-guide.pdf | 39 | { "id": "6b55dcc497934f1a", "start_time": 1484789387.126, "end_time": 1484789387.535, "trace_id": "1-5880168b-fd5158284b67678a3bb5a78c", "name": "www.example.com", "origin": "AWS::EC2::Instance", "aws": { "ec2": { "availability_zone": "us-west-2c", Segment documents 131 AWS X-Ray Developer Guide "instance_id": "i-0b5a4... |
xray-guide-040 | xray-guide.pdf | 40 | an Elastic Beanstalk environment. You can find this information in a file named /var/elasticbeanstalk/xray/environment.conf on the latest Elastic Beanstalk platforms. • environment_name – The name of the environment. • version_label – The name of the application version that is currently deployed to the instance that ser... |
xray-guide-041 | xray-guide.pdf | 41 | If available, record information about the call stack in stackFrame objects. stackFrame All fields are optional. • path – The relative path to the file. • line – The line in the file. • label – The function or method name. Segment documents 139 AWS X-Ray SQL queries Developer Guide You can create subsegments for queries t... |
xray-guide-042 | xray-guide.pdf | 42 | is also instrumented, the segment that it sends replaces the inferred segment generated from the upstream client's subsegment. The node on the service graph always uses information from the service's segment, if it's available, while the edge between the two nodes uses the upstream service's subsegment. For example, wh... |
xray-guide-043 | xray-guide.pdf | 43 | on properties of the service or request. For example, you might want to disable sampling and trace all requests for calls that modify state or handle users or transactions. For high-volume read-only calls, like background polling, health checks, or connection maintenance, you can sample at a low rate and still get enou... |
xray-guide-044 | xray-guide.pdf | 44 | and metadata in the segment or subsegment details window, within the Trace details page in the CloudWatch console. Errors, faults, and exceptions X-Ray tracks errors that occur in your application code, and errors that are returned by downstream services. Errors are categorized as follows. • Error – Client errors (400 ... |
xray-guide-045 | xray-guide.pdf | 45 | aws/xray – Use the AWS managed key. Developer Guide • key alias – Use a customer managed key in your account. • Manually enter a key ARN – Use a customer managed key in a different account. Enter the full Amazon Resource Name (ARN) of the key in the field that appears. 7. Choose Update encryption. X-Ray console To configu... |
xray-guide-046 | xray-guide.pdf | 46 | Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method... |
xray-guide-047 | xray-guide.pdf | 47 | identities 159 AWS X-Ray Developer Guide • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a res... |
xray-guide-048 | xray-guide.pdf | 48 | get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on w... |
xray-guide-049 | xray-guide.pdf | 49 | programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow... |
xray-guide-050 | xray-guide.pdf | 50 | that begin with the word Get, include the following action: "Action": "xray:Get*" To see a list of X-Ray actions, see Actions Defined by AWS X-Ray in the IAM User Guide. Resources Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, a... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.