

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

# Configurar CloudWatch registros para atualizações do OTA
<a name="ota-logging"></a>

O serviço de atualização OTA oferece suporte ao registro na Amazon CloudWatch. Você pode usar o AWS IoT console para habilitar e configurar o Amazon CloudWatch Logging para atualizações OTA. Para obter mais informações, consulte [Cloudwatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html).

Para habilitar o registro em log, é necessário criar um perfil do IAM e configurar o registro em log de atualizações OTA.

**nota**  
Antes de ativar o registro de atualizações do OTA, certifique-se de entender as permissões de acesso aos CloudWatch registros. Os usuários com acesso aos CloudWatch registros podem ver suas informações de depuração. Para obter informações, consulte [Autenticação e controle de acesso para Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/auth-and-access-control-cwl.html).

## Criação de uma função de registro em log e habilitar o registro em log
<a name="create-ota-logging-role"></a>

Use o [console do AWS IoT](https://console.aws.amazon.com/iot/home) para criar uma função de registro em log e habilitar esse registro.

1. No painel de navegação, escolha **Settings (Configurações)**.

1. Em **Logs**, escolha **Edit (Editar)**.

1. Em **Level of verbosity (Nível de verbosidade)**, escolha **Debug (Depuração)**.

1. Em **Definir perfil**, escolha **Criar** para criar um perfil do IAM para o registro em log.

1. Em **Name (Nome)**, insira um nome único para a função. A função será criada com todas as permissões necessárias.

1. Selecione **Atualizar**.

## Logs de atualização de OTA
<a name="ota-logs"></a>

O serviço de atualização OTA publica logs na conta quando ocorre uma das situações a seguir:
+ Uma atualização OTA é criada.
+ Uma atualização OTA é concluída.
+ Um trabalho de assinatura de código é criado.
+ Um trabalho de assinatura de código é concluído.
+ Um AWS IoT emprego é criado.
+ Um AWS IoT trabalho está concluído.
+ Um fluxo é criado.

Você pode ver os logs no [console do CloudWatch ](https://console.aws.amazon.com/cloudwatch/home).

**Para ver uma atualização do OTA em CloudWatch Logs**

1. Na página de navegação, escolha **Logs**.

1. Em **Grupos de logs**, escolha **AWSIoTLogsV2**.

Os logs de atualização OTA podem conter as seguintes propriedades:

**accountId**  
O ID da AWS conta na qual o registro foi gerado.

**actionType**  
A ação que gerou o log. Isso pode ser definido como um dos seguintes valores:  
+ `CreateOTAUpdate`: uma atualização OTA foi criada.
+ `DeleteOTAUpdate`: uma atualização OTA foi excluída.
+ `StartCodeSigning`: um trabalho de assinatura de código foi iniciado.
+ `CreateAWSJob`: Um AWS IoT emprego foi criado.
+ `CreateStream`: um fluxo foi criado.
+ `GetStream`: uma solicitação de stream foi enviada para o recurso de entrega de arquivos AWS IoT baseado em MQTT.
+ `DescribeStream`: uma solicitação de informações sobre um fluxo foi enviada para o recurso de entrega de arquivos baseado em MQTT do AWS IoT .

**awsJobId**  
O ID do AWS IoT trabalho que gerou o registro.

**clientId**  
O ID do cliente MQTT que fez a solicitação que gerou o log.

**clientToken**  
O token do cliente associado à solicitação que gerou o log.

**detalhes**  
Mais informações sobre a operação que gerou o log.

**logLevel**  
O nível de registro do log. Para logs de atualização OTA, isso é sempre definido como `DEBUG`.

**otaUpdateId**  
O ID da atualização OTA que gerou o log.

**protocolo**  
O protocolo usado para fazer a solicitação que gerou o log.

**status**  
O status da operação que gerou o log. Os valores válidos são:  
+ Bem-sucedida
+ Falha

**streamId**  
O ID do AWS IoT stream que gerou o log.

**timestamp**  
A hora em que o log foi gerado.

**topicName**  
Um tópico MQTT usado para fazer a solicitação que gerou o log.

### Logs de exemplo
<a name="ota-example-logs"></a>

Veja a seguir um exemplo de log gerado quando um trabalho de assinatura de código é iniciado:

```
{ 
    "timestamp": "2018-07-23 22:59:44.955", 
    "logLevel": "DEBUG", 
    "accountId": "123456789012", 
    "status": "Success", 
    "actionType": "StartCodeSigning", 
    "otaUpdateId": "08957b03-eea3-448a-87fe-743e6891ca3a", 
    "details": "Start code signing job. The request status is SUCCESS." 
}
```

Veja a seguir um exemplo de registro gerado quando um AWS IoT trabalho é criado:

```
{ 
    "timestamp": "2018-07-23 22:59:45.363", 
    "logLevel": "DEBUG", 
    "accountId": "123456789012", 
    "status": "Success", 
    "actionType": "CreateAWSJob", 
    "otaUpdateId": "08957b03-eea3-448a-87fe-743e6891ca3a", 
    "awsJobId": "08957b03-eea3-448a-87fe-743e6891ca3a", 
    "details": "Create AWS Job The request status is SUCCESS." 
}
```

Veja a seguir um log de exemplo gerado quando uma atualização OTA é criada:

```
{ 
    "timestamp": "2018-07-23 22:59:45.413", 
    "logLevel": "DEBUG", 
    "accountId": "123456789012", 
    "status": "Success", 
    "actionType": "CreateOTAUpdate", 
    "otaUpdateId": "08957b03-eea3-448a-87fe-743e6891ca3a", 
    "details": "OTAUpdate creation complete. The request status is SUCCESS." 
}
```

Veja a seguir um log de exemplo gerado quando um fluxo é criado:

```
{ 
    "timestamp": "2018-07-23 23:00:26.391", 
    "logLevel": "DEBUG", 
    "accountId": "123456789012", 
    "status": "Success", 
    "actionType": "CreateStream", 
    "otaUpdateId": "3d3dc5f7-3d6d-47ac-9252-45821ac7cfb0", 
    "streamId": "6be2303d-3637-48f0-ace9-0b87b1b9a824", 
    "details": "Create stream. The request status is SUCCESS." 
}
```

Veja a seguir um log de exemplo gerado quando uma atualização OTA é excluída:

```
{ 
    "timestamp": "2018-07-23 23:03:09.505", 
    "logLevel": "DEBUG", 
    "accountId": "123456789012", 
    "status": "Success", 
    "actionType": "DeleteOTAUpdate", 
    "otaUpdateId": "9bdd78fb-f113-4001-9675-1b595982292f", 
    "details": "Delete OTA Update. The request status is SUCCESS." 
}
```

Veja a seguir um log de exemplo gerado quando um dispositivo solicita um fluxo do de um recurso de entrega de arquivos baseado em MQTT:

```
{ 
    "timestamp": "2018-07-25 22:09:02.678", 
    "logLevel": "DEBUG", 
    "accountId": "123456789012", 
    "status": "Success", 
    "actionType": "GetStream", 
    "protocol": "MQTT", 
    "clientId": "b9d2e49c-94fe-4ed1-9b07-286afed7e4c8", 
    "topicName": "$aws/things/b9d2e49c-94fe-4ed1-9b07-286afed7e4c8/streams/1e51e9a8-9a4c-4c50-b005-d38452a956af/get/json", 
    "streamId": "1e51e9a8-9a4c-4c50-b005-d38452a956af", 
    "details": "The request status is SUCCESS." 
}
```

Veja a seguir um exemplo de log gerado quando um dispositivo chama a API `DescribeStream`:

```
{ 
    "timestamp": "2018-07-25 22:10:12.690", 
    "logLevel": "DEBUG", 
    "accountId": "123456789012", 
    "status": "Success", 
    "actionType": "DescribeStream", 
    "protocol": "MQTT", 
    "clientId": "581075e0-4639-48ee-8b94-2cf304168e43", 
    "topicName": "$aws/things/581075e0-4639-48ee-8b94-2cf304168e43/streams/71c101a8-bcc5-4929-9fe2-af563af0c139/describe/json", 
    "streamId": "71c101a8-bcc5-4929-9fe2-af563af0c139", 
    "clientToken": "clientToken", 
    "details": "The request status is SUCCESS." 
}
```