Vue d’ensemble des diagnostics dans Device Update pour IoT Hub

  • Article

Device Update pour IoT Hub propose plusieurs fonctionnalités pour vous aider à diagnostiquer et résoudre les erreurs côté appareil. Dans l’agent version 0.9.0, trois fonctionnalités de diagnostic sont disponibles :

  • Les codes d’erreur de déploiement peuvent être consultés directement dans l’interface utilisateur de Device Update.

  • La collecte de journaux à distance permet de créer des opérations de journalisation qui demandent le chargement des journaux de diagnostics se trouvant sur les appareils ciblés dans un compte Stockage Blob Azure lié.

  • Agent Check exécute des vérifications de validation sur les appareils inscrits auprès de votre instance Device Update dans le but de diagnostiquer les appareils qui sont inscrits dans Azure IoT Hub connecté, mais qui ne s’affichent pas dans Device Update.

Codes d’erreur de déploiement dans l’interface utilisateur

Quand un appareil signale un échec de déploiement au service Device Update, l’interface utilisateur de Device Update affiche les codes resultCode et extendedResultCode signalés de l’appareil dans l’interface utilisateur. Pour afficher ces codes, effectuez les étapes suivantes :

  1. Accédez à votre IoT Hub dans le portail Azure.

  2. Sélectionnez Mises à jour, puis accédez à l’onglet Groupes et déploiements.

  3. Sélectionnez le nom d’un groupe avec un déploiement actif pour accéder à la page Détails du groupe.

  4. Sélectionnez un nom d’appareil dans la Liste des appareils pour ouvrir le panneau de détails de l’appareil. Ici, vous pouvez voir le code résultat signalé par l’appareil.

  5. L’agent de référence Device Update respecte la convention des codes d’état HTTP standard pour le champ Code résultat (par exemple, « 200 » indique une réussite). Pour plus d’informations sur l’analyse des codes résultats, consultez les codes d’erreur du client Device Update.

    Notes

    Si vous avez modifié l’agent Device Update pour qu’il signale des codes résultats personnalisés, les codes numériques seront toujours transmis à l’interface utilisateur de Device Update. Vous pouvez ensuite vous référer à toute documentation que vous avez créée pour analyser ces codes numériques.

Collecte de journaux à distance

Si vous avez besoin d’autres informations contenues sur l’appareil pour diagnostiquer et résoudre une erreur, vous pouvez utiliser la fonctionnalité de collecte de journaux pour demander le chargement des journaux de diagnostics se trouvant sur les appareils ciblés dans un compte Stockage Blob Azure lié. Vous pouvez commencer à utiliser cette fonctionnalité en suivant les instructions dans Collecter à distance les journaux de diagnostic d’appareils.

La fonctionnalité de collecte de journaux à distance de Device Update est basée sur les opérations et pilotée par le service. Pour tirer parti de la collecte de journaux, un appareil doit simplement être en mesure d’implémenter l’interface de diagnostic et le fichier de configuration, et de charger des fichiers vers le Stockage Blob Azure par le biais d’un SDK.

Voici une vue d’ensemble du fonctionnement de la collecte de journaux :

  1. L’utilisateur crée une opération de journalisation en utilisant des API ou l’interface utilisateur de Device Update. Il peut cibler jusqu’à 100 appareils ayant implémenté l’interface de diagnostic.

  2. Le service Device Update envoie un message de démarrage de la collecte de journaux aux appareils ciblés utilisant l’interface de diagnostic. Ce message de démarrage comprend l’ID de l’opération de journalisation et un jeton SAS pour effectuer le chargement sur le compte de stockage Azure associé.

  3. Quand il reçoit le message de démarrage, l’agent Device Update de l’appareil ciblé tente de collecter et de charger les fichiers dans les éléments FilePath prédéfinis spécifiés dans le fichier de configuration de l’agent sur l’appareil. L’agent de référence Device Update est configuré par défaut pour charger le journal de diagnostic de l’agent Device Update (aduc.log) et celui de l’agent DO (do-agent.log).

  4. L’agent Device Update indique ensuite l’état de l’opération (réussite ou échec) au service, avec notamment l’ID de l’opération de journalisation et les codes ResultCode et ExtendedResultCode. Si l’agent Device Update ne parvient pas à effectuer une opération de journalisation, il réessaye automatiquement trois fois (seul le dernier état étant signalé au service).

  5. Une fois que tous les appareils ciblés ont signalé leur état terminal au service Device Update, le service Device Update marque l’opération de journalisation comme ayant réussi ou échoué. Une opération de journalisation réussie indique que tous les appareils ciblés ont réussi l’opération de journalisation. Un échec signifie qu’au moins un appareil ciblé n’a pas pu effectuer l’opération de journalisation.

    Notes

    L’opération de journalisation étant effectuée en parallèle par les appareils ciblés, il est possible que l’opération de journalisation globale soit marquée comme ayant échoué même si certains appareils ciblés ont réussi à charger les journaux. Pour identifier les appareils qui ont réussi et ceux qui ont échoué, examinez les détails de l’opération de journalisation par le biais de l’interface utilisateur ou des API.

Vérification de l’agent

Lorsque votre appareil est inscrit dans IoT Hub mais n’apparaît pas dans votre instance Device Update, vous pouvez utiliser la fonctionnalité Vérification de l’agent pour exécuter des vérifications de validation prédéfinies afin de vous aider à diagnostiquer le problème sous-jacent. Pour commencer à utiliser cette fonctionnalité, suivez ces instructions de vérification d’agent.

Voici une vue d’ensemble du fonctionnement de la vérification d’agent :

  • L’utilisateur inscrit un appareil auprès d’IoT Hub. Si l’appareil signale un ID de modèle qui correspond à ceux compatibles avec Device Update pour IoT Hub, l’instance Device Update connectée de l’utilisateur inscrit automatiquement l’appareil auprès de Device Update.

  • Pour qu’un appareil soit correctement géré par Device Update, il doit répondre à certains critères qui peuvent être vérifiés à l’aide des vérifications de validation prédéfinies de La vérification de l’agent. Vous trouverez plus d’informations sur ces critères ici.

  • Si un appareil ne répond pas à tous ces critères, il ne peut pas être correctement managé par Device Update et ne s’affiche pas dans l’interface Device Update ou les réponses d’API. Les utilisateurs peuvent utiliser la vérification de l’agent pour rechercher cet appareil et tenter d’identifier les critères qui ne sont pas remplis à l’aide de la vérification de l’agent.

  • Une fois que l’utilisateur a identifié les critères qui ne sont pas remplis, l’utilisateur peut corriger le problème et l’appareil doit alors apparaître correctement dans l’interface Device Update.

Étapes suivantes

Apprenez à utiliser les fonctions de collecte de journaux à distance et de vérification des agents de Device Update :