# Configuración de reglas de muestreo de AWS X-Ray para las API de API Gateway
<a name="apigateway-configuring-xray-sampling-rules"></a>

Puede utilizar la consola o el SDK de AWS X-Ray para configurar reglas de muestreo para su API de Amazon API Gateway. Una regla de muestreo especifica qué solicitudes debe registrar X-Ray para la API. Al personalizar las reglas de muestreo, puede controlar la cantidad de datos que va a registrar y modificar el comportamiento de muestreo sobre la marcha sin modificar o volver a implementar su código.

Antes de especificar sus reglas de muestreo de X-Ray, lea los siguientes temas en la guía para desarrolladores de X-Ray:
+ [Configuración de reglas de muestreo](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-sampling)
+ [Uso de reglas de muestreo con la API de X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-sampling)

**Topics**
+ [Valores de opciones de regla de muestreo de X-Ray para las API de API Gateway](#apigateway-xray-sampling-rule-options)
+ [Ejemplos de reglas de muestreo de X-Ray](#apigateway-xray-sampling-rules-examples)

## Valores de opciones de regla de muestreo de X-Ray para las API de API Gateway
<a name="apigateway-xray-sampling-rule-options"></a>

Las siguientes opciones de muestreo de X-Ray son relevantes para API Gateway. En los valores de cadena se pueden usar caracteres comodín para buscar coincidencias de un solo carácter (?) o cero o más caracteres (\$1). Para obtener más información, incluida una explicación detallada de la forma en que se usan las opciones **Depósito** y **Porcentaje**, consulte [Configuración de reglas de muestreo](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-sampling).
+ **Rule name (Nombre de la regla)** (cadena): un nombre único para la regla.
+ **Priority (Prioridad)** (entero comprendido entre el 1 y 9999): prioridad de la regla de muestreo. Los servicios evalúan las reglas en orden ascendente de prioridad y toman una decisión de muestreo con la primera regla coincidente.
+ **Reservoir (Depósito)** (entero no negativo): número fijo de solicitudes coincidentes que se van a instrumentar por segundo, antes de aplicar el porcentaje fijo. Los servicios no utilizan directamente el depósito, sino que se aplica a todos los servicios que usan la regla en su conjunto.
+ **Rate (Porcentaje)** (número comprendido entre el 0 y el 100): porcentaje de solicitudes coincidentes que se van instrumentar, una vez que se ha agotado el depósito.
+ **Service name (Nombre de servicio)** (cadena): nombre de la etapa de API, con el formato ***\$1api-name\$1*/*\$1stage-name\$1***. Por ejemplo, si implementara la API de ejemplo [PetStore](api-gateway-create-api-from-example.md) en una etapa llamada `test`, el valor de **Service name (Nombre de servicio)** que especificaría en la regla de muestreo sería **pets/test**.
+ **Service type (Tipo de servicio)** (cadena): para una API de API Gateway, se puede especificar **AWS::ApiGateway::Stage** o **AWS::ApiGateway::\$1**.
+ **Host (Alojamiento)** (cadena): nombre del alojamiento del encabezado del alojamiento de HTTP. Establezca esta opción en **\$1** para realizar la comparación con todos los nombres de host. También puede especificar un nombre de host completo o parcial para la comparación (por ejemplo, **api.example.com** o **\$1.example.com**).
+ **Resource ARN** (ARN del recurso) (cadena): el ARN de la etapa de la API, por ejemplo, **arn:aws:apigateway:*region*::/restapis/*api-id*/stages/*stage-name***.

  El nombre de etapa se puede obtener de la consola, de la CLI o la API de API Gateway. Para obtener más información sobre los formatos de ARN, consulte la [Referencia general de Amazon Web Services](https://docs.aws.amazon.com/general/latest/gr/).
+ **HTTP method (Método HTTP)** (cadena): método del que se va a realizar el muestreo (por ejemplo, **GET**).
+ **Ruta URL** (cadena): la ruta URL de la solicitud.
+ (opcional) **Attributes (key and value) (Atributos: clave y valor)**: encabezados de la solicitud HTTP original (por ejemplo, **Connection**, **Content-Length** o **Content-Type**). Cada valor de atributo puede tener una longitud de hasta 32 caracteres.

## Ejemplos de reglas de muestreo de X-Ray
<a name="apigateway-xray-sampling-rules-examples"></a>

**Ejemplo de regla de muestreo \$11**

Esta regla realiza un muestreo de todas las solicitudes `GET` de la API `testxray` en la etapa `test`.
+ **Nombre de la regla — ****test-sampling**
+ **Priority (Prioridad — ****17**
+ **Reservoir size (Tamaño del depósito — ****10**
+ **Fixed rate (Porcentaje fijo — ****10**
+ **Service name (Nombre del servicio — ****testxray/test**
+ **Service type (Tipo de servicio — ****AWS::ApiGateway::Stage**
+ **HTTP method (Método HTTP — ****GET**
+ **Resource ARN (ARN del recurso — ****\$1**
+ **El host — ****\$1**

**Ejemplo de regla de muestreo \$12**

Esta regla realiza un muestreo de todas las solicitudes de la API `testxray` en la etapa `prod`.
+ **Nombre de la regla — ****prod-sampling**
+ **Priority (Prioridad — ****478**
+ **Reservoir size (Tamaño del depósito — ****1**
+ **Fixed rate (Porcentaje fijo — ****60**
+ **Service name (Nombre del servicio — ****testxray/prod**
+ **Service type (Tipo de servicio — ****AWS::ApiGateway::Stage**
+ **HTTP method (Método HTTP — ****\$1**
+ **Resource ARN (ARN del recurso — ****\$1**
+ **El host — ****\$1**
+ **Attributes (Atributos** — **\$1\$1**