topic list and itemized list formatting

awsdocs · Mar 22, 2018 · 7a250b9 · 7a250b9
1 parent 031fb20
commit 7a250b9
Show file tree

Hide file tree

Showing 66 changed files with 113 additions and 522 deletions.
diff --git a/doc-source/aws-xray.md b/doc-source/aws-xray.md
@@ -5,11 +5,8 @@ AWS X\-Ray is a service that collects data about requests that your application
 ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/xray/latest/devguide/images/scorekeep-PUTrules-timeline.png)
 
 The X\-Ray SDK provides: 
-
 + **Interceptors** to add to your code to trace incoming HTTP requests
-
 + **Client handlers** to instrument AWS SDK clients that your application uses to call other AWS services
-
 + An **HTTP client** to use to instrument calls to other internal and external HTTP web services
 
 The SDK also supports instrumenting calls to SQL databases, automatic AWS SDK client instrumentation, and other features\.

diff --git a/doc-source/index.md b/doc-source/index.md
@@ -78,6 +78,7 @@ Amazon's trademarks and trade dress may not be used in
    + [Tracing Incoming Requests with the X-Ray SDK for Python Middleware](xray-sdk-python-middleware.md)
    + [Patching Libraries to Instrument Downstream Calls](xray-sdk-python-patching.md)
    + [Tracing AWS SDK Calls with the X-Ray SDK for Python](xray-sdk-python-awssdkclients.md)
+   + [Tracing Calls to Downstream HTTP Web Services Using the X-Ray SDK for Python](xray-sdk-python-httpclients.md)
    + [Generating Custom Subsegments with the X-Ray SDK for Python](xray-sdk-python-subsegments.md)
    + [Add Annotations and Metadata to Segments with the X-Ray SDK for Python](xray-sdk-python-segment.md)
 + [AWS X-Ray SDK for Ruby](xray-sdk-ruby.md)

diff --git a/doc-source/scorekeep-ecs.md b/doc-source/scorekeep-ecs.md
@@ -3,11 +3,8 @@
 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\.
 
 The project includes three Dockerfiles that define container images for the API, front end, and X\-Ray daemon components\.
-
 + `/Dockerfile` – The Scorekeep API\.
-
 + `/scorekeep-frontend/Dockerfile` – The Angular web app client, and the nginx proxy that routes incoming traffic\.
-
 + `/xray-daemon/Dockerfile` – The X\-Ray daemon\.
 
 The X\-Ray daemon Dockerfile creates an image based on Amazon Linux that runs the X\-Ray daemon\.

diff --git a/doc-source/scorekeep-lambda.md b/doc-source/scorekeep-lambda.md
@@ -9,7 +9,7 @@ The second function, `scorekeep-worker`, is a Python function that runs independ
 
 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\.
 
-
+**Topics**
 + [Random Name](#scorekeep-lambda-randomname)
 + [Worker](#scorekeep-lambda-worker)
 

diff --git a/doc-source/xray-api-gettingdata.md b/doc-source/xray-api-gettingdata.md
@@ -2,7 +2,7 @@
 
 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\.
 
-
+**Topics**
 + [Retrieving the Service Graph](#xray-api-servicegraph)
 + [Retrieving Traces](#xray-api-traces)
 
@@ -137,9 +137,11 @@ $ aws xray batch-get-traces --trace-ids 1-596025b4-7170afe49f7aa708b1dd4a6b
 }
 ```
 
-The full trace includes a document for each segment, compiled from all of the segment documents received with the same trace ID\.
+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)\.
+
+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\.
 
-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\.
+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\.
 
 **Example Script to get full traces for a one minute period**