AWS AmazonCloudWatch documentation change
Summary
Restructured documentation by removing detailed enablement steps and adding topic links
Security assessment
Changes involve documentation restructuring and moving implementation details to another page, with no security-related content added or modified
Diff
diff --git a/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search-getting-started.md b/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search-getting-started.md index 192855993..97d4ebbec 100644 --- a//AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search-getting-started.md +++ b//AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search-getting-started.md @@ -5 +5 @@ -PrerequisitesEnabling Transaction Search in the consoleEnabling Transaction Search with the API +Prerequisites @@ -10,0 +11,9 @@ If you send traces to X-Ray, you can enable Transaction Search in the CloudWatch +###### Topics + + * Prerequisites + + * [Enable transaction search](./Enable-Lambda-TransactionSearch.html) + + + + @@ -86,110 +94,0 @@ To use Transaction Search and other CloudWatch features, add the [CloudWatchRead -## Enabling Transaction Search in the console - -The following procedure describes how to enable Transaction Search in the console. - -###### To enable Transaction Search in the CloudWatch console - - 1. Open the CloudWatch console at [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/). - - 2. From the navigation pane, under **Application Signals** , choose **Transaction Search**. - - 3. Choose **Enable Transaction Search**. - - 4. Select the box to ingest spans as structured logs, and enter a percentage of spans to be indexed. You can index spans at 1% for free and change the percentage later based on your requirements. - - - - -## Enabling Transaction Search with the API - -The following procedure describes how to enable Transaction Search with API. - -### Step 1. Create a policy that grants access to ingest spans in CloudWatch Logs - -When using the AWS CLI or SDK to enable Transaction Search, you must configure permissions using a resource-based policy with [`PutResourcePolicy`](https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html). - -###### Example policy - -The following example policy allows X-Ray to send traces to CloudWatch Logs - - - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "TransactionSearchXRayAccess", - "Effect": "Allow", - "Principal": { - "Service": "xray.amazonaws.com" - }, - "Action": "logs:PutLogEvents", - "Resource": [ - "arn:partition:logs:region:account-id:log-group:aws/spans:*", - "arn:partition:logs:region:account-id:log-group:/aws/application-signals/data:*" - ], - "Condition": { - "ArnLike": { - "aws:SourceArn": "arn:partition:xray:region:account-id:*" - }, - "StringEquals": { - "aws:SourceAccount": "account-id" - } - } - } - ] - } - -###### Example command - -The following example shows how to format your AWS CLI command with `PutResourcePolicy`. - - - aws logs put-resource-policy --policy-name MyResourcePolicy --policy-document '{ "Version": "2012-10-17", "Statement": [ { "Sid": "TransactionSearchXRayAccess", "Effect": "Allow", "Principal": { "Service": "xray.amazonaws.com" }, "Action": "logs:PutLogEvents", "Resource": [ "arn:partition:logs:region:account-id:log-group:aws/spans:*", "arn:partition:logs:region:account-id:log-group:/aws/application-signals/data:*" ], "Condition": { "ArnLike": { "aws:SourceArn": "arn:partition:logs:region:account-id:*" }, "StringEquals": { "aws:SourceAccount": "account-id" } } } ]}' - -### Step 2. Configure the destination of trace segments - -Configure the ingestion of spans with [`UpdateTraceSegmentDestination`](https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html). - -###### Example command - -The following example shows how to format your AWS CLI command with `UpdateTraceSegmentDestination`. - - - aws xray update-trace-segment-destination --destination CloudWatchLogs - -### Step 3. Configure the amount of spans to index - -Configure your desired sampling percentage with [`UpdateIndexingRule`](https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html) - -###### Example command - -The following example shows how to format your AWS CLI command with `UpdateIndexingRule`. - - - aws xray update-indexing-rule --name "Default" --rule '{"Probabilistic": {"DesiredSamplingPercentage": number}}' - -###### Note - -After you enable Transaction Search, it can take ten minutes for spans to become available for search and analysis. - -### Step 4. Verify spans are available for search and analysis - -To verify spans are available for search and analysis, use [`GetTraceSegmentDestination`](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html). - -###### Example commands - -The following example shows how to format your AWS CLI command with `GetTraceSegmentDestination`. - - - aws xray get-trace-segment-destination - -###### Example response - -The following example shows the response you can expect when Transaction Search is active. - - - { - "Destination": "CloudWatchLogs", - "Status": "ACTIVE" - } - @@ -204 +103 @@ Transaction Search -The span log group +Enable transaction search