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

Commit 738201c

Browse files
committed
Periodic Update
1 parent d359c52 commit 738201c

8 files changed

+26
-25
lines changed

doc-source/security-iam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Resource\-based policies are JSON policy documents that you attach to a resource
7575

7676
### Access Control Lists \(ACLs\)<a name="security_iam_access-manage-acl"></a>
7777

78-
Access control policies \(ACLs\) control which principals \(account members, users, or roles\) have permissions to access a resource\. ACLs are similar to resource\-based policies, although they are the only policy type that does not use the JSON policy document format\. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs\. To learn more about ACLs, see [Access Control List \(ACL\) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon Simple Storage Service Developer Guide*\.
78+
Access control lists \(ACLs\) are a type of policy that controls which principals \(account members, users, or roles\) have permissions to access a resource\. ACLs are similar to resource\-based policies, although they do not use the JSON policy document format\. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs\. To learn more about ACLs, see [Access Control List \(ACL\) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon Simple Storage Service Developer Guide*\.
7979

8080
### Other Policy Types<a name="security_iam_access-manage-other-policies"></a>
8181

doc-source/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Security in AWS X\-Ray<a name="security"></a>
22

3-
## <a name="w15aac14b3"></a>
3+
## <a name="w16aac14b3"></a>
44

55
Cloud security at AWS is the highest priority\. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security\-sensitive organizations\.
66

doc-source/xray-console-analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The X\-Ray Analytics console uses the following key features for grouping, filte
1717

1818
| Feature | Description |
1919
| --- | --- |
20-
| **Groups** | The initial selected group is `Default`\. To change the retrieved group, select a different group from the menu to the right of the main filter expression search bar\. To learn more about groups see, [Using Filter Expressions with Groups](https://docs.aws.amazon.com/xray/latest/devguide//xray-console-filters.html#groups)\. |
20+
| **Groups** | The initial selected group is `Default`\. To change the retrieved group, select a different group from the menu to the right of the main filter expression search bar\. To learn more about groups see, [Using Filter Expressions with Groups](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html#groups)\. |
2121
| **Retrieved traces** | By default, the Analytics console generates graphs based on all traces in the selected group\. Retrieved traces represent all traces in your working set\. You can find the trace count in this tile\. Filter expressions you apply to the main search bar refine and update the retrieved traces\. |
2222
| **Show in charts/Hide from charts** | 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**\. |
2323
| **Filtered trace set A** | Through interactions with the graphs and tables, apply filters to create the criteria for trace set A\. As the filters are applied, the number of applicable traces and the percentage of traces from the total that are retrieved are calculated within this tile\. Filters populate as tags within the trace set A tile and can also be removed from the tile\. |

doc-source/xray-console-encryption.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
# Data Protection in AWS X\-Ray<a name="xray-console-encryption"></a>
22

3-
AWS X\-Ray always encrypts traces and related data at rest\. If you need to audit and disable encryption keys for compliance or internal requirements, you can configure X\-Ray to use an AWS Key Management Service \(AWS KMS\) customer master key \(CMK\) to encrypt data\.
3+
AWS X\-Ray always encrypts traces and related data at rest\. When you need to audit and disable encryption keys for compliance or internal requirements, you can configure X\-Ray to use an AWS Key Management Service \(AWS KMS\) customer master key \(CMK\) to encrypt data\.
44

5-
X\-Ray provides an AWS managed CMK named `aws/xray`\. Use this key if you just want to [audit key usage in AWS CloudTrail](https://docs.aws.amazon.com/kms/latest/developerguide/logging-using-cloudtrail.html) and don't need to manage the key itself\. If you need to manage access to the key or configure key rotation, you can [create a customer managed CMK](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\.
5+
X\-Ray provides an AWS managed CMK named `aws/xray`\. Use this key when you just want to [audit key usage in AWS CloudTrail](https://docs.aws.amazon.com/kms/latest/developerguide/logging-using-cloudtrail.html) and don't need to manage the key itself\. When you need to manage access to the key or configure key rotation, you can [create a customer managed CMK](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\.
6+
7+
When you change encryption settings, X\-Ray spends some time generating and propagating data keys\. While the new key is being processed, X\-Ray may encrypt data with a combination of the new and old settings\. Existing data is not re\-encrypted when you change encryption settings\.
8+
9+
**Note**
10+
AWS KMS charges when X\-Ray uses a CMK to encrypt or decrypt trace data\.
11+
**Default encryption** – Free\.
12+
**AWS managed CMK** – Pay for key use\.
13+
**Customer managed CMK** – Pay for key storage and use\.
14+
See [AWS Key Management Service Pricing](https://aws.amazon.com/kms/pricing/) for details\.
615

716
You must have user\-level access to a customer managed CMK to configure X\-Ray to use it, and to then view encrypted traces\. See [User Permissions for Encryption](security_iam_service-with-iam.md#xray-permissions-encryption) for more information\.
817

@@ -23,15 +32,6 @@ X\-Ray does not support asymmetric CMKs\.
2332

2433
1. Choose **Apply**\.
2534

26-
When you change encryption settings, X\-Ray spends some time generating and propagating data keys\. While the new key is being processed, X\-Ray may encrypt data with a combination of the new and old settings\. Existing data is not re\-encrypted when you change encryption settings\.
27-
28-
**Note**
29-
AWS KMS charges when X\-Ray uses a CMK to encrypt or decrypt trace data\.
30-
**Default encryption** – Free\.
31-
**AWS managed CMK** – Pay for key use\.
32-
**Customer managed CMK** – Pay for key storage and use\.
33-
See [AWS Key Management Service Pricing](https://aws.amazon.com/kms/pricing/) for details\.
34-
3535
If X\-Ray is unable to access your encryption key, it stops storing data\. This can happen if your user loses access to the CMK, or if you disable a key that's currently in use\. When this happens, X\-Ray shows a notification in the navigation bar\.
3636

3737
To configure encryption settings with the X\-Ray API, see [Configuring Sampling, Groups, and Encryption Settings with the AWS X\-Ray API](xray-api-configuration.md)\.

doc-source/xray-sdk-nodejs-sqlclients.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,23 @@ Instrument SQL database queries by wrapping your SQL client in the corresponding
1919

2020
When you use an instrumented client to make SQL queries, the X\-Ray SDK for Node\.js records information about the connection and query in a subsegment\.
2121

22-
## Including Additional Data in SQL Subsegments
22+
## Including Additional Data in SQL Subsegments<a name="xray-sdk-nodejs-sqlclients-additional"></a>
2323

24-
You can add additional information to subsegments generated for SQL queries as long as it's mapped to a whitelisted SQL field. For example, to record the sanitized SQL query string in a subsegment, you can add it directly to the subsegment's SQL object.
24+
You can add additional information to subsegments generated for SQL queries, as long as it's mapped to a whitelisted SQL field\. For example, to record the sanitized SQL query string in a subsegment, you can add it directly to the subsegment's SQL object\.
25+
26+
**Example Assign SQL to Sugsegment**
2527

2628
```
27-
const queryString = 'SELECT * FROM MyTable';
29+
const queryString = 'SELECT * FROM MyTable';
2830
connection.query(queryString, ...);
2931
3032
// Retrieve the most recently created subsegment
3133
const subs = AWSXRay.getSegment().subsegments;
3234
33-
if (subs && subs.length > 0) {
35+
if (subs & & subs.length > 0) {
3436
var sqlSub = subs[subs.length - 1];
3537
sqlSub.sql.sanitized_query = queryString;
3638
}
37-
3839
```
3940

40-
For a full list of whitelisted SQL fields, see [SQL Queries](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html#api-segmentdocuments-sql).
41+
For a full list of whitelisted SQL fields, see [SQL Queries](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html#api-segmentdocuments-sql) in the *AWS X\-Ray Developer Guide*\.

doc-source/xray-sdk-python-serverless.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This tutorial develops an example serverless application that is deployed to Lam
1414

1515
## Prerequisites<a name="xray-sdk-python-serverless-prereqs"></a>
1616
+ [Zappa](https://github.com/Miserlou/Zappa)
17-
+ [Python](https://docs.aws.amazon.com/xray/latest/devguide//xray-sdk-python.html) – Version 2\.7 or 3\.6\.
17+
+ [Python](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python.html) – Version 2\.7 or 3\.6\.
1818
+ [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) – Verify that your AWS CLI is configured with the account and AWS Region in which you will deploy your application\.
1919
+ [Pip](https://pypi.org/project/pip/)
2020
+ [Virtualenv](https://virtualenv.pypa.io/en/latest/)
@@ -167,7 +167,7 @@ In this step you will interact with the API Gateway console to enable X\-Ray tra
167167

168168
## Step 4: View the Created Trace<a name="xray-sdk-python-serverless-trace"></a>
169169

170-
In this step you will interact with the X\-Ray console to view the trace created by the example application\. For a more detailed walkthrough on trace analysis, see [Viewing the Service Map](https://docs.aws.amazon.com/xray/latest/devguide//xray-console.html#xray-console-servicemap)\.
170+
In this step you will interact with the X\-Ray console to view the trace created by the example application\. For a more detailed walkthrough on trace analysis, see [Viewing the Service Map](https://docs.aws.amazon.com/xray/latest/devguide/xray-console.html#xray-console-servicemap)\.
171171

172172
1. Sign in to the AWS Management Console and open the X\-Ray console at [https://console\.aws\.amazon\.com/xray/home](https://console.aws.amazon.com/xray/home)\.
173173

doc-source/xray-services-appmesh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Amazon EC2 and AWS App Mesh<a name="xray-services-appmesh"></a>
22

3-
AWS X\-Ray integrates with [AWS App Mesh](https://docs.aws.amazon.com//app-mesh/latest/userguide/what-is-app-mesh.html) to manage Envoy proxies for microservices\. App Mesh provides a version of Envoy that you can configure to send trace data to the X\-Ray daemon running in a container of the same task or pod\. X\-Ray supports tracing with the following App Mesh compatible services:
3+
AWS X\-Ray integrates with [AWS App Mesh](https://docs.aws.amazon.com/app-mesh/latest/userguide/what-is-app-mesh.html) to manage Envoy proxies for microservices\. App Mesh provides a version of Envoy that you can configure to send trace data to the X\-Ray daemon running in a container of the same task or pod\. X\-Ray supports tracing with the following App Mesh compatible services:
44
+ Amazon Elastic Container Service \(Amazon ECS\)
55
+ Amazon Elastic Kubernetes Service \(Amazon EKS\)
66
+ Amazon Elastic Compute Cloud \(Amazon EC2\)
@@ -9,7 +9,7 @@ Use the following instructions to learn how to enable X\-Ray tracing through App
99

1010
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/xray/latest/devguide/images/appmesh-traceContents.png)
1111

12-
To configure the Envoy proxy to send data to X\-Ray, set the `ENABLE_ENVOY_XRAY_TRACING` [environment variable](https://docs.aws.amazon.com//app-mesh/latest/userguide/envoy.html#envoy-config) in its container definition\.
12+
To configure the Envoy proxy to send data to X\-Ray, set the `ENABLE_ENVOY_XRAY_TRACING` [environment variable](https://docs.aws.amazon.com/app-mesh/latest/userguide/envoy.html#envoy-config) in its container definition\.
1313

1414
**Example Envoy Container Definition for Amazon ECS**
1515

doc-source/xray-services-sqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Amazon SQS supports the following tracing header instrumentation:
1010

1111
When running on Amazon EC2, Amazon SQS supports processing one message at a time\. This applies when running on an on\-premises host, and when using container services, such as AWS Fargate, Amazon ECS, or AWS App Mesh\.
1212

13-
The trace header is excluded from both Amazon SQS message size and message attribute limits\. Enabling X\-Ray tracing will not exceed your Amazon SQS limits\. To learn more about AWS limits, see [Amazon SQS Limits](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html)\.
13+
The trace header is excluded from both Amazon SQS message size and message attribute quoatas\. Enabling X\-Ray tracing will not exceed your Amazon SQS quotas\. To learn more about AWS quotas, see [Amazon SQS Quotas](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html)\.
1414

1515
## Send the HTTP Trace Header<a name="xray-services-sqs-sending"></a>
1616

0 commit comments

Comments
 (0)