Удаленный сбор журналов диагностики с устройств с помощью Обновления устройств для Центра Интернета вещей

Узнайте, как инициировать обновление устройства для работы с журналом центра Интернета вещей и просматривать собранные журналы в хранилище BLOB-объектов Azure.

Необходимые компоненты

• Доступ к Центру Интернета вещей, для которого настроено Обновление устройств для Центра Интернета вещей.
• Устройство Интернета вещей (или симулятор), подготовленное для службы Обновления устройств в Центре Интернета вещей, и внедрение диагностического интерфейса.
• Учетная запись хранилища BLOB-объектов Azure в той же подписке, что и обновление устройства для учетной записи Центра Интернета вещей.

Примечание.

Функция удаленного сбора журналов в настоящее время совместима только с устройствами, которые реализуют диагностический интерфейс и могут отправлять файлы в хранилище BLOB-объектов Azure. Реализация ссылочного агента также предусматривает, что устройство будет записывать файлы журнала в указанный пользователем путь к файлу на устройстве.

Портал Azure

Поддерживаемые браузеры:

• Microsoft Edge
• Google Chrome

Azure CLI

Среда интерфейса командной строки Azure:

• Используйте среду Bash в Azure Cloud Shell.

  

• Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI

  • Выполните вход в Azure CLI с помощью команды az login.
  • Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.
  • При появлении запроса установите расширения Azure CLI при первом использовании. В командах в этой статье используется расширение azure-iot. Запустите az extension update --name azure-iot и убедитесь, что используется последняя версия расширения.

Совет

Команды Azure CLI в этой статье используют символ обратной косой черты \ для продолжения строки, чтобы аргументы команд были проще читать. Этот синтаксис работает в средах Bash. Если вы выполняете эти команды в PowerShell, замените каждую обратную косую черту обратной чертой "", или удалите их полностью.

Связывание учетной записи хранилища BLOB-объектов Azure с экземпляром обновления устройства

Чтобы использовать функцию удаленного сбора журналов, необходимо сначала связать учетную запись хранилища BLOB-объектов Azure с экземпляром обновления устройства. Эта учетная запись хранилища BLOB-объектов Azure позволяет устройствам отправлять журналы диагностики.

Портал Azure

1. На портале Azure перейдите к учетной записи Обновления устройств для Центра Интернета вещей.

2. Выберите Экземпляры в разделе Управление экземплярами области навигации.

3. Выберите из списка экземпляр Обновления устройства, а затем — Настроить диагностику.

4. Выберите вкладку Пользовательская диагностика, а затем Выбрать учетную запись службы хранилища Azure.

5. Выберите нужную учетную запись хранения в списке и нажмите кнопку Сохранить.

6. Вернувшись в список экземпляров, нажимайте Обновить, пока состояние подготовки экземпляра не отобразится как "Выполнено". Обычно это занимает 2–3 минуты.

Azure CLI

Используйте команду az iot du instance create, чтобы настроить диагностика для экземпляра обновления устройств.

Совет

Команду az iot du instance create можно использовать для существующих экземпляров Обновления устройств. Она настраивает экземпляр с обновленными параметрами.

Подставьте следующие заполнители, используя собственную информацию:

• <account_name>: имя учетной записи Обновления устройств.
• <instance_name>: имя экземпляра Обновления устройств.
• <storage_id>: идентификатор ресурса учетной записи хранения, в которой будут храниться журналы диагностики. Идентификатор ресурса можно получить с помощью команды az storage show и запроса значения идентификатора: 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>

Настройка сбора журналов

Агент обновления устройств ссылается на файл конфигурации на устройстве, расположенный по пути /etc/adu/du-diagnostics-config.json в ссылочном агенте.

Пути к файлам сбора журналов

Агент обновления устройства на устройстве собирает файлы с конкретных путей к файлам, когда получает сигнал начала отправки журнала от службы обновления устройства. Эти пути к файлам определены в файле конфигурации диагностики.

В файле конфигурации каждый собираемый и передаваемый файл журнала представлен как объект logComponent со свойствами componentName и logPath. При необходимости эту конфигурацию можно изменить.

Максимальный размер файла журнала

Агент обновления устройства будет собирать файлы журнала только определенного размера. Этот максимальный размер файла определяется в файле конфигурации диагностики.

Соответствующий параметр "maxKilobytesToUploadPerLogPath" будет применяться к каждому объекту logComponentи может быть изменен при необходимости.

Создание операции с журналом

Операции с журналом — это действие, управляемое службой, которое позволяет указать устройствам Интернета вещей выполнить действия в службе обновления устройства. Более подробное описание работы операций с журналом см. на странице Диагностика обновлений устройств.

Портал Azure

1. Перейдите в Центр Интернета вещей и выберите вкладку Обновления в разделе Управление устройствами области навигации.

2. В пользовательском интерфейсе выберите вкладку Диагностика. Если вы не видите вкладку Диагностика, убедитесь, что вы используете последнюю версию пользовательского интерфейса обновления устройства для Центра Интернета вещей. Если вы видите "Для этого экземпляра обновления устройства должна быть включена диагностика", убедитесь, что вы связали учетную запись хранилища BLOB-объектов Azure с экземпляром обновления устройства.

3. Выберите Добавить операцию отправки журнала, чтобы перейти на страницу создания операции с журналом.

4. Введите имя (идентификатор) и описание для новой операции с журналом, а затем выберите Добавить устройства, чтобы выбрать устройства Интернета вещей, из которых требуется сбор журналов диагностики.

5. Выберите Добавить.

6. Вернитесь на вкладку Диагностика и выберите Обновить, пока в таблице операций не появится список операций с журналом.

7. После успешной или неудачной операции выберите имя операции, чтобы просмотреть подробные сведения о ней. Операция будет помечена как "успешная", только если все целевые устройства успешно выполнили отправку журнала. Если некоторые целевые устройства выполнили действие успешно, и некоторые завершились сбоем, операция журнала будет отмечена как "неудачная". На странице сведений об операции в журнале можно узнать, какие устройства завершились успешно, а какие — нет.

8. В разделе сведений об операции с журналом можно просмотреть состояние конкретного устройства и просмотреть путь к расположению журнала. Этот путь соответствует пути к виртуальному каталогу в учетной записи хранилища BLOB-объектов Azure, куда были отправлены журналы диагностики.

Azure CLI

Используйте команду az iot du device log collect, чтобы настроить операцию сбора диагностика журналов.

Команда device log collect принимает следующие аргументы:

• --account: имя учетной записи обновления устройства.
• --instance: имя экземпляра обновления устройства.
• --log-collection-id: имя операции сбора журналов.
• --agent-id: пары key=value, определяющие целевой агент обновления устройств для этой операции сбора журналов. Используйте, deviceId=<device name> если агент имеет удостоверение устройства. Используйте deviceId=<device name> moduleId=<module name> , если агент имеет удостоверение модуля. Параметр можно использовать --agent-id несколько раз для назначения нескольких устройств.

Например:

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>

Используйте az iot du device log show для просмотра сведений о определенной операции сбора журналов диагностики.

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

Просмотр и экспорт собранных журналов диагностики

1. После успешной операции с журналом перейдите к учетной записи хранилища BLOB-объектов Azure.

2. Выберите Контейнеры в разделе Хранилище данных области навигации.

3. Выберите контейнер с тем же именем, что и у экземпляра обновления устройства.

4. Используйте путь к расположению журнала из сведений операции журнала, чтобы найти правильный каталог, содержащий журналы. По умолчанию функция удаленного сбора журналов указывает целевым устройствам отправлять журналы диагностики с использованием следующей модели пути к каталогу: Контейнер хранилища BLOB-объектов / Идентификатор целевого устройства / Идентификатор операции журнала / Путь к журналу на устройстве

5. Если компонент диагностики агента обновления устройства не изменен, устройство будет реагировать на любую операцию журнала, пытаясь отправить два файла журнала с открытым текстом: журнал диагностики агента обновления устройства ("aduc.log"), а также журнал диагностики агента DO ("do-agent.log"). Дополнительные сведения о файлах журнала, собираемых агентом справки по обновлению устройств, см. на странице концепции обновления устройства диагностика.

6. Содержимое файла журнала можно просмотреть, выбрав имя файла, затем щелкнув элемент меню (многоточие) и выбрав Просмотреть / изменить. Вы также можете скачать или удалить файл журнала, выбрав соответствующие параметры с метками.

   

Следующие шаги

Дополнительные сведения о возможностях диагностики Обновления устройств см. в обзоре функции диагностики Обновления устройств.