Device Update for IoT Hub を使用してデバイスからの診断ログをリモートで収集する

Device Update for IoT Hub のログ操作を開始し、Azure BLOB ストレージ内で収集されたログを表示する方法について説明します。

前提条件

• Device Update for IoT Hub が有効になっている IoT ハブにアクセスできること。
• IoT Hub 内で Device Update 用にプロビジョニングされている、診断インターフェイスを実装している IoT デバイス (またはシミュレーター)。
• Device Update for IoT Hub アカウントと同じサブスクリプションにある Azure Blob ストレージ アカウント。

Note

リモートログ収集機能は現在、診断インターフェイスを実装し、ファイルを Azure Blob ストレージにアップロードできるデバイスとのみ互換性があります。 参照エージェントの実装では、デバイスによって、デバイス上でユーザーが指定したファイル パスにログ ファイルが書き込まれることも想定しています。

Azure Portal

サポートされているブラウザー:

• Microsoft Edge
• Google Chrome

Azure CLI

Azure CLI 環境:

• Azure Cloud Shell で Bash 環境を使用します。

  

• CLI リファレンス コマンドをローカルで実行する場合、Azure CLI をインストールします

  • az login コマンドを使用して、Azure CLI にサインインします。
  • az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。
  • 初回使用時に確認を求められたら、Azure CLI 拡張機能をインストールします。 この記事のコマンドでは、azure-iot 拡張機能を使います。 az extension update --name azure-iot を実行して、最新バージョンの拡張機能を使用していることを確認してください。

ヒント

この記事の Azure CLI コマンドでは、行の継続に円記号 \ を使用して、コマンド引数を読みやすくします。 この構文は、Bash 環境で機能します。 PowerShell でこれらのコマンドを実行している場合は、各円記号をバックティック (`) に置き換えるか、完全に削除します。

Azure Blob ストレージ アカウントをデバイス更新インスタンスにリンクする

リモート ログ収集機能を使用するには、まず Azure Blob ストレージ アカウントとデバイス更新インスタンスをリンクする必要があります。 この Azure Blob ストレージ アカウントは、デバイスが診断ログをアップロードする場所です。

Azure Portal

1. Azure portal で、Device Update for IoT Hub アカウントに移動します。

2. ナビゲーション ウィンドウの [インスタンス管理] セクションで、[インスタンス] を選びます。

3. 一覧からデバイス更新インスタンスを選び、[診断の構成] を選びます。

4. [顧客診断] タブを選び、[Azure Storage アカウントの選択] を選びます。

5. 一覧から目的のストレージ アカウントを選び、[保存] を選びます。

6. インスタンスの一覧に戻ったら、インスタンスのプロビジョニングの状態が "成功" と表示されるまで、定期的に [最新の情報に更新] を選びます。通常、この処理には 2 から 3 分かかります。

Azure CLI

Device Update インスタンスの診断を構成するには、az iot du instance create コマンドを使います。

ヒント

既存のデバイス更新インスタンスで az iot du instance create コマンドを使うと、更新されたパラメーターでインスタンスが構成されます。

次のプレースホルダーは、実際の値に置き換えてください。

• <account_name>: デバイス更新アカウントの名前です。
• <instance_name>: デバイス更新インスタンスの名前です。
• <storage_id>: 診断ログが格納されるストレージ アカウントのリソース ID です。 az storage show コマンドを使い、ID 値のクエリを実行して (az storage account show -n <storage_name> --query id)、リソース 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 にある、デバイス上の構成ファイルを参照します。

ログ収集ファイルのパス

デバイスの Device Update エージェントでは、デバイス更新サービスからログ アップロード開始シグナルが受信されると、デバイス上の特定のファイル パスからファイルが収集されます。 これらのファイルのパスは、診断構成ファイルで定義されます。

構成ファイル内では、収集およびアップロードされる各ログ ファイルは、componentName プロパティと logPath プロパティを持つ logComponent オブジェクトとして表されます。 この構成は、必要に応じて変更できます。

最大ログ ファイル サイズ

Device Update エージェントは、特定のファイル サイズのログ ファイルのみを収集します。 この最大ファイル サイズは、診断構成ファイルで定義されます。

関連するパラメーター "maxKilobytesToUploadPerLogPath" が各 logComponent オブジェクトに適用され、必要に応じて変更できます。

ログ操作を作成する

ログ操作は、デバイス更新サービスを通じて実行するように IoT デバイスに指示できるサービス駆動型アクションです。 ログ操作の機能の詳細については、デバイス更新の診断に関するページを参照してください。

Azure Portal

1. IoT Hub に移動し、ナビゲーション ウィンドウの [デバイス管理] セクションの [更新] タブを選択します。

2. UI の [診断] タブを選択します。 [診断] タブが表示されない場合は、Device Update for IoT Hub ユーザーインターフェイスの最新バージョンを使用していることを確認してください。 "Diagnostics must be enabled for this Device Update instance (このデバイス更新インスタンスの診断を有効にする必要があります)" と表示されている場合は、Azure Blob ストレージ アカウントをデバイス更新インスタンスにリンクしていることを確認してください。

3. [Add log upload operation](ログのアップロード操作の追加) を選択して、ログ操作の作成ページに移動します。

4. 新しいログ操作の名前 (ID) と説明を入力し、[デバイスの追加] を選択して、診断ログの収集対象となる IoT デバイスを選択します。

5. [追加] を選択します。

6. [診断] タブに戻り、Operation テーブルにログ操作が表示されるまで [更新] を選択します。

7. 操作の状態が [成功] または [失敗] になったら、操作名を選択して詳細を表示します。 すべてのターゲット デバイスでログのアップロードが正常に完了した場合にのみ、操作は [成功] とマークされます。 一部のターゲット デバイスが成功し、一部が失敗した場合、ログ操作は [失敗] とマークされます。ログ操作の詳細ページを使用して、成功したデバイスと失敗したデバイスを確認できます。

8. ログ操作の詳細では、デバイス固有の状態を確認し、ログの場所のパスを確認できます。 このパスは、診断ログがアップロードされている Azure Blob ストレージ アカウント内の仮想ディレクトリ パスに対応します。

Azure CLI

診断ログの収集操作を構成するには、az iot du device log collect コマンドを使います。

device log collect コマンドは次の引数を使用します。

• --account: Device Update アカウント名。
• --instance: Device Update インスタンス名。
• --log-collection-id: ログ収集操作の名前。
• --agent-id: このログ収集操作のターゲット Device Update エージェントを識別するキーと値のペア。 エージェントにデバイス ID がある場合は、deviceId=<device name> を使います。 エージェントにモジュール ID がある場合は、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. ログ操作が正常に完了したら、Azure Blob ストレージ アカウントに移動します。

2. ナビゲーション ウィンドウの [データストレージ] セクションで、[コンテナー] を選択します。

3. デバイス更新インスタンスと同じ名前のコンテナーを選択します。

4. ログ操作の詳細にあるログの場所のパスを使用して、ログが格納されている正しいディレクトリに移動します。 既定では、リモート ログ収集機能によって、ターゲット デバイスは、次のディレクトリ パス モデルを使用して診断ログをアップロードするよう指示されます。Blob ストレージ コンテナー/ターゲット デバイス ID/ログ操作 ID/デバイス上のログのパス

5. Device Update エージェントの診断コンポーネントを変更していない場合、デバイスは、Device Update エージェント診断ログ ("aduc.log") と DO エージェント診断ログ ("do-agent.log") の 2 つのプレーンテキスト ログ ファイルをアップロードしようとすることで、すべてのログ操作に応答します。 Device Update 参照エージェントで、どちらのログ ファイルが収集されるのかについて詳しくは、Device Update の診断の概念に関する記事をご覧ください。

6. ログ ファイルの内容を表示するには、ファイル名を選択し、メニュー要素 (省略記号) を選択して、[表示または編集] をクリックします。 また、それぞれのラベルが付いたオプションを選択して、ログ ファイルをダウンロードまたは削除することもできます。

   

次のステップ

デバイス更新の診断機能の詳細については、デバイス更新診断機能の概要に関する記事を参照してください