Raccogliere in remoto i log di diagnostica dai dispositivi usando Aggiornamento dispositivi per hub IoT

Informazioni su come avviare un aggiornamento del dispositivo per hub IoT operazione di log e visualizzare i log raccolti nell'archivio BLOB di Azure.

Prerequisiti

• Accesso a un hub IoT con Aggiornamento del dispositivo per hub IoT abilitato.
• Provisioning di un dispositivo IoT (o simulatore) per l'aggiornamento dei dispositivi all'interno di hub IoT e l'implementazione dell'interfaccia di diagnostica.
• Un account di archiviazione BLOB di Azure nella stessa sottoscrizione dell'aggiornamento del dispositivo per hub IoT account.

Nota

La funzionalità di raccolta di log remoti è attualmente compatibile solo con i dispositivi che implementano l'interfaccia di diagnostica e possono caricare file nell'archivio BLOB di Azure. L'implementazione dell'agente di riferimento prevede anche che il dispositivo scriva i file di log in un percorso di file specificato dall'utente nel dispositivo.

Azure portal

Browser supportati:

• Microsoft Edge
• Google Chrome

Interfaccia della riga di comando di Azure

Un ambiente dell'interfaccia della riga di comando di Azure:

• Usare l'ambiente Bash in Azure Cloud Shell.

  

• In alternativa, se si preferisce eseguire i comandi di riferimento dell'interfaccia della riga di comando in locale, installare l'interfaccia della riga di comando di Azure

  • Accedere all'interfaccia della riga di comando di Azure usando il comando az login .
  • Eseguire az version per trovare la versione e le librerie dipendenti installate. Per eseguire l'aggiornamento alla versione più recente, eseguire az upgrade.
  • Quando richiesto, installare le estensioni dell'interfaccia della riga di comando di Azure al primo utilizzo. I comandi in questo articolo usano l'estensione azure-iot . Eseguire az extension update --name azure-iot per assicurarsi di usare la versione più recente dell'estensione.

Suggerimento

I comandi dell'interfaccia della riga di comando di Azure in questo articolo usano il carattere barra \ rovesciata per la continuazione della riga in modo che gli argomenti del comando siano più facili da leggere. Questa sintassi funziona negli ambienti Bash. Se si eseguono questi comandi in PowerShell, sostituire ogni barra rovesciata con una barra rovesciata "" o rimuoverli completamente.

Collegare l'account di archiviazione BLOB di Azure all'istanza di Aggiornamento dispositivi

Per usare la funzionalità di raccolta di log remoti, è prima necessario collegare un account di archiviazione BLOB di Azure all'istanza di Aggiornamento dispositivi. Questo account di archiviazione BLOB di Azure è la posizione in cui i dispositivi caricheranno i log di diagnostica.

Azure portal

1. Nella portale di Azure passare all'aggiornamento del dispositivo per hub IoT account.

2. Selezionare Istanze nella sezione Gestione istanze del riquadro di spostamento.

3. Selezionare l'istanza di Aggiornamento dispositivi dall'elenco e quindi Configurare la diagnostica.

4. Selezionare la scheda Diagnostica cliente, quindi Selezionare Archiviazione di Azure Account.

5. Scegliere l'account di archiviazione desiderato dall'elenco e selezionare Salva.

6. Quando si torna all'elenco di istanze, selezionare Aggiorna periodicamente fino a quando lo stato di provisioning dell'istanza non mostra "Succeeded". Questo processo richiede in genere 2-3 minuti.

Interfaccia della riga di comando di Azure

Usare il comando az iot du instance create per configurare la diagnostica per l'istanza di Aggiornamento dispositivi.

Suggerimento

È possibile usare il az iot du instance create comando in un'istanza di Aggiornamento dispositivi esistente e configurerà l'istanza con i parametri aggiornati.

Sostituire i segnaposto seguenti con le proprie informazioni:

• <>account_name: nome dell'account di Aggiornamento dispositivi.
• <>instance_name: nome dell'istanza di Aggiornamento dispositivi.
• <>storage_id: ID risorsa dell'account di archiviazione in cui verranno archiviati i log di diagnostica. È possibile recuperare l'ID risorsa usando il comando az storage show ed eseguendo query sul valore 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>

Configurare la raccolta di log

L'agente di aggiornamento del dispositivo fa riferimento a un file di configurazione nel dispositivo, che si trova in /etc/adu/du-diagnostics-config.json nell'agente di riferimento.

Percorsi dei file di raccolta log

L'agente di Aggiornamento dispositivi in un dispositivo raccoglierà i file da percorsi di file specifici nel dispositivo quando riceve un segnale di avvio del caricamento del log dal servizio Aggiornamento dispositivi. Questi percorsi di file vengono definiti nel file di configurazione della diagnostica.

All'interno del file di configurazione, ogni file di log da raccogliere e caricare viene rappresentato come oggetto logComponent con proprietà componentName e logPath. Questa configurazione può essere modificata in modo desiderato.

Dimensioni massime del file di log

L'agente di Aggiornamento dispositivi raccoglierà solo i file di log con una determinata dimensione del file. Questa dimensione massima del file è definita nel file di configurazione di diagnostica.

Il parametro pertinente "maxKilobytesToUploadPerLogPath" verrà applicato a ogni oggetto logComponent e può essere modificato in base alle esigenze.

Creare un'operazione di log

Le operazioni di log sono un'azione guidata dal servizio che è possibile indicare ai dispositivi IoT di eseguire tramite il servizio Aggiornamento dispositivi. Per una spiegazione più dettagliata del funzionamento delle operazioni di log, vedere Diagnostica degli aggiornamenti dei dispositivi.

Azure portal

1. Passare al hub IoT e selezionare la scheda Aggiornamenti nella sezione Gestione dispositivi del riquadro di spostamento.

2. Selezionare la scheda Diagnostica nell'interfaccia utente. Se non viene visualizzata una scheda Diagnostica, assicurarsi di usare la versione più recente di Aggiornamento dispositivi per hub IoT interfaccia utente. Se viene visualizzato "La diagnostica deve essere abilitata per questa istanza di Aggiornamento dispositivi", assicurarsi di aver collegato un account di archiviazione BLOB di Azure con l'istanza di Aggiornamento dispositivi.

3. Selezionare Aggiungi operazione di caricamento log per passare alla pagina di creazione dell'operazione di log.

4. Immettere un nome (ID) e una descrizione per la nuova operazione di log, quindi selezionare Aggiungi dispositivi per selezionare i dispositivi IoT da cui raccogliere i log di diagnostica.

5. Selezionare Aggiungi.

6. Quando si torna alla scheda Diagnostica, selezionare Aggiorna fino a visualizzare l'operazione di log elencata nella tabella delle operazioni.

7. Dopo che lo stato dell'operazione è Riuscito o Non riuscito, selezionare il nome dell'operazione per visualizzarne i dettagli. Un'operazione verrà contrassegnata come "Succeeded" solo se tutti i dispositivi di destinazione hanno completato correttamente il caricamento del log. Se alcuni dispositivi di destinazione hanno avuto esito positivo e alcuni non sono riusciti, l'operazione di log verrà contrassegnata come "Non riuscita". È possibile usare la pagina dei dettagli dell'operazione di log per visualizzare i dispositivi riusciti e gli errori.

8. Nei dettagli dell'operazione di log è possibile visualizzare lo stato specifico del dispositivo e visualizzare il percorso del percorso del log. Questo percorso corrisponde al percorso della directory virtuale all'interno dell'account di archiviazione BLOB di Azure in cui sono stati caricati i log di diagnostica.

Interfaccia della riga di comando di Azure

Usare il comando az iot du device log collect per configurare un'operazione di raccolta dei log di diagnostica.

Il device log collect comando accetta gli argomenti seguenti:

• --account: nome dell'account di Aggiornamento dispositivi.
• --instance: nome dell'istanza di Aggiornamento dispositivi.
• --log-collection-id: nome per l'operazione di raccolta dei log.
• --agent-id: coppie chiave=valore che identificano un agente di Aggiornamento dispositivi di destinazione per questa operazione di raccolta log. Usare deviceId=<device name> se l'agente ha un'identità del dispositivo. Usare deviceId=<device name> moduleId=<module name> se l'agente ha un'identità del modulo. È possibile usare il --agent-id parametro più volte per impostare più dispositivi come destinazione.

Ad esempio:

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>

Usare az iot du device log show per visualizzare i dettagli di un'operazione di raccolta dei log di diagnostica specifica.

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

Visualizzare ed esportare i log di diagnostica raccolti

1. Al termine dell'operazione di log, passare all'account di archiviazione BLOB di Azure.

2. Selezionare Contenitori nella sezione Archiviazione dati del riquadro di spostamento.

3. Selezionare il contenitore con lo stesso nome dell'istanza di Aggiornamento dispositivi.

4. Usare il percorso del log dai dettagli dell'operazione di log per passare alla directory corretta contenente i log. Per impostazione predefinita, la funzionalità di raccolta dei log remoti indica ai dispositivi di destinazione di caricare i log di diagnostica usando il modello di percorso di directory seguente: contenitore di archiviazione BLOB/ID dispositivo di destinazione/ID operazione log/percorso del log sul dispositivo

5. Se non è stato modificato il componente di diagnostica dell'agente di Aggiornamento dispositivi, il dispositivo risponderà a qualsiasi operazione di log provando a caricare due file di log in testo non crittografato: il log di diagnostica dell'agente di Aggiornamento dispositivi ("aduc.log") e il log di diagnostica dell'agente DO ("do-agent.log"). Per altre informazioni sui file di log raccolti dall'agente di riferimento di Aggiornamento dispositivi, leggere la pagina del concetto di diagnostica di Aggiornamento dispositivi.

6. È possibile visualizzare il contenuto del file di log selezionando il nome del file, quindi selezionando l'elemento di menu (puntini di sospensione) e facendo clic su Visualizza/modifica. È anche possibile scaricare o eliminare il file di log selezionando le opzioni etichettate rispettivamente.

   

Passaggi successivi

Per altre informazioni sulle funzionalità di diagnostica di Aggiornamento dispositivi, vedere Panoramica delle funzionalità di diagnostica degli aggiornamenti dei dispositivi