Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

Commit 7a250b9

Browse files
committed
topic list and itemized list formatting
1 parent 031fb20 commit 7a250b9

File tree

66 files changed

+113
-522
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+113
-522
lines changed

doc-source/aws-xray.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@ AWS X\-Ray is a service that collects data about requests that your application
55
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/xray/latest/devguide/images/scorekeep-PUTrules-timeline.png)
66

77
The X\-Ray SDK provides:
8-
98
+ **Interceptors** to add to your code to trace incoming HTTP requests
10-
119
+ **Client handlers** to instrument AWS SDK clients that your application uses to call other AWS services
12-
1310
+ An **HTTP client** to use to instrument calls to other internal and external HTTP web services
1411

1512
The SDK also supports instrumenting calls to SQL databases, automatic AWS SDK client instrumentation, and other features\.

doc-source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Amazon's trademarks and trade dress may not be used in
7878
+ [Tracing Incoming Requests with the X-Ray SDK for Python Middleware](xray-sdk-python-middleware.md)
7979
+ [Patching Libraries to Instrument Downstream Calls](xray-sdk-python-patching.md)
8080
+ [Tracing AWS SDK Calls with the X-Ray SDK for Python](xray-sdk-python-awssdkclients.md)
81+
+ [Tracing Calls to Downstream HTTP Web Services Using the X-Ray SDK for Python](xray-sdk-python-httpclients.md)
8182
+ [Generating Custom Subsegments with the X-Ray SDK for Python](xray-sdk-python-subsegments.md)
8283
+ [Add Annotations and Metadata to Segments with the X-Ray SDK for Python](xray-sdk-python-segment.md)
8384
+ [AWS X-Ray SDK for Ruby](xray-sdk-ruby.md)

doc-source/scorekeep-ecs.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@
33
In the [https://github.com/awslabs/eb-java-scorekeep/tree/xray-ecs](https://github.com/awslabs/eb-java-scorekeep/tree/xray-ecs) branch, the Scorekeep sample application shows how to instrument an application running in Amazon Elastic Container Service \(Amazon ECS\)\. The branch provides scripts and configuration files for creating, uploading, and running Docker images in a Multicontainer Docker environment in AWS Elastic Beanstalk\.
44

55
The project includes three Dockerfiles that define container images for the API, front end, and X\-Ray daemon components\.
6-
76
+ `/Dockerfile` – The Scorekeep API\.
8-
97
+ `/scorekeep-frontend/Dockerfile` – The Angular web app client, and the nginx proxy that routes incoming traffic\.
10-
118
+ `/xray-daemon/Dockerfile` – The X\-Ray daemon\.
129

1310
The X\-Ray daemon Dockerfile creates an image based on Amazon Linux that runs the X\-Ray daemon\.

doc-source/scorekeep-lambda.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The second function, `scorekeep-worker`, is a Python function that runs independ
99

1010
Scorekeep includes AWS CloudFormation templates and scripts to create both functions\. Because you need to bundle the X\-Ray SDK with the function code, the templates create the functions without any code\. When you deploy Scorekeep, a configuration file included in the `.ebextensions` folder creates a source bundle that includes the SDK, and updates the function code and configuration with the AWS Command Line Interface\.
1111

12-
12+
**Topics**
1313
+ [Random Name](#scorekeep-lambda-randomname)
1414
+ [Worker](#scorekeep-lambda-worker)
1515

doc-source/xray-api-gettingdata.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
AWS X\-Ray processes the trace data that you send to it to generate full traces, trace summaries, and service graphs in JSON\. You can retrieve the generated data directly from the API with the AWS CLI\.
44

5-
5+
**Topics**
66
+ [Retrieving the Service Graph](#xray-api-servicegraph)
77
+ [Retrieving Traces](#xray-api-traces)
88

@@ -137,9 +137,11 @@ $ aws xray batch-get-traces --trace-ids 1-596025b4-7170afe49f7aa708b1dd4a6b
137137
}
138138
```
139139

140-
The full trace includes a document for each segment, compiled from all of the segment documents received with the same trace ID\.
140+
The full trace includes a document for each segment, compiled from all of the segment documents received with the same trace ID\. These documents don't represent the data as it was sent to X\-Ray by your application\. Instead, they represent the processed documents generated by the X\-Ray service\. X\-Ray creates the full trace document by compiling segment documents sent by your application, and removing data that doesn't comply with the [segment document schema](xray-api-segmentdocuments.md)\.
141+
142+
X\-Ray also creates *inferred segments* for downstream calls to services that don't send segments themselves\. For example, when you call DynamoDB with an instrumented client, the X\-Ray SDK records a subsegment with details about the call from its point of view\. However, DynamoDB doesn't send a corresponding segment\. X\-Ray uses the information in the subsegment to create an inferred segment to represent the DynamoDB resource in the service map, and adds it to the trace document\.
141143

142-
You can use a query on the output of `get-trace-summaries` to get just a list of IDs\. Redirect the list to the intput of `batch-get-traces` to get full traces for a specific time period\.
144+
To get multiple traces from the API, you need a list of trace IDs, which you can extract from the output of `get-trace-summaries` with an [AWS CLI query](http://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html#controlling-output-filter)\. Redirect the list to the intput of `batch-get-traces` to get full traces for a specific time period\.
143145

144146
**Example Script to get full traces for a one minute period**
145147

0 commit comments

Comments
 (0)