Configurar a fila de mensagens não entregues de um cronograma no Agendador do EventBridge

O Agendador do Amazon EventBridge aceita filas de mensagens não entregues (DLQ) usando o Amazon Simple Queue Service. Quando um agendamento falha ao invocar seu destino, o Agendador do EventBridge entrega uma carga útil JSON contendo detalhes da invocação e qualquer resposta recebida do destino para uma fila padrão do Amazon SQS que você especificar.

O tópico a seguir se refere a esse JSON como um evento de mensagens não entregues. Um evento de mensagens não entregues permite que você solucione problemas com seu agendamento ou metas. Se você configurar uma política de repetição para sua agenda, o Agendador do EventBridge entregará o evento de mensagens não entregues que ele tem, esgotando o número máximo de novas tentativas que você definiu.

Os tópicos a seguir descrevem como você pode configurar uma fila do Amazon SQS como DLQ para seu agendamento, configurar as permissões de que o Agendador do EventBridge precisa para entregar mensagens ao Amazon SQS e receber eventos de mensagens não entregues da DLQ.

Criar uma fila do Amazon SQS

Antes de configurar uma DLQ para seu agendamento, você deve criar uma fila padrão do Amazon SQS. Para obter instruções sobre criar uma fila utilizando o Amazon SQS, consulte o tópico sobre como Criar uma fila do Amazon SQS, no Guia do desenvolvedor do Amazon Simple Queue Service.

Use o comando AWS CLI a seguir da CLI do para criar uma fila padrão.

$ aws sqs create-queue --queue-name queue-name

Se o for bem-sucedido, você verá QueueURL no resultado.

{
    "QueueUrl": "https://sqs.us-west-2.amazonaws.com/123456789012/scheduler-dlq-test"
}

Depois de criar a fila, anote o ARN da fila. Você precisará do ARN ao especificar uma DLQ para seu agendamento do Agendador do EventBridge. Você pode encontrar o ARN da fila no console do Amazon SQS ou usando o comando get-queue-attributes AWS CLI.

$ aws sqs get-queue-attributes --queue-url your-dlq-url --attribute-names QueueArn

Se for bem-sucedido, você verá o ARN da fila na saída.

{
    "Attributes": {
        "QueueArn": "arn:aws:sqs:us-west-2:123456789012:scheduler-dlq-test"
    }
}

Na próxima seção, você adicionará as permissões necessárias à sua função de execução do agendamento para permitir que o Agendador do EventBridge entregue eventos de mensagens não entregues para o Amazon SQS.

Configure as permissões da função de execução

Para permitir que o Agendador do EventBridge entregue eventos de mensagens não entregues para o Amazon SQS, sua função de execução do agendamento precisa da seguinte política de permissão: Para obter mais informações sobre como anexar uma nova política de permissão à sua função de execução do agendamento, consulte Configurando a função de execução.

JSON

{
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Action": [
                "sqs:SendMessage"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

Na próxima seção, você usará o console do Agendador do EventBridge e especificará uma DLQ para sua agenda.

Especificar uma fila de mensagens não entregues

Para especificar uma DLQ, use o console do Agendador do EventBridge ou a AWS CLI para atualizar um agendamento existente ou criar um novo.

Console

Para especificar uma DLQ usando o console

1. Faça login no Console de gerenciamento da AWS e, em seguida, escolha o seguinte link para abrir a seção Agendador do EventBridge do console EventBridge: https://console.aws.amazon.com/scheduler/home

2. No console do Agendador do EventBridge, crie um novo agendamento ou escolha um agendamento existente na sua lista de agendamentos para edição.

3. Na página Configurações, para a fila de mensagens não entregues (DLQ), faça o seguinte:

   • Escolha Selecionar uma fila do Amazon SQS em minha conta da AWS como DLQ e, em seguida, escolha o ARN da fila para seu DLQ na lista suspensa.

   • Escolha Especificar uma fila do Amazon SQS em outras contas da AWS como DLQ e, em seguida, insira o ARN da fila para sua DLQ. Se você escolher uma fila em outra conta da AWS, o console do Agendador do EventBridge não poderá exibir os ARNs da fila em uma lista suspensa.

4. Revise suas seleções e escolha Criar agendamento ou Salvar agendamento para concluir a configuração de uma DLQ.

5. (Opcional) Para ver os detalhes da DLQ de um agendamento, escolha o nome do agendamento na lista e, em seguida, escolha a guia fila de mensagens não entregues na página de detalhes do agendamento.

AWS CLI

Para atualizar um agendamento existente, utilizando a AWS CLI

• Use o comando update-schedule para atualizar sua agenda. Especifique a fila do Amazon SQS que você criou anteriormente como DLQ. Especifique o ARN do perfil do IAM ao qual você anexou as permissões necessárias do Amazon SQS como função de execução. Substitua todos os outros valores de espaço reservado por suas informações.

  $ aws scheduler update-schedule --name existing-schedule \
      --schedule-expression 'rate(5 minutes)' \
      --target '{"DeadLetterConfig": {"Arn": "DLQ_ARN"}, "RoleArn": "ROLE_ARN", "Arn":"QUEUE_ARN", "Input": "Hello world!" }' \
      --flexible-time-window '{ "Mode": "OFF"}'

Para criar uma novo agendamento com uma DLQ usando a AWS CLI

• Para criar um agendamento, use o comando create-schedule. Substitua todos os valores de espaço reservado por suas informações.

  $ aws scheduler create-schedule --name new-schedule \
      --schedule-expression 'rate(5 minutes)' \
      --target '{"DeadLetterConfig": {"Arn": "DLQ_ARN"}, "RoleArn": "ROLE_ARN", "Arn":"QUEUE_ARN", "Input": "Hello world!" }' \
      --flexible-time-window '{ "Mode": "OFF"}'

Na próxima seção, você usará a AWS CLI para receber um evento de mensagens não entregues da DLQ.

Recuperar o evento de mensagens não entregues

Use o comando receive-message, conforme mostrado a seguir, para recuperar um evento de mensagens não entregues da DLQ. Você pode definir o número de mensagens a serem recuperadas usando o atributo --max-number-of-messages.

$ aws sqs receive-message --queue-url your-dlq-url --attribute-names All --message-attribute-names All --max-number-of-messages 1

Se for bem-sucedido, você verá uma saída semelhante à seguinte:

{
    "Messages": [
        {
            "MessageId": "2aeg3510-fe3a-4f5a-ab6a-6906560eaf7e",
            "ReceiptHandle": "AQEBkNKTdOMrWgHKPoITRBwrPoK3eCSZIcZwVqCY0BZ+FfTcORFpopJbtCqj36VbBTlHreM8+qM/m5jcwqSlAlGmIJO/hYmMgn/+dwIty9izE7HnpvRhhEyHxbeTZ5V05RbeasYaBdNyi9WLcnAHviDh6MebLXXNWoFyYNsxdwJuG0f/w3htX6r3dxpXvvFNPGoQb8ihY37+u0gtsbuIwhLtUSmE8rbldEEwiUfi3IJ1zEZpUS77n/k1GWrMrnYg0Gx/BuaLzOrFi2F738XI/Hnh45uv3ca6OYwS1ojPQ1LtX2URg1haV5884FYlaRvY8jRlpCZabTkYRTZKSXG5KNgYZnHpmsspii6JNkjitYVFKPo0H91w5zkHlSx3REAuWk7m3r7PmOMvTNPMhctbD3CkTw==",
            "MD5OfBody": "07adc3fc889d6107d8bb8fda42fe0573",
            "Body": "{\"MessageBody\":\"Hello, world!",\"QueueUrl\":\"https://sqs.us-west-2.amazonaws.com/123456789012/does-not-exist\"}",
            "Attributes": {
                "SenderId": "AROA2DZE3W4CTL5ZR7EIN:ff00212d8c453aaaae644bc6846d4723",
                "ApproximateFirstReceiveTimestamp": "1652499058144",
                "ApproximateReceiveCount": "2",
                "SentTimestamp": "1652490733042"
            },
            "MD5OfMessageAttributes": "f72c1d78100860e00403d849831d4895",
            "MessageAttributes": {
                "ERROR_CODE": {
                    "StringValue": "AWS.SimpleQueueService.NonExistentQueue",
                    "DataType": "String"
                },
                "ERROR_MESSAGE": {
                    "StringValue": "The specified queue does not exist for this wsdl version.",
                    "DataType": "String"
                },
                "EXECUTION_ID": {
                    "StringValue": "ad06616e51cdf74a",
                    "DataType": "String"
                },
                "EXHAUSTED_RETRY_CONDITION": {
                    "StringValue": "MaximumEventAgeInSeconds",
                    "DataType": "String"
                }
                "IS_PAYLOAD_TRUNCATED": {
                    "StringValue": "false",
                    "DataType": "String"
                },
                "RETRY_ATTEMPTS": {
                    "StringValue": "0",
                    "DataType": "String"
                },
                "SCHEDULED_TIME": {
                    "StringValue": "2022-05-14T01:12:00Z",
                    "DataType": "String"
                },
                "SCHEDULE_ARN": {
                    "StringValue": "arn:aws:scheduler:us-west-2:123456789012:schedule/DLQ-test",
                    "DataType": "String"
                },
                "TARGET_ARN": {
                    "StringValue": "arn:aws:scheduler:::aws-sdk:sqs:sendMessage",
                    "DataType": "String"
                }
            }
        }
    ]
}

Observe os atributos a seguir no evento de mensagens não entregues para ajudá-lo a identificar e solucionar possíveis motivos pelos quais a inovação do destino falhou.

No exemplo anterior, podemos determinar, com base no código de erro e na mensagem de erro, que a fila de destino que especificamos para o agendamento não existe.