Receber notificações de status de integridade de componentes e implantações - AWS IoT Greengrass
Evento de alteração de status da implantaçãoEvento de alteração de status do componentePré-requisitos para criar regras do EventBridgeConfigurar notificações de integridade do dispositivo (console)Configurar notificações de integridade do dispositivo (CLI)Configurar notificações de saúde do dispositivo (CloudFormation)Consulte também

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á.

Receber notificações de status de integridade de componentes e implantações

As regras de eventos do Amazon EventBridge fornecem notificações sobre alterações de estado para suas implantações do Greengrass recebidas por seus dispositivos e para componentes instalados em seu dispositivo. O EventBridge é um fluxo quase em tempo real de eventos de sistema que descrevem mudanças nos recursos da AWS. O AWS IoT Greengrass envia esses eventos ao EventBridge, com base no melhor esforço. Isso significa que o AWS IoT Greengrass tenta enviar todos os eventos para o EventBridge, mas, em alguns casos raros, um evento pode não ser entregue. Além disso, o AWS IoT Greengrass poderá enviar várias cópias de um determinado evento, o que significa que os receptores do evento talvez não os receberão na ordem em que ocorreram.

nota

O Amazon EventBridge é um serviço de barramento de eventos que você pode usar para conectar aplicações a dados de diversas origens, como os dispositivos principais do Greengrass e as notificações de componente e implantação. Para obter mais informações, consulte O que é Amazon EventBridge? no Manual do Usuário do Amazon EventBridge.

Evento de alteração de status da implantação

O AWS IoT Greengrass emite um evento quando uma implantação entra nos seguintes estados: FAILED, SUCCEEDED, COMPLETED, REJECTED e CANCELED. Você pode criar uma regra do EventBridge que é executada para todas as transições de estado ou transições para os estados especificados. Quando uma implantação entra em um estado que inicia uma regra, o EventBridge invoca as ações de destino definidas na regra. Isso permite enviar notificações, capturar informações de eventos, executar ações corretivas ou iniciar outros eventos em resposta a uma alteração de estado. Por exemplo, você pode criar regras para os seguintes casos de uso:

  • Iniciar operações pós-implantação, como fazer download de ativos e notificar a equipe.

  • Enviar notificações após uma implantação bem-sucedida ou com falha.

  • Publicar métricas personalizadas sobre eventos de implantação.

O evento para uma alteração no estado da implantação usa o seguinte formato:

{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Effective Deployment Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail":{    
        "deploymentId": "4f38f1a7-3dd0-42a1-af48-EXAMPLE09681",
        "coreDeviceExecutionStatus": "FAILED|SUCCEEDED|COMPLETED|REJECTED|CANCELED",
        "statusDetails": {
          "errorStack": ["DEPLOYMENT_FAILURE", "ARTIFACT_DOWNLOAD_ERROR", "S3_ERROR", "S3_ACCESS_DENIED", "S3_HEAD_OBJECT_ACCESS_DENIED"],
          "errorTypes": ["DEPENDENCY_ERROR", "PERMISSION_ERROR"],
        },
        "reason": "S3_HEAD_OBJECT_ACCESS_DENIED: FAILED_NO_STATE_CHANGE: Failed to download artifact name: 's3://pentest27/nucleus/281/aws.greengrass.nucleus.zip' for component aws.greengrass.Nucleus-2.8.1, reason: S3 HeadObject returns 403 Access Denied. Ensure the IAM role associated with the core device has a policy granting s3:GetObject. null (Service: S3, Status Code: 403, Request ID: HR94ZNT2161DAR58, Extended Request ID: wTX4DDI+qigQt3uzwl9rlnQiYlBgwvPm/KJFWeFAn9t1mnGXTms/luLCYANgq08RIH+x2H+hEKc=)"
     }
}

Você pode criar regras e eventos que o atualizarão sobre o status de uma implantação. Um evento é iniciado quando uma implantação é concluída como FAILED, SUCCEEDED, COMPLETED, REJECTED ou CANCELED. Se a implantação falhar no dispositivo principal, você receberá uma resposta detalhada que explica por que a implantação falhou. Para obter mais informações sobre códigos de erro da implantação, consulte Códigos detalhados de erros de implantação.

Estados de implantação

  • FAILED. Houve falha na implantação.

  • SUCCEEDED. A implantação direcionada a um grupo de objetos foi concluída com sucesso.

  • COMPLETED. A implantação direcionada a um objeto foi concluída com sucesso.

  • REJECTED. A implantação foi rejeitada. Para mais informações, consulte o campo statusDetails.

  • CANCELED. A implantação foi cancelada pelo usuário.

É possível que os eventos estejam duplicados ou fora de ordem. Para determinar a ordem dos eventos, use a propriedade time.

Para uma lista completa dos códigos de erro em errorStacks e errorTypes, consulte Códigos detalhados de erros de implantação e Códigos detalhados de status de componente.

Evento de alteração de status do componente

Para as versões 2.12.2 do AWS IoT Greengrass e anteriores, o Greengrass emite um evento quando um componente entra nos seguintes estados: ERRORED e BROKEN. Para as versões 2.12.3 e posteriores do núcleo do Greengrass, o Greengrass emite um evento quando um componente entra nos seguintes estados: ERRORED, BROKEN, RUNNING e FINISHED. O Greengrass também emitirá um evento quando a implantação for concluída. Você pode criar uma regra do EventBridge que é executada para todas as transições de estado ou transições para os estados especificados. Quando um componente instalado entra em um estado que inicia uma regra, o EventBridge invoca as ações de destino definidas na regra. Isso permite enviar notificações, capturar informações de eventos, executar ações corretivas ou iniciar outros eventos em resposta a uma alteração de estado.

O evento para uma mudança de estado de componente usa os seguintes formatos:

Greengrass nucleus v2.12.2 and earlier

Status do componente: ERRORED ou BROKEN

{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Installed Component Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail": {
       "components": [
          {
            "componentName": "MyComponent",
            "componentVersion": "1.0.0",
            "root": true,
            "lifecycleState": "ERRORED|BROKEN",
            "lifecycleStatusCodes": ["STARTUP_ERROR"],
            "lifecycleStateDetails": "An error occurred during startup. The startup script exited with code 1."
          }
        ]
    }
}
Greengrass nucleus v2.12.3 and later

Status do componente: ERRORED ou BROKEN

{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Installed Component Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail": {
       "components": [
          {
            "componentName": "MyComponent",
            "componentVersion": "1.0.0",
            "root": true,
            "lifecycleState": "ERRORED|BROKEN",
            "lifecycleStatusCodes": ["STARTUP_ERROR"],
            "lifecycleStateDetails": "An error occurred during startup. The startup script exited with code 1."
          }
        ]
    }
}

Status do componente: RUNNING ou FINISHED

{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Installed Component Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail": {
       "components": [
          {
            "componentName": "MyComponent",
            "componentVersion": "1.0.0",
            "root": true,
            "lifecycleState": "RUNNING|FINISHED",
            "lifecycleStateDetails": null
          }
        ]
    }
}

Você pode criar regras e eventos que o atualizarão sobre o status de um componente instalado. Um evento é iniciado quando um componente muda de estado no dispositivo. Você receberá uma resposta detalhada que explica por que um componente está errado ou com falhas. Você também receberá um código de status que indicará o motivo da falha. Para obter mais informações sobre códigos de status de componentes, consulte Códigos detalhados de status de componente.

Pré-requisitos para criar regras do EventBridge

Antes de criar uma regra do EventBridge para AWS IoT Greengrass, faça o seguinte:

  • Familiarize-se com os eventos, regras e destinos no EventBridge.

  • Crie e configure os destinos invocados por suas regras do EventBridge. As regras podem invocar muitos tipos de destinos, incluindo:

    • Amazon Simple Notification Service (Amazon SNS)

    • Funções do AWS Lambda

    • Amazon Kinesis Video Streams

    • Filas do Amazon Simple Queue Service (Amazon SQS)

Para obter mais informações, consulte O que é o Amazon EventBridge e Começar a usar o Amazon EventBridge no Manual do usuário do Amazon EventBridge.

Configurar notificações de integridade do dispositivo (console)

Use as etapas a seguir para criar uma regra do EventBridge que publica um tópico do Amazon SNS quando o estado de implantação é alterado para um grupo. Isso permite que servidores web, endereços de e-mail e outros assinantes de tópicos respondam ao evento. Para obter mais informações, consulte Criando uma regra do EventBridge que aciona um evento de um recurso da AWS no Guia do usuário do Amazon EventBridge.

  1. Abra o console do Amazon EventBridge.

  2. No painel de navegação, selecione Rules (Regras).

  3. Escolha Create rule.

  4. Insira um nome e uma descrição para a regra.

    Uma regra não pode ter o mesmo nome que outra na mesma Região e barramento de eventos.

  5. Em Barramento de eventos, selecione o barramento de eventos que você deseja associar a essa regra. Se quiser que essa regra faça a correspondência com eventos provenientes da sua conta, escolha Barramento de eventos padrão da AWS. Quando um serviço AWS em sua conta emite um evento, ele sempre irá para o barramento de eventos padrão da conta.

  6. Em Tipo de Regra, escolha Regra com Padrão de Evento.

  7. Escolha Próximo.

  8. Em Origem de eventos, escolha Eventos da AWS.

  9. Em Padrão do evento, selecione Serviços da AWS.

  10. Em Serviço da AWS, selecione Greengrass.

  11. Para o Tipo de evento, escolha entre as seguintes opções:

    • Para eventos de implantação, escolha Alteração do status de implantação efetiva do Greengrass V2.

    • Para eventos de componentes, escolha Alteração de status do componente instalado do Greengrass V2.

  12. Escolha Próximo.

  13. Em Target types (Tipos de destinos), selecione AWS service (Serviço da ).

  14. Em Selecionar um destino, configure seu destino. Este exemplo usa um tópico do Amazon SNS, mas você pode configurar outros tipos de destino para enviar notificações.

    1. Em Target (Destino), selecione SNS topic (Tópico do SNS).

    2. Em Topic (Tópico), selecione o tópico de destino.

    3. Escolha Próximo.

  15. Escolha Próximo.

  16. Analise os detalhes da regra e selecione Criar regra.

Configurar notificações de integridade do dispositivo (CLI)

Use as etapas a seguir para criar uma regra do EventBridge que publique um tópico do Amazon SNS quando houver um evento de alteração de status do Greengrass. Isso permite que servidores web, endereços de e-mail e outros assinantes de tópicos respondam ao evento.

  1. Crie a regra.

    • Para eventos de alteração de status de implantação.

      aws events put-rule \
  --name TestRule \
  --event-pattern "{\"source\": [\"aws.greengrass\"], \"detail-type\": [\"Greengrass V2 Effective Deployment Status Change\"]}"

    • Para eventos de alteração de status do componente.

      aws events put-rule \
  --name TestRule \
  --event-pattern "{\"source\": [\"aws.greengrass\"], \"detail-type\": [\"Greengrass V2 Installed Component Status Change\"]}"

    As propriedades que são omitidas do padrão são ignoradas.

  2. Adicione o tópico como um destino de regra.

    • Substitua topic-arn pelo ARN do tópico do Amazon SNS.

    aws events put-targets \
  --rule TestRule \
  --targets "Id"="1","Arn"="topic-arn"
    nota

    Para permitir que o Amazon EventBridge chame o tópico de destino, você deve adicionar uma política baseada em recursos ao tópico. Para obter mais informações, consulte Permissões do Amazon SNS no Manual do usuário do Amazon EventBridge.

Para obter mais informações, consulte Eventos e padrões de eventos no EventBridge no Manual do usuário do Amazon EventBridge.

Configurar notificações de saúde do dispositivo (CloudFormation)

Use modelos do CloudFormation para criar regras do EventBridge que enviam notificações sobre alterações de estado para suas implantações de grupo do Greengrass. Para obter mais informações, consulte Referência do tipo de recursos do Amazon EventBridge no Guia do usuário do AWS CloudFormation.

Consulte também