# Habilitación de Transaction Search Puede habilitar [Transaction Search](CloudWatch-Transaction-Search.md) con la consola o una API. La búsqueda de transacciones está configurada para toda la cuenta y cambia la ingesta de todas las unidades mediante X-Ray al modo de recopilación rentable usando [Precios de Amazon CloudWatch](https://aws.amazon.com/cloudwatch/pricing/). De forma predeterminada, también indexará el 1 % de las unidades ingeridas de forma gratuita como resumen de seguimiento para su análisis, lo que suele ser suficiente dado que ya dispone de una visibilidad completa de seguimiento de principio a fin en todas las unidades ingeridas mediante la búsqueda de transacciones. ## Requisitos previos Antes de habilitar Transaction Search, debe crear un rol con los siguientes permisos. ------ #### [ 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 Transaction Search y otras características de CloudWatch, agregue la [política CloudWatchReadOnlyAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/CloudWatchReadOnlyAccess.html) a su rol. Para obtener información acerca de cómo crear un rol, consulte [Creación de roles de IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html). ## Habilitación de Transaction Search en la consola En el procedimiento siguiente se describe cómo habilitar Transaction Search en la consola. **Habilitación de Transaction Search en la consola de CloudWatch** 1. Abra la consola de CloudWatch en [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/). 1. En el panel de navegación, en **Application Signals**, elija **Transaction Search**. 1. Seleccione **Habilitar Transaction Search**. 1. Seleccione la casilla para ingerir las unidades de seguimiento como registros estructurados e introduzca un porcentaje de las unidades de seguimiento que desee indexar. Puede indexar las piezas de registro al 1 % de forma gratuita y cambiar el porcentaje más adelante en función de sus necesidades. ## Habilitación de Transaction Search con una API En el siguiente procedimiento se describe cómo habilitar Transaction Search con una API. ### Paso 1. Creación de una política que conceda acceso para ingerir unidades de seguimiento en Registros de CloudWatch Cuando utilice la AWS CLI o el SDK para habilitar Transaction Search, debe configurar los permisos mediante una política basada en recursos con [https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html](https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html). **Política de ejemplo** El siguiente ejemplo de política permite a X-Ray enviar seguimientos a Registros de CloudWatch. ------ #### [ 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" } } } ] } ``` ------ **Comando de ejemplo** En el siguiente ejemplo se muestra cómo formatear el comando AWS CLI con `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" } } } ]}' ``` ### Paso 2. Configuración del destino de los segmentos de seguimientos Configure la ingesta de unidades de seguimiento con [https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html](https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html). **Comando de ejemplo** En el siguiente ejemplo se muestra cómo formatear el comando AWS CLI con `UpdateTraceSegmentDestination`. ``` aws xray update-trace-segment-destination --destination CloudWatchLogs ``` ### Paso 3. Configuración de la cantidad de unidades de seguimiento que se van a indexar Configuración del porcentaje de muestreo deseado con [https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html](https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html) **Comando de ejemplo** En el siguiente ejemplo se muestra cómo formatear el comando AWS CLI con `UpdateIndexingRule`. ``` aws xray update-indexing-rule --name "Default" --rule '{"Probabilistic": {"DesiredSamplingPercentage": number}}' ``` **nota** Tras activar Transaction Search, las unidades de seguimiento pueden tardar diez minutos en estar disponibles para su búsqueda y análisis. ### Paso 4. Verificación de que las unidades de seguimiento estén disponibles para la búsqueda y el análisis Para verificar que las unidades de seguimiento estén disponibles para la búsqueda y el análisis, use [https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html). **Comandos de ejemplo** En el siguiente ejemplo se muestra cómo formatear el comando AWS CLI con `GetTraceSegmentDestination`. ``` aws xray get-trace-segment-destination ``` **Respuesta de ejemplo** En el siguiente ejemplo, se muestra la respuesta que puede esperar cuando Transaction Search esté activo. ``` { "Destination": "CloudWatchLogs", "Status": "ACTIVE" } ``` # Uso de Transaction Search con CloudFormation Puede utilizar CloudFormation para habilitar y configurar X-Ray Transaction Search. **nota** Para crear una pila de CloudFormation, consulte [Creación de su primera pila](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/gettingstarted.walkthrough.html). ## Requisitos previos + Debe tener acceso a una cuenta de AWS con un rol o usuario de IAM que tenga permisos para usar Amazon EC2, Amazon S3, CloudFormation o acceso de usuario administrativo. + Debe tener una nube privada virtual (VPC) que tenga acceso a Internet. Para simplificar, puede usar la VPC predeterminada que se incluye con su cuenta. La VPC predeterminada y las subredes predeterminadas bastan para esta configuración. + Asegúrese de que Transaction Search esté deshabilitada antes de habilitarla usando AWS CDK o CloudFormation. ## Habilitación de Transaction Search Para habilitar Transaction Search mediante CloudFormation, debe crear los siguientes dos recursos. + `AWS::Logs::ResourcePolicy` + `AWS::XRay::TransactionSearchConfig` 1. **Crear AWS::Logs::ResourcePolicy**: cree una política de recursos que permita a X-Ray enviar seguimientos a los registros de CloudWatch **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. **Crear y configurar AWS::XRay::TransactionSearchConfig**: cree el recurso `TransactionSearchConfig` para habilitar Transaction Search. **YAML** ``` Resources: XRayTransactionSearchConfig: Type: AWS::XRay::TransactionSearchConfig ``` **JSON** ``` { "Resources": { "XRayTransactionSearchConfig": { "Type": "AWS::XRay::TransactionSearchConfig" } } } ``` 1. (Opcional) Puede configurar la propiedad `IndexingPercentage` para controlar el porcentaje de intervalos que se indexarán. **YAML** ``` Resources: XRayTransactionSearchConfig: Type: AWS::XRay::TransactionSearchConfig Properties: IndexingPercentage: 50 ``` **JSON** ``` { "Resources": { "XRayTransactionSearchConfig": { "Type": "AWS::XRay::TransactionSearchConfig", "Properties": { "IndexingPercentage": 20 } } } } ``` El valor de IndexingPercentage se puede establecer entre 0 y 100. ## Ejemplos de plantillas El siguiente ejemplo incluye tanto la política de recursos como la 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 } } } } ``` A continuación se muestra un ejemplo usando AWS CDK en 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); } } ``` ## Verificación de la configuración Después de implementar su pila de CloudFormation, puede verificar la configuración mediante la AWS CLI. **aws xray get-trace-segment-destination** Una configuración correcta devolverá lo siguiente. ``` { "Destination": "CloudWatchLogs", "Status": "ACTIVE" } ```