As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
AWS X-Ray e Step Functions
Você pode usar o AWS X-Ray para visualizar os componentes da máquina de estado, identificar gargalos de desempenho e solucionar problemas de solicitações que resultaram em erros. A máquina de estado envia dados de rastreamento ao X-Ray que, então, processa os dados para gerar um mapa de serviço e resumos de rastreamento pesquisáveis.
Com o X-Ray ativado para sua máquina de estado, você pode rastrear solicitações conforme elas são executadas no Step Functions, em todas as AWS regiões onde o X-Ray está disponível. Isso fornece uma visão geral detalhada de toda uma solicitação do Step Functions. O Step Functions enviará rastreamentos ao X-Ray para execuções de máquina de estado, mesmo quando um ID de rastreamento não é transmitido por um serviço upstream. Você pode usar um mapa do serviço X-Ray para visualizar a latência de uma solicitação, incluindo quaisquer AWS serviços integrados ao X-Ray. Também é possível configurar regras de amostragem para informar ao X-Ray quais solicitações registrar e com quais taxas de amostragem, de acordo com os critérios especificados.
Quando o X-Ray não está ativado para a máquina de estado, e um serviço upstream não passa um ID de rastreamento, o Step Functions não envia rastreamentos ao X-Ray para execuções de máquinas de estado. Entretanto, se o ID de rastreamento for transmitido por um serviço upstream, o Step Functions enviará rastreamentos ao X-Ray para execuções de máquina de estado.
Você pode usar AWS X-Ray com Step Functions em regiões onde ambos são suportados. Consulte as páginas de endpoints e cotas do Step Functions e do X-Ray para obter informações sobre o suporte regional para X-Ray e Step Functions.
Cotas combinadas de X-Ray e Step Functions
Você pode adicionar dados a um rastreamento por até sete dias e consultar dados de rastreamento que remontam a trinta dias, o período em que o X-Ray armazena os dados de rastreamento. Os rastreamentos estarão sujeitos às cotas de X-Ray. Além de outras cotas, o X-Ray fornece um tamanho mínimo de rastreamento garantido de 100 KB para máquinas de estado do Step Functions. Se mais de 100 KB de dados de rastreamento forem fornecidos ao X-Ray, isso poderá resultar em um rastreamento congelado. Consulte a seção de service quotas da página Endpoints e cotas do X-Ray para obter mais informações sobre outras cotas do X-Ray.
Importante
O Step Functions não oferece suporte ao rastreamento do X-Ray para as execuções do fluxo de trabalho secundário iniciadas por um estado de Mapa distribuído porque é fácil exceder o Limite de tamanho do documento de rastreamento para essas execuções.
Tópicos
- Definição e configuração
- Conceitos
- Integrações de serviços
- Como visualizar o console do X-Ray
- Como visualizar informações de rastreamento do X-Ray para o Step Functions
- Rastreamentos
- Mapa de serviço
- Segmentos e subsegmentos
- Análises
- Configuração
- E se não houver dados no mapa de rastreamento ou no mapa de serviço?
Definição e configuração
Ative o rastreamento do X-Ray ao criar uma máquina de estado
Você pode ativar o rastreamento do X-Ray ao criar uma nova máquina de estado selecionando Ativar rastreamento do X-Ray na página Especificar detalhes.
-
Abra o console do Step Functions
e clique em Criar máquina de estado. -
Na página Escolher método de criação, escolha uma opção apropriada para criar a máquina de estado. Se você escolher Executar um projeto de amostra, não poderá ativar o rastreamento do X-Ray durante a criação da máquina de estado e precisará ativar o rastreamento do X-Ray após a criação da máquina de estado. Para obter mais informações sobre como ativar o X-Ray em uma máquina de estado existente, consulte Ativar o X-Ray em uma máquina de estado existente.
Escolha Próximo.
-
Na página Especificar detalhes, configure a máquina de estado.
-
Escolha Ativar rastreamento do X-Ray.
A máquina de estado do Step Functions agora enviará rastreamentos ao X-Ray para execuções de máquinas de estado.
nota
Se você optar por usar um perfil do IAM existente, você deverá garantir que as gravações no X-Ray sejam permitidas. Para obter mais informações sobre as permissões de que você precisa, consulte as Políticas do IAM para o X-Ray.
Ativar o X-Ray em uma máquina de estado existente
Para ativar o X-Ray em uma máquina de estado existente:
-
No console do Step Functions
, selecione a máquina de estado para a qual você deseja ativar o rastreamento. -
Selecione a opção Editar.
-
Escolha Ativar rastreamento do X-Ray.
Você verá uma notificação informando que talvez seja necessário fazer alterações adicionais.
nota
Ao ativar o X-Ray para uma máquina de estado existente, você terá que se certificar de que tem uma política do IAM com permissões suficientes para que o X-Ray execute rastreamentos. Você pode adicionar uma manualmente ou gerar uma. Para obter mais informações, consulte a seção Política do IAM para o Políticas do IAM para AWS X-Ray.
-
(Opcional) Gere automaticamente um novo perfil para a máquina de estado a fim de incluir permissões do X-Ray.
-
Escolha Salvar.
Configurar rastreamento do X-Ray para o Step Functions
Quando você executa pela primeira vez uma máquina de estado com o X-Ray Tracing ativado, ela usa os valores de configuração padrão para o X-Ray Tracing. AWS X-Ray não coleta dados para cada solicitação enviada a um aplicativo. Em vez disso, ele coleta dados para um número estatisticamente significativo de solicitações. O padrão é registrar a primeira solicitação a cada segundo e cinco por cento de todas as solicitações adicionais. Uma solicitação por segundo é o reservatório. Isso garante que pelo menos um rastreamento seja registrado a cada segundo à medida que o serviço atende às solicitações. Cinco por cento é a taxa segundo a qual as solicitações adicionais, além do tamanho de reservatório, são amostradas.
Para evitar cobranças incorridas para o serviço quando você está começando a usá-lo, a taxa de amostragem padrão é conservadora. Você pode configurar o X-Ray para modificar a regra de amostragem padrão e configurar regras adicionais que aplicam a amostragem com base nas propriedades do serviço ou da solicitação.
Por exemplo, talvez você queira desativar a amostragem e rastrear todas as solicitações de chamadas que modificam o estado, o identificador Contas da AWS ou as transações. Para chamadas somente leitura de alto volume, como a sondagem de plano de fundo, as verificações de integridade ou a manutenção da conexão, você pode coletar amostras a uma taxa baixa e ainda obter dados suficientes para observar quaisquer problemas que ocorram.
Para configurar uma regra de amostragem para a máquina de estado:
-
Acesse o console do X-Ray
. -
Escolha Sampling (Amostragem).
-
Para criar uma regra, escolha Criar regra de amostragem.
Para editar uma regra, escolha o nome de uma regra.
Para excluir uma regra, escolha uma regra e use o menu Actions (Ações) para excluí-la.
Algumas partes das regras de amostragem existentes, como o nome e a prioridade, não podem ser alteradas. Em vez disso, adicione ou clone uma regra existente, faça as alterações desejadas e use a nova regra.
Para obter informações detalhadas sobre as regras de amostragem do X-Ray e como configurar os vários parâmetros, consulte Configurando regras de amostragem no console do X-Ray.
Integrar serviços upstream
Para integrar a execução dos fluxos de trabalho do Step Functions, como fluxos de trabalho padrão, Synchronous e padrão, com um serviço upstream, você precisa definir o traceHeader. Isso é feito automaticamente para você se você estiver usando uma API HTTP no API Gateway. No entanto, se você estiver usando uma função do Lambda e/ou um SDK, precisará configurar você mesmo o traceHeader nas chamadas de API StartExecution ou StartSyncExecution.
É necessário especificar o formato traceHeader como \p{ASCII}∗. Além disso, para permitir que o Step Functions use o mesmo ID de rastreamento, você deve especificar o formato como Root={TRACE_ID};Sampled={1 or 0}. Se você estiver usando uma função do Lambda, substitua o TRACE_IDpelo ID de rastreamento no segmento atual e defina o campo Amostragem como 1 se o modo de amostragem for true e 0 se o modo de amostragem for false. Fornecer o ID de rastreamento nesse formato garante que você obtenha um rastreamento completo.
Veja a seguir um exemplo escrito em Python para mostrar como especificar o traceHeader.
state_machine = config.get_string_paramter("STATE_MACHINE_ARN") if (xray_recorder.current_subsegment() is not None and xray_recorder.current_subsegment().sampled) : trace_id = "Root={};Sampled=1".format( xray_recorder.current_subsegment().trace_id ) else: trace_id = "Root=not enabled;Sampled=0" LOGGER.info("trace %s", trace_id) # execute it response = states.start_sync_execution( stateMachineArn=state_machine, input=event['body'], name=context.aws_request_id, traceHeader=trace_id ) LOGGER.info(response)
Conceitos
O console do X-Ray
O AWS X-Ray console permite que você visualize mapas e rastreamentos de serviços para solicitações atendidas por seus aplicativos. Você pode acessar o console para ver informações detalhadas coletadas pelo X-Ray quando ele está ativado para a máquina de estado.
Consulte Como visualizar o console do X-Ray para obter informações sobre como acessar o console do X-Ray para execuções de máquina de estado.
Para obter informações detalhadas sobre o console do X-Ray, consulte a documentação do console do X-Ray.
Segmentos, subsegmentos e rastreamentos
Um segmento registra informações sobre uma solicitação na máquina de estado. Ele contém informações como o trabalho que a máquina de estado executa e também pode conter subsegmentos com informações sobre chamadas downstream.
Um rastreamento coleta todos os segmentos gerados por uma única solicitação.
Amostragem
Para garantir um rastreamento eficiente e fornecer uma amostra representativa das solicitações atendidas pela aplicação, o X-Ray aplica um algoritmo de amostragem para determinar quais solicitações são rastreadas. Isso pode ser alterado editando as regras de amostragem.
Indicadores
Para a máquina de estado, o X-Ray medirá o tempo de invocação, o tempo de transição de estado, o tempo geral de execução do Step Functions e as variações desse tempo de execução. Essas informações podem ser acessadas por meio do console do X-Ray.
Análises
O console do AWS X-Ray Analytics é uma ferramenta interativa para interpretar dados de rastreamento. É possível refinar o conjunto de dados ativo com filtros cada vez mais granulares clicando nos gráficos e nos painéis de métricas e campos que estão associados ao conjunto de rastreamentos atual. Isso permite analisar o desempenho da máquina de estado, além de localizar e identificar rapidamente problemas de desempenho.
Para obter informações detalhadas sobre a análise de X-Ray, consulte Interação com o console do AWS X-Ray Analytics
Integrações de serviços do Step Functions e X-Ray
Alguns dos AWS serviços que se integram ao Step Functions oferecem integração com AWS X-Ray a adição de um cabeçalho de rastreamento às solicitações, a execução do daemon X-Ray ou a tomada de decisões de amostragem e o upload de dados de rastreamento para o X-Ray. Outros devem ser instrumentados usando o AWS X-Ray SDK. Alguns ainda não oferecem suporte à integração com o X-Ray. A integração do X-Ray é necessária para fornecer dados de rastreamento completos ao usar uma integração de serviços com o Step Functions
Suporte nativo ao X-Ray
As integrações de serviços com suporte nativo ao X-Ray incluem:
-
AWS Step Functions
Instrumentação necessária
Integrações de serviços que exigem instrumentação do X-Ray:
-
Amazon Elastic Container Service
-
AWS Batch
-
AWS Fargate
Somente rastreamento do lado do cliente
Outras integrações de serviço não são compatíveis com rastreamentos do X-Ray. No entanto, os rastreamentos do lado do cliente ainda podem ser coletados:
-
Amazon DynamoDB
-
Amazon EMR
-
Amazon SageMaker
-
AWS CodeBuild
-
AWS Glue
Como visualizar o console do X-Ray
O X-Ray recebe dados de serviços como segmentos. Em seguida, o X-Ray agrupa segmentos que tenham uma solicitação em comum em rastreamentos. O X-Ray processa os rastreamentos para gerar um gráfico de serviço que apresenta uma representação visual da aplicação.
Depois de iniciar a execução da máquina de estado, você pode visualizar os rastreamentos do X-Ray escolhendo o link do mapa de rastreamento do X-Ray na seção Detalhes da execução.
Depois de ativar o X-Ray para a máquina de estado, as informações de rastreamento das execuções podem ser visualizadas no console do X-Ray.
Como visualizar informações de rastreamento do X-Ray para o Step Functions
As seguintes etapas ilustram o tipo de informação que você pode ver no console depois de ativar o X-Ray e realizar uma execução. São mostrados rastreamentos do X-Ray para o projeto de amostra Exemplo de Padrão de Retorno de Chamada (Amazon SQS, Amazon SNS, Lambda) .
Rastreamentos
Depois que uma execução for concluída, você poderá navegar até o console do X-Ray, onde verá a página Rastreamentos do X-Ray. Isso exibe uma visão geral do mapa de serviços, bem como informações de rastreamento e segmento para a máquina de estado.
Mapa de serviço
O mapa de serviço no console do X-Ray ajuda a identificar serviços nos quais estejam ocorrendo erros, nos quais haja conexões com alta latência ou ver rastreamentos para solicitações que foram malsucedidas.
No mapa de rastreamento, você pode escolher um nó de serviço para visualizar as solicitações desse nó ou uma borda entre dois nós para visualizar as solicitações que percorreram essa conexão. Aqui, o nó WaitForCallBack foi selecionado e você pode ver informações adicionais sobre o status de execução e resposta.
Você pode ver como o mapa de serviço do X-Ray se correlaciona com a máquina de estado. Há um nó de mapa de serviço para cada integração de serviço que é chamado pelo Step Functions, desde que ele seja compatível com o X-Ray.
Segmentos e subsegmentos
Um rastreamento coleta todos os segmentos gerados por uma única solicitação. Cada segmento fornece o nome do recurso, os detalhes sobre a solicitação e os detalhes sobre o trabalho realizado. Na página Rastreamentos, você pode ver os segmentos e, se expandidos, os subsegmentos correspondentes. Você pode escolher um segmento ou subsegmento para ver informações detalhadas sobre ele.
Escolha cada uma das guias para ver como as informações de segmentos e subsegmentos são exibidas.
Análises
O console do AWS X-Ray Analytics é uma ferramenta interativa para interpretar dados de rastreamento. Você pode usar isso para entender mais facilmente o desempenho da máquina de estado. O console permite explorar, analisar e visualizar rastreamentos por meio de gráficos interativos de tempo de resposta e de séries temporais. Isso pode ajudar você a localizar rapidamente problemas de desempenho e latência.
É possível refinar o conjunto de dados ativo com filtros cada vez mais granulares clicando nos gráficos e nos painéis de métricas e campos que estão associados ao conjunto de rastreamentos atual.
Configuração
Você pode configurar opções de amostragem e criptografia no console do X-Ray.
E se não houver dados no mapa de rastreamento ou no mapa de serviço?
Se você tiver ativado o X-Ray, mas não conseguir ver nenhum dado no console do X-Ray, verifique se:
-
Os perfis do IAM estão configurados corretamente para permitir a gravação no X-Ray.
-
As regras de amostragem permitem a amostragem de dados.
-
Como pode haver um pequeno atraso até que os perfis do IAM recém-criados ou modificados sejam aplicados, verifique o rastreamento ou os mapas de serviço novamente após alguns minutos.
-
Se você ver Data Not Found no painel X-Ray Traces, verifique as configurações da sua conta do IAM
e verifique se ela AWS Security Token Service está ativada para a região pretendida. Para obter mais informações, consulte Ativação e desativação AWS STSRegião da AWS em um Guia do usuário do IAM.
