Coletar remotamente logs de diagnóstico de dispositivos usando a atualização de dispositivo para Hub IoT

Saiba como iniciar uma operação de log de Atualização de dispositivo para Hub IoT e exibir logs coletados no armazenamento de Blobs do Azure.

Pré-requisitos

• Acesso a um Hub IoT com Atualização de Dispositivo para Hub IoT habilitada.
• Um dispositivo IoT (ou simulador) provisionado para atualização de dispositivo no Hub IoT e implementando a interface de diagnóstico.
• Uma conta de armazenamento de Blobs do Azure na mesma assinatura que a conta de Atualização de Dispositivo para Hub IoT.

Observação

O recurso de coleta de log remoto é atualmente compatível apenas com dispositivos que implementam a interface de diagnóstico e são capazes de carregar arquivos para o armazenamento de Blobs do Azure. A implementação do agente de referência também espera que o dispositivo grave arquivos de log em um caminho de arquivo especificado pelo usuário no dispositivo.

Azure portal

Navegadores compatíveis:

• Microsoft Edge
• Google Chrome

CLI do Azure

Um ambiente da CLI do Azure:

• Use o ambiente Bash no Azure Cloud Shell.

  

• Ou, se preferir executar os comandos de referência da CLI localmente, instale a CLI do Azure

  • Entre na CLI do Azure usando o comando az login.
  • Execute az version para localizar a versão e as bibliotecas dependentes que estão instaladas. Para fazer a atualização para a versão mais recente, execute az upgrade.
  • Quando solicitado, instale as extensões da CLI do Azure no primeiro uso. Os comandos neste artigo usam a extensão azure-iot. Execute az extension update --name azure-iot para verificar se está usando a versão mais recente da extensão.

Dica

Os comandos da CLI do Azure neste artigo usam o caractere de barra invertida \ para continuação de linha para que os argumentos de comando sejam mais fáceis de ler. Essa sintaxe funciona em ambientes Bash. Se você estiver executando esses comandos no PowerShell, substitua cada barra invertida por um acento grave ``` ou remova-as inteiramente.

Vincular a conta de armazenamento de blobs do Azure à instância de atualização de dispositivo

Para usar o recurso de coleta de log remoto, você deve primeiro vincular uma conta de armazenamento de blobs do Azure à sua instância de atualização de dispositivo. Essa conta de armazenamento de blobs do Azure é onde os dispositivos carregarão os logs de diagnóstico.

Azure portal

1. No portal do Azure, navegue até a conta da Atualização de Dispositivo para Hub IoT.

2. Selecione Instâncias na seção Gerenciamento de Instância do painel de navegação.

3. Selecione a instância de atualização de dispositivo na lista e, em seguida, Configurar Diagnóstico.

4. Selecione a guia Diagnóstico de cliente e Selecionar Conta de Armazenamento do Azure.

5. Escolha a conta de armazenamento desejada na lista e selecione Salvar.

6. Depois de voltar na lista de instâncias, selecione Atualizar periodicamente até que o estado de provisionamento da instância mostre "Êxito". Isso geralmente leva de 2 a 3 minutos.

CLI do Azure

Use o comando az iot du instance create para configurar os diagnósticos da instância de atualização de dispositivo.

Dica

Você pode usar o comando az iot du instance create em instâncias de Atualização de Dispositivo existentes e ele configurará a instância com os parâmetros atualizados.

Substitua os espaços reservados a seguir com suas próprias informações:

• <account_name>: o nome da sua conta de atualização de dispositivo.
• <instance_name>: o nome da sua instância de atualização de dispositivo.
• <storage_id>: a ID do recurso da conta de armazenamento em que os logs de diagnóstico serão armazenados. Você pode recuperar a ID do recurso usando o comando az storage show e consultando o valor da ID: az storage account show -n <storage_name> --query id.

az iot du instance update --account <account_name> --instance <instance_name> --set enableDiagnostics=true diagnosticStorageProperties.resourceId=<storage_id>

Configurar coleta de log

O tamanho máximo do arquivo é definido por um arquivo de configuração no dispositivo, localizado em /etc/adu/du-diagnostics-config.json no agente de referência.

Caminhos de arquivo da coleção de logs

O agente de atualização de dispositivo em um dispositivo coletará arquivos de caminhos de arquivo específicos no dispositivo quando ele receber um sinal de início de carregamento de log do serviço de atualização de dispositivo. Esses caminhos de arquivo são definidos no arquivo de configuração de diagnóstico.

Dentro do arquivo de configuração, cada arquivo de log a ser coletado e carregado é representado como um objeto logComponent com as propriedades componentName e logPath. Essa configuração pode ser modificada conforme desejado.

Tamanho máximo do arquivo de log

O agente de atualização de dispositivo coletará somente arquivos de log com um determinado tamanho de arquivo. Esse tamanho máximo do arquivo é definido no arquivo de configuração de diagnóstico.

O parâmetro relevante " "maxKilobytesToUploadPerLogPath" será aplicado a cada objeto logComponent e poderá ser modificado conforme desejado.

Criar uma operação de log

As operações de log são uma nova ação direcionada para serviços que você pode instruir seus dispositivos IoT a executar por meio do serviço de atualização de dispositivo. Para obter uma explicação mais detalhada de como as operações de log funcionam, confira diagnóstico de atualização de dispositivo.

Azure portal

1. Navegue até o Hub IoT e selecione a guia Atualizações na seção Gerenciamento de dispositivo do painel de navegação.

2. Selecione a guia Diagnóstico na IU. Se você não vê uma guia diagnóstico, verifique se está usando a versão mais recente da interface de usuário da Atualização de Dispositivo para Hub IoT. Se você não ver "o diagnóstico deve ser habilitado para esta instância de atualização de dispositivo", verifique se você vinculou uma conta de armazenamento de blobs do Azure à sua instância de atualização de dispositivo.

3. Selecione Adicionar operação de upload de log para navegar até a página de criação da operação de log.

4. Insira um nome (ID) e uma descrição para a nova operação de log e, em seguida, selecione Adicionar dispositivos para selecionar os dispositivos IoT dos quais você deseja coletar logs de diagnóstico.

5. Selecione Adicionar.

6. Após voltar na guia diagnóstico, selecione Atualizar até ver a operação de log listada na tabela de operações.

7. Quando o status da operação for Com êxito ou Com falha, selecione o nome da operação para exibir seus detalhes. Uma operação será marcada "com êxito" somente se todos os dispositivos de destino tiverem concluído com êxito o carregamento de log. Se alguns dispositivos de destino tiverem êxito e outros falharem, a operação de log será marcada como "Com falha". Você pode usar a folha detalhes da operação de log para ver quais dispositivos tiveram êxito e quais falharam.

8. Nos detalhes da operação de log, você pode exibir o status específico do dispositivo e ver o caminho do local do log. Esse caminho corresponde ao caminho do diretório virtual na sua conta de armazenamento de blobs do Azure em que os logs de diagnóstico foram carregados.

CLI do Azure

Use o comando az iot du device log collect para configurar uma operação de coleta de log de diagnóstico.

O comando device log collect usa os seguintes argumentos:

• --account: o nome da conta de atualização de dispositivo.
• --instance: o nome da instância de atualização de dispositivo.
• --log-collection-id: um nome para a operação de coleta de log.
• --agent-id: pares chave=valor que identificam um agente de atualização de dispositivo de destino para essa operação de coleta de log. Use deviceId=<device name> se o agente tiver uma identidade de dispositivo. Use deviceId=<device name> moduleId=<module name> se o agente tiver uma identidade do módulo. É possível usar o parâmetro --agent-id várias vezes para direcionar vários dispositivos.

Por exemplo:

az iot du device log collect \
    --account <Device Update account name> \
    --instance <Device Update instance name> \
    --log-collection-id <log collection name} \
    --agent-id deviceId=<device name> \
    --agent-id deviceId=<device name> moduleId=<module name>

Use az iot du device log show para exibir os detalhes de uma operação de coleta de log de diagnóstico específica.

az iot du device log show \
    --account <Device Update account name> \
    --instance <Device Update instance name> \
    --log-collection-id <log collection name>

Exibir e exportar logs de diagnóstico coletados

1. Após a operação de log obter êxito, navegue até sua conta de armazenamento de blobs do Azure.

2. Selecione contêineres na seção armazenamento de dados do painel de navegação.

3. Selecione o contêiner com o mesmo nome da sua instância de atualização de dispositivo.

4. Use o caminho do local do log nos detalhes da operação de log para navegar até o diretório correto que contém os logs. Por padrão, o recurso de coleta de log remoto instrui os dispositivos de destino a carregar os logs de diagnóstico usando o seguinte modelo de caminho de diretório: contêiner de armazenamento de blob/ID do dispositivo de destino/ID da operação de log/caminho do log no dispositivo

5. Se você não modificou o componente de diagnóstico do agente de Atualização de Dispositivo, o dispositivo responderá a qualquer operação de log tentando carregar dois arquivos de log de texto não criptografado: o log de diagnóstico do agente de Atualização de Dispositivo ("aduc.log") e o log de diagnóstico do agente DO ("do-agent.log"). Para saber mais sobre quais arquivos de log o agente de referência de Atualização de Dispositivo coleta, leia a página de conceito para Diagnóstico de Atualização de Dispositivo.

6. Você pode exibir o conteúdo do arquivo de log selecionando o nome do arquivo e, em seguida, selecionando o elemento de menu (reticências) e clicando em Exibir/editar. Você também pode baixar ou excluir o arquivo de log selecionando as opções rotuladas respectivamente.

   

Próximas etapas

Para saber mais sobre os recursos de diagnóstico da Atualização de Dispositivo, confira a visão geral do recurso de diagnóstico de atualização do dispositivo