# Habilitar o Transaction Search
É possível habilitar [Transaction Search](CloudWatch-Transaction-Search.md) via console ou por meio de uma API. A pesquisa de transações é configurada para a conta inteira e muda a ingestão de todas as extensões por meio do X-Ray para o modo de coleta econômico usando os [Preços do Amazon CloudWatch](https://aws.amazon.com/cloudwatch/pricing/). Por padrão, você também indexará 1% das extensões ingeridas gratuitamente como resumo de rastreamento para análise, o que normalmente é suficiente, considerando que você já tem visibilidade total de rastreamento de ponta a ponta em todas as expansões ingeridas via Transaction Search.
## Pré-requisitos
Antes de poder habilitar o Transaction Search, você deve criar um perfil com as permissões a seguir.
------
#### [ 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/*"
}
]
}
```
------
**nota**
Para usar o Transaction Search e outros recursos do CloudWatch, adicione a [política CloudWatchReadOnlyAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/CloudWatchReadOnlyAccess.html) ao perfil. Para obter informações sobre como criar um perfil, consulte [Criação de perfil do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html).
## Habilitar o Transaction Search no console
O procedimento a seguir descreve como habilitar o Transaction Search no console.
**Para habilitar o Transaction Search no console do CloudWatch**
1. Abra o console do CloudWatch, em [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. No painel de navegação, em **Application Signals**, escolha **Transaction Search**.
1. Escolha **Habilitar Transaction Search**.
1. Selecione a caixa para ingerir extensões como logs estruturados e insira uma porcentagem das extensões a serem indexadas. Você pode indexar extensões a 1% gratuitamente e alterar a porcentagem posteriormente com base em suas necessidades.
## Como habilitar a Pesquisa de transações usando uma API
O procedimento a seguir descreve como habilitar a Pesquisa de transações usando uma API.
### Etapa 1. Criar uma política que conceda acesso a extensões de ingestão no CloudWatch Logs
Ao usar o SDK ou a AWS CLI para habilitar o Transaction Search, você deve configurar as permissões usando uma política baseada em recursos com [https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html](https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html).
**Exemplo de política**
O exemplo de política a seguir permite que o X-Ray envie rastreamentos para o 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"
}
}
}
]
}
```
------
**Exemplo de comando**
O exemplo a seguir mostra como formatar o comando da AWS CLI com a política `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:xray:region:account-id:*" }, "StringEquals": { "aws:SourceAccount": "account-id" } } } ]}'
```
### Etapa 2. Configurar o destino dos segmentos de rastreamento
Configure a ingestão de extensões com [https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html](https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html).
**Exemplo de comando**
O exemplo a seguir mostra como formatar o comando da AWS CLI com a política `UpdateTraceSegmentDestination`.
```
aws xray update-trace-segment-destination --destination CloudWatchLogs
```
### Etapa 3. Configurar a quantidade de extensões a serem indexadas
Configure a porcentagem de amostragem desejada com [https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html](https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html)
**Exemplo de comando**
O exemplo a seguir mostra como formatar o comando da AWS CLI com a política `UpdateIndexingRule`.
```
aws xray update-indexing-rule --name "Default" --rule '{"Probabilistic": {"DesiredSamplingPercentage": number}}'
```
**nota**
Depois de habilitar o Transaction Search, pode levar dez minutos para que as extensões fiquem disponíveis para pesquisa e análise.
### Etapa 4: Verificar se as extensões estão disponíveis para pesquisa e análise
Para verificar se as extensões estão disponíveis para pesquisa e análise, use [https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html).
**Exemplos de comando**
O exemplo a seguir mostra como formatar o comando da AWS CLI com a política `GetTraceSegmentDestination`.
```
aws xray get-trace-segment-destination
```
**Exemplo de resposta**
O exemplo a seguir mostra a resposta que você pode esperar quando o Transaction Search está ativo.
```
{
"Destination": "CloudWatchLogs",
"Status": "ACTIVE"
}
```
# Como usar a Pesquisa de transações com o CloudFormation
Você pode usar o CloudFormation para habilitar e configurar a Pesquisa de transações no X-Ray.
**nota**
Para criar uma pilha do CloudFormation, consulte [Criar sua primeira pilha](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/gettingstarted.walkthrough.html).
## Pré-requisitos
+ Você deve ter acesso a uma conta da AWS com um usuário ou perfil do IAM que tenha permissões para usar o Amazon EC2, o Amazon S3, o CloudFormation ou ter acesso de usuário administrativo.
+ Você deve ter uma nuvem privada virtual (VPC) que tenha acesso à internet. Para simplificar, você pode usar a VPC padrão que vem com sua conta. A VPC padrão e as sub-redes padrão são suficientes para essa configuração.
+ Certifique-se de que a Pesquisa de transações esteja desabilitada antes de habilitá-la com o AWS CDK ou o CloudFormation.
## Como habilitar a Pesquisa de transações
Para habilitar a Pesquisa de transações usando o CloudFormation, é necessário criar os dois recursos a seguir.
+ `AWS::Logs::ResourcePolicy`
+ `AWS::XRay::TransactionSearchConfig`
1. **Create AWS::Logs::ResourcePolicy**: crie uma política de recursos que permita que o X-Ray envie rastreamentos para o 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. **Create and Configure AWS::XRay::TransactionSearchConfig**: crie o recurso `TransactionSearchConfig` para habilitar a Pesquisa de transações.
**YAML**
```
Resources:
XRayTransactionSearchConfig:
Type: AWS::XRay::TransactionSearchConfig
```
**JSON**
```
{
"Resources": {
"XRayTransactionSearchConfig": {
"Type": "AWS::XRay::TransactionSearchConfig"
}
}
}
```
1. (Opcional) Você pode definir a propriedade `IndexingPercentage` para controlar o percentual de spans que serão indexados.
**YAML**
```
Resources:
XRayTransactionSearchConfig:
Type: AWS::XRay::TransactionSearchConfig
Properties:
IndexingPercentage: 50
```
**JSON**
```
{
"Resources": {
"XRayTransactionSearchConfig": {
"Type": "AWS::XRay::TransactionSearchConfig",
"Properties": {
"IndexingPercentage": 20
}
}
}
}
```
O valor de IndexingPercentage pode ser definido entre 0 e 100.
## Exemplos de modelos
O exemplo a seguir inclui a política de recursos e a 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
}
}
}
}
```
Veja um exemplo usando o AWS CDK no TypeScript.
**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);
}
}
```
## Como verificar a configuração
Depois de implantar sua pilha do CloudFormation, você pode verificar a configuração usando a AWS CLI.
**aws xray get-trace-segment-destination**
Uma configuração bem-sucedida retornará o seguinte:
```
{
"Destination": "CloudWatchLogs",
"Status": "ACTIVE"
}
```