# 트랜잭션 검색 활성화
콘솔 또는 API를 사용하여 [트랜잭션 검색](CloudWatch-Transaction-Search.md)을 활성화할 수 있습니다. 트랜잭션 검색은 전체 계정에 대해 구성되며, X-Ray를 통한 모든 스팬 수집을 [Amazon CloudWatch 요금](https://aws.amazon.com/cloudwatch/pricing/)을 사용하는 비용 효율적인 수집 모드로 전환합니다. 기본적으로 수집된 스팬의 1%를 분석용 트레이스 요약으로 무료로 인덱싱합니다. 이는 트랜잭션 검색을 통해 수집된 모든 스팬에 대한 전체 트레이스 가시성이 이미 있는 경우 일반적으로 충분합니다.
## 사전 조건
트랜잭션 검색을 활성화하려면 먼저 다음 권한을 가진 역할을 생성해야 합니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "TransactionSearchXRayPermissions",
"Effect": "Allow",
"Action": [
"xray:GetTraceSegmentDestination",
"xray:UpdateTraceSegmentDestination",
"xray:GetIndexingRules",
"xray:UpdateIndexingRule"
],
"Resource": "*"
},
{
"Sid": "TransactionSearchLogGroupPermissions",
"Effect": "Allow",
"Action": [
"logs:CreateLogGroup",
"logs:CreateLogStream",
"logs:PutRetentionPolicy"
],
"Resource": [
"arn:aws:logs:*:*:log-group:/aws/application-signals/data:*",
"arn:aws:logs:*:*:log-group:aws/spans:*"
]
},
{
"Sid": "TransactionSearchLogsPermissions",
"Effect": "Allow",
"Action": [
"logs:PutResourcePolicy",
"logs:DescribeResourcePolicies"
],
"Resource": "*"
},
{
"Sid": "TransactionSearchApplicationSignalsPermissions",
"Effect": "Allow",
"Action": [
"application-signals:StartDiscovery"
],
"Resource": "*"
},
{
"Sid": "CloudWatchApplicationSignalsCreateServiceLinkedRolePermissions",
"Effect": "Allow",
"Action": "iam:CreateServiceLinkedRole",
"Resource": "arn:aws:iam::*:role/aws-service-role/application-signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals",
"Condition": {
"StringLike": {
"iam:AWSServiceName": "application-signals.cloudwatch.amazonaws.com"
}
}
},
{
"Sid": "CloudWatchApplicationSignalsGetRolePermissions",
"Effect": "Allow",
"Action": "iam:GetRole",
"Resource": "arn:aws:iam::*:role/aws-service-role/application-signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals"
},
{
"Sid": "CloudWatchApplicationSignalsCloudTrailPermissions",
"Effect": "Allow",
"Action": [
"cloudtrail:CreateServiceLinkedChannel"
],
"Resource": "arn:aws:cloudtrail:*:*:channel/aws-service-channel/application-signals/*"
}
]
}
```
------
**참고**
트랜잭션 검색 및 기타 CloudWatch 기능을 사용하려면 역할에 [CloudWatchReadOnlyAccess 정책](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/CloudWatchReadOnlyAccess.html)을 추가합니다. 역할 생성에 대한 자세한 내용은 [IAM 역할 생성](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)을 참조하세요.
## 콘솔에서 트랜잭션 검색 활성화
다음 절차에서는 콘솔에서 트랜잭션 검색을 활성화하는 방법을 설명합니다.
**CloudWatch 콘솔에서 트랜잭션 검색을 활성화하려면 다음을 수행합니다.**
1. [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)에서 CloudWatch 콘솔을 엽니다.
1. 탐색 창의 **Application Signals**에서 **트랜잭션 검색**을 선택하세요.
1. **Enable Transaction Search**를 선택합니다.
1. 스팬을 구조화된 로그로서 수집하도록 확인란을 선택하고, 인덱싱할 스팬의 백분율을 입력합니다. 스팬을 1%로 무료로 인덱싱하고 나중에 요구 사항에 따라 비율을 변경할 수 있습니다.
## API를 사용하여 트랜잭션 검색 활성화
다음 절차에서는 API를 사용하여 트랜잭션 검색을 활성화하는 방법을 설명합니다.
### 1단계. CloudWatch Logs의 수집 스팬에 대한 액세스 권한을 부여하는 정책 생성
AWS CLI 또는 SDK를 사용하여 트랜잭션 검색을 활성화할 경우, [https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html](https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html)를 통해 리소스 기반 정책을 사용하여 권한을 구성해야 합니다.
**예제 정책**
다음 예제 정책을 사용하면 X-Ray가 CloudWatch Logs로 트레이스를 전송할 수 있습니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "TransactionSearchXRayAccess",
"Effect": "Allow",
"Principal": {
"Service": "xray.amazonaws.com"
},
"Action": "logs:PutLogEvents",
"Resource": [
"arn:aws:logs:us-east-1:123456789012:log-group:aws/spans:*",
"arn:aws:logs:us-east-1:123456789012:log-group:/aws/application-signals/data:*"
],
"Condition": {
"ArnLike": {
"aws:SourceArn": "arn:aws:xray:us-east-1:123456789012:*"
},
"StringEquals": {
"aws:SourceAccount": "123456789012"
}
}
}
]
}
```
------
**명령 예제**
다음 예제에서는 `PutResourcePolicy`를 사용하여 AWS CLI 명령의 형식을 지정하는 방법을 보여줍니다.
```
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:xray:region:account-id:*" }, "StringEquals": { "aws:SourceAccount": "account-id" } } } ]}'
```
### 2단계. 트레이스 세그먼트의 대상 구성
[https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html](https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html)을 사용하여 스팬 수집을 구성합니다.
**명령 예제**
다음 예제에서는 `UpdateTraceSegmentDestination`을 사용하여 AWS CLI 명령의 형식을 지정하는 방법을 보여줍니다.
```
aws xray update-trace-segment-destination --destination CloudWatchLogs
```
### 3단계. 인덱싱할 스팬의 양 구성
[https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html](https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html)을 사용하여 원하는 샘플링 백분율 구성
**명령 예제**
다음 예제에서는 `UpdateIndexingRule`을 사용하여 AWS CLI 명령의 형식을 지정하는 방법을 보여줍니다.
```
aws xray update-indexing-rule --name "Default" --rule '{"Probabilistic": {"DesiredSamplingPercentage": number}}'
```
**참고**
트랜잭션 검색을 활성화한 후 검색 및 분석에 스팬을 사용할 수 있기까지 10분 정도 소요될 수 있습니다.
### 4단계. 검색 및 분석에 스팬을 사용할 수 있는지 확인
검색 및 분석에 스팬을 사용할 수 있는지 확인하려면 [https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html)을 사용합니다.
**예시 명령**
다음 예제에서는 `GetTraceSegmentDestination`을 사용하여 AWS CLI 명령의 형식을 지정하는 방법을 보여줍니다.
```
aws xray get-trace-segment-destination
```
**응답의 예**
다음 예제는 트랜잭션 검색이 활성화되었을 때 예상 가능한 응답을 보여줍니다.
```
{
"Destination": "CloudWatchLogs",
"Status": "ACTIVE"
}
```
# CloudFormation에서 트랜잭션 검색 사용
CloudFormation를 사용하여 X-Ray 트랜잭션 검색을 활성화하고 구성할 수 있습니다.
**참고**
CloudFormation 스택을 생성하려면 [첫 번째 스택 생성](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/gettingstarted.walkthrough.html)을 참조하세요.
## 사전 조건
+ Amazon EC2, Amazon S3 및 CloudFormation을 사용할 수 있는 권한을 보유한 IAM 사용자 또는 역할이 있는 AWS 계정에 대한 액세스 권한 또는 관리 사용자 액세스 권한이 있어야 합니다.
+ 인터넷에 액세스할 수 있는 가상 프라이빗 클라우드(VPC)가 있어야 합니다. 작업을 단순화하기 위해 계정과 함께 제공되는 기본 VPC를 사용할 수 있습니다. 이 구성에서는 기본 VPC 및 기본 서브넷으로 충분합니다.
+ AWS CDK 또는 CloudFormation 사용을 활성화하기 전에 트랜잭션 검색이 비활성화되어 있는지 확인하세요.
## 트랜잭션 검색 활성화
CloudFormation을 사용하여 트랜잭션 검색을 활성화하려면 다음과 같은 두 가지 리소스를 생성해야 합니다.
+ `AWS::Logs::ResourcePolicy`
+ `AWS::XRay::TransactionSearchConfig`
1. **AWS::Logs::ResourcePolicy 생성** - X-Ray에서 CloudWatch Logs로 트레이스 보내기를 허용하는 리소스 정책 생성
**YAML**
```
Resources:
LogsResourcePolicy:
Type: AWS::Logs::ResourcePolicy
Properties:
PolicyName: TransactionSearchAccess
PolicyDocument: !Sub >
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "TransactionSearchXRayAccess",
"Effect": "Allow",
"Principal": {
"Service": "xray.amazonaws.com"
},
"Action": "logs:PutLogEvents",
"Resource": [
"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:aws/spans:*",
"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/application-signals/data:*"
],
"Condition": {
"ArnLike": {
"aws:SourceArn": "arn:${AWS::Partition}:xray:${AWS::Region}:${AWS::AccountId}:*"
},
"StringEquals": {
"aws:SourceAccount": "${AWS::AccountId}"
}
}
}
]
}
```
**JSON**
```
{
"Resources": {
"LogsResourcePolicy": {
"Type": "AWS::Logs::ResourcePolicy",
"Properties": {
"PolicyName": "TransactionSearchAccess",
"PolicyDocument": {
"Fn::Sub": "{\n \"Version\": \"2012-10-17\", \n \"Statement\": [\n {\n \"Sid\": \"TransactionSearchXRayAccess\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": \"xray.amazonaws.com\"\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": [\n \"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:aws/spans:*\",\n \"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/application-signals/data:*\"\n ],\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"arn:${AWS::Partition}:xray:${AWS::Region}:${AWS::AccountId}:*\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"${AWS::AccountId}\"\n }\n }\n }\n ]\n}"
}
}
}
}
}
```
1. **AWS::XRay::TransactionSearchConfig 생성 및 구성** - `TransactionSearchConfig` 리소스를 생성하여 트랜잭션 검색을 활성화합니다.
**YAML**
```
Resources:
XRayTransactionSearchConfig:
Type: AWS::XRay::TransactionSearchConfig
```
**JSON**
```
{
"Resources": {
"XRayTransactionSearchConfig": {
"Type": "AWS::XRay::TransactionSearchConfig"
}
}
}
```
1. (선택 사항) 인덱싱할 스팬의 백분율을 제어하도록 `IndexingPercentage` 속성을 설정할 수 있습니다.
**YAML**
```
Resources:
XRayTransactionSearchConfig:
Type: AWS::XRay::TransactionSearchConfig
Properties:
IndexingPercentage: 50
```
**JSON**
```
{
"Resources": {
"XRayTransactionSearchConfig": {
"Type": "AWS::XRay::TransactionSearchConfig",
"Properties": {
"IndexingPercentage": 20
}
}
}
}
```
IndexingPercentage 값은 0\$1100으로 설정할 수 있습니다.
## 템플릿 예제
다음 예제에서는 리소스 정책과 TransactionSearchConfig가 모두 포함됩니다.
**YAML**
```
Resources:
LogsResourcePolicy:
Type: AWS::Logs::ResourcePolicy
Properties:
PolicyName: TransactionSearchAccess
PolicyDocument: !Sub >
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "TransactionSearchXRayAccess",
"Effect": "Allow",
"Principal": {
"Service": "xray.amazonaws.com"
},
"Action": "logs:PutLogEvents",
"Resource": [
"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:aws/spans:*",
"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/application-signals/data:*"
],
"Condition": {
"ArnLike": {
"aws:SourceArn": "arn:${AWS::Partition}:xray:${AWS::Region}:${AWS::AccountId}:*"
},
"StringEquals": {
"aws:SourceAccount": "${AWS::AccountId}"
}
}
}
]
}
XRayTransactionSearchConfig:
Type: AWS::XRay::TransactionSearchConfig
Properties:
IndexingPercentage: 10
```
**JSON**
```
{
"Resources": {
"LogsResourcePolicy": {
"Type": "AWS::Logs::ResourcePolicy",
"Properties": {
"PolicyName": "TransactionSearchAccess",
"PolicyDocument": {
"Fn::Sub": "{\n \"Version\": \"2012-10-17\", \n \"Statement\": [\n {\n \"Sid\": \"TransactionSearchXRayAccess\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": \"xray.amazonaws.com\"\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": [\n \"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:aws/spans:*\",\n \"arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/application-signals/data:*\"\n ],\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"arn:${AWS::Partition}:xray:${AWS::Region}:${AWS::AccountId}:*\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"${AWS::AccountId}\"\n }\n }\n }\n ]\n}"
}
}
},
"XRayTransactionSearchConfig": {
"Type": "AWS::XRay::TransactionSearchConfig",
"Properties": {
"IndexingPercentage": 20
}
}
}
}
```
다음은 TypeScript에서 AWS CDK를 사용하는 예제입니다.
**CDK**
```
import * as cdk from '@aws-cdk/core';
import * as logs from '@aws-cdk/aws-logs';
import * as xray from '@aws-cdk/aws-xray';
export class XRayTransactionSearchStack extends cdk.Stack {
constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Create the resource policy
const transactionSearchAccess = new logs.CfnResourcePolicy(this, 'XRayLogResourcePolicy', {
policyName: 'TransactionSearchAccess',
policyDocument: JSON.stringify({
Version: '2012-10-17',
Statement: [
{
Sid: 'TransactionSearchXRayAccess',
Effect: 'Allow',
Principal: {
Service: 'xray.amazonaws.com',
},
Action: 'logs:PutLogEvents',
Resource: [
`arn:${this.partition}:logs:${this.region}:${this.account}:log-group:aws/spans:*`,
`arn:${this.partition}:logs:${this.region}:${this.account}:log-group:/aws/application-signals/data:*`,
],
Condition: {
ArnLike: {
'aws:SourceArn': `arn:${this.partition}:xray:${this.region}:${this.account}:*`,
},
StringEquals: {
'aws:SourceAccount': this.account,
},
},
},
],
}),
});
// Create the TransactionSearchConfig with dependency
const transactionSearchConfig = new xray.CfnTransactionSearchConfig(this, 'XRayTransactionSearchConfig', {
indexingPercentage: 10,
});
// Add the dependency to ensure Resource Policy is created first
transactionSearchConfig.addDependsOn(transactionSearchAccess);
}
}
```
## 구성 확인
CloudFormation 스택을 배포한 후 AWS CLI를 사용하여 구성을 확인할 수 있습니다.
**aws xray get-trace-segment-destination**
구성되면 다음이 반환됩니다.
```
{
"Destination": "CloudWatchLogs",
"Status": "ACTIVE"
}
```