Configurar regras de amostragem do AWS X-Ray para APIs do API Gateway

Use o console ou o SDK do AWS X-Ray para configurar regras de amostragem para a API do Amazon API Gateway. Uma regra de amostragem especifica quais solicitações o X-Ray deve registrar para sua API. Ao personalizar regras de amostragem, você pode controlar a quantidade de dados gravados e modificar o comportamento de amostragem instantaneamente, sem modificar ou reimplantar seu código.

Antes de especificar as regras de amostragem do X-Ray, leia os tópicos a seguir no Guia do desenvolvedor do X-Ray:

• Configure sampling rules

• Usar regras de amostragem com a API do X-Ray

Valores de opção da regra de amostragem do X-Ray para APIs do API Gateway

As seguintes opções de amostragem do X-Ray são relevantes para o API Gateway. Valores de string podem usar curingas para corresponder a um caractere único (?), ou zero ou mais caracteres (*). Consulte mais detalhes, incluindo uma explicação detalhada de como as configurações de Reservatório e Taxa são usadas, em Configure sampling rules.

• Nome da regra (string): um nome exclusivo para a regra.

• Prioridade (inteiro entre 1 e 9999): a prioridade da regra de amostragem. Os serviços avaliam as regras em ordem decrescente de prioridade e tomam uma decisão de amostragem com a primeira regra correspondente.

• Reservatório (inteiro não negativo): um número fixo de solicitações correspondentes para instrumentar por segundo, antes de aplicar a taxa fixa. O reservatório não é usado diretamente pelos serviços, mas se aplica a todos os serviços usando a regra coletivamente.

• Taxa (número entre 0 e 100): a porcentagem de solicitações correspondentes para instrumentar, depois que o reservatório é esgotado.

• Nome do serviço (string): nome de estágio da API, no formato {api-name}/{stage-name}. Por exemplo, se você implantaria a amostra de API PetStore em um estágio chamado test, o valor Service name (Nome de serviço) a ser especificado na regra de amostragem seria pets/test.

• Tipo de serviço (string): para uma API do API Gateway, pode-se especificar AWS::ApiGateway::Stage ou AWS::ApiGateway::*.

• Host (string): o nome de host do cabeçalho de host HTTP. Defina isso como * para corresponder contra todos os nomes de host. Ou especifique um nome de host completo ou parcial para correspondência, por exemplo, api.example.com ou *.example.com.

• ARN do recurso (string): o ARN do estágio da API, por exemplo, arn:aws:apigateway:region::/restapis/api-id/stages/stage-name.

  O nome de estágio pode ser obtido do console, da CLI ou da API do API Gateway. Para obter mais informações sobre os formatos de ARN, consulte a Referência geral da Amazon Web Services.

• Método HTTP (string): o método a ser amostrado; por exemplo, GET.

• URL path (Caminho do URL) (string) — O caminho URL da solicitação.

• (opcional) Atributos (chave e valor): cabeçalhos da solicitação HTTP original; por exemplo, Connection, Content-Length ou Content-Type. Cada valor de atributo pode ter até 32 caracteres.

Exemplos de regras de amostragem do X-Ray

Exemplo de regra de amostragem Nº 1

Essa regra amostra todas as solicitações GET para a API testxray no estágio test.

• Rule name (Nome da regra — test-sampling

• Prioridade — 17

• Tamanho do reservatório — 10

• Taxa fixa — 10

• Nome do serviço — testxray/test

• Tipo de serviço — AWS::ApiGateway::Stage

• Método HTTP — GET

• ARN do recurso — *

• Host — *

Exemplo de regra de amostragem Nº 2

Essa regra amostra todas as solicitações para a API testxray no estágio prod.

• Rule name (Nome da regra — prod-sampling

• Prioridade — 478

• Tamanho do reservatório — 1

• Taxa fixa — 60

• Nome do serviço — testxray/prod

• Tipo de serviço — AWS::ApiGateway::Stage

• Método HTTP — *

• ARN do recurso — *

• Host — *

• Atributos — {}