IoT Edge の展開からログを取得する

適用対象: IoT Edge 1.5

IoT Edge エージェント モジュールのダイレクト メソッドを使用して、物理的または SSH アクセスなしで IoT Edge デプロイからログを取得します。 ダイレクト メソッドはデバイス上で実行され、クラウドから呼び出すことができます。 IoT Edge エージェントには、IoT Edge デバイスをリモートで監視および管理するのに役立つダイレクト メソッドがあります。 この記事のダイレクト メソッドは、バージョン 1.0.10 以降で使用できます。

ダイレクト メソッド、ダイレクト メソッドの使用方法、および独自のモジュールに追加する方法の詳細については、「 IoT Hub からダイレクト メソッドを理解して呼び出す」を参照してください。

これらのダイレクト メソッドの名前では、大文字と小文字が区別されます。

推奨されるログ形式

この機能との最適な互換性を確保するには、次のログ形式を使用します。

<{Log Level}> {Timestamp} {Message Text}

{Timestamp}をyyyy-MM-dd HH:mm:ss.fff zzzとして書式設定します。 {Log Level}に基づいて、次の表の値を使用します。

IoT Edge の Logger クラスは正規の実装です。

モジュール ログを取得する

GetModuleLogs ダイレクト メソッドを使用して、IoT Edge モジュールのログを取得します。

このメソッドは、次のスキーマを持つ JSON ペイロードを受け取ります。

    {
       "schemaVersion": "1.0",
       "items": [
          {
             "id": "regex string",
             "filter": {
                "tail": "int",
                "since": "string",
                "until": "string",
                "loglevel": "int",
                "regex": "regex string"
             }
          }
       ],
       "encoding": "gzip/none",
       "contentType": "json/text" 
    }

ログの取得が成功すると 、"status" が返されます。200 の 後に、モジュールのログを含むペイロードが、要求で指定した設定でフィルター処理されます。

次に例を示します。

az iot hub invoke-module-method --method-name 'GetModuleLogs' -n <hub name> -d <device id> -m '$edgeAgent' --method-payload \
'
    {
       "schemaVersion": "1.0",
       "items": [
          {
             "id": "edgeAgent",
             "filter": {
                "tail": 10
             }
          }
       ],
       "encoding": "none",
       "contentType": "text"
    }
'

Azure portal で、メソッド GetModuleLogs と次の JSON ペイロードを呼び出します。

    {
       "schemaVersion": "1.0",
       "items": [
          {
             "id": "edgeAgent",
             "filter": {
                "tail": 10
             }
          }
       ],
       "encoding": "none",
       "contentType": "text"
    }

また、CLI 出力を gzip のような Linux ユーティリティにパイプして、圧縮された応答を処理することもできます。 次に例を示します。

az iot hub invoke-module-method \
  --method-name 'GetModuleLogs' \
  -n <hub name> \
  -d <device id> \
  -m '$edgeAgent' \
  --method-payload '{"contentType": "text","schemaVersion": "1.0","encoding": "gzip","items": [{"id": "edgeHub","filter": {"since": "2d","tail": 1000}}],}' \
  -o tsv --query 'payload[0].payloadBytes' \
  | base64 --decode \
  | gzip -d

モジュール ログをアップロードする

UploadModuleLogs ダイレクト メソッドを使用して、要求されたログを特定の Azure Blob Storage コンテナーに送信します。

このメソッドは、追加された "sasUrl" キーを使用して、 GetModuleLogs のような JSON ペイロードを受け入れます。

    {
       "schemaVersion": "1.0",
       "sasUrl": "Full path to SAS URL",
       "items": [
          {
             "id": "regex string",
             "filter": {
                "tail": "int",
                "since": "string",
                "until": "string",
                "loglevel": "int",
                "regex": "regex string"
             }
          }
       ],
       "encoding": "gzip/none",
       "contentType": "json/text" 
    }

ログのアップロード要求が成功すると、 "status":200 が返され、次のスキーマを持つペイロードが後に続きます。

    {
        "status": "string",
        "message": "string",
        "correlationId": "GUID"
    }

たとえば、次の呼び出しでは、圧縮された JSON 形式ですべてのモジュールから最後の 100 行のログ行がアップロードされます。

az iot hub invoke-module-method --method-name UploadModuleLogs -n <hub name> -d <device id> -m '$edgeAgent' --method-payload \
'
    {
        "schemaVersion": "1.0",
        "sasUrl": "<sasUrl>",
        "items": [
            {
                "id": ".*",
                "filter": {
                    "tail": 100
                }
            }
        ],
        "encoding": "gzip",
        "contentType": "json"
    }
'

次の呼び出しでは、edgeAgent と edgeHub から最後の 100 行のログ行と、tempSensor モジュールの最後の 1,000 行が非圧縮テキスト形式でアップロードされます。

az iot hub invoke-module-method --method-name UploadModuleLogs -n <hub name> -d <device id> -m '$edgeAgent' --method-payload \
'
    {
        "schemaVersion": "1.0",
        "sasUrl": "<sasUrl>",
        "items": [
            {
                "id": "edge",
                "filter": {
                    "tail": 100
                }
            },
            {
                "id": "tempSensor",
                "filter": {
                    "tail": 1000
                }
            }
        ],
        "encoding": "none",
        "contentType": "text"
    }
'

Azure portal で、sasUrl を自分の情報に置き換えた後、メソッド名 UploadModuleLogs と次の JSON ペイロードを使用してメソッドを呼び出します。

    {
       "schemaVersion": "1.0",
       "sasUrl": "<sasUrl>",
       "items": [
          {
             "id": "edgeAgent",
             "filter": {
                "tail": 10
             }
          }
       ],
       "encoding": "none",
       "contentType": "text"
    }

サポート バンドル診断をアップロードする

UploadSupportBundle ダイレクト メソッドを使用して、IoT Edge モジュール ログの zip ファイルをバンドルし、使用可能な Azure Blob Storage コンテナーにアップロードします。 このダイレクト メソッドによって、IoT Edge デバイス上で iotedge support-bundle コマンドが実行されて、ログが取得されます。

このメソッドは、次のスキーマを持つ JSON ペイロードを受け取ります。

    {
        "schemaVersion": "1.0",
        "sasUrl": "Full path to SAS url",
        "since": "2d",
        "until": "1d",
        "edgeRuntimeOnly": false
    }

アップロード ログ要求が成功すると、"status": 200 と、UploadModuleLogs 応答と同じスキーマを持つペイロードが返されます。

    {
        "status": "string",
        "message": "string",
        "correlationId": "GUID"
    }

次の例では、プレースホルダー テキストの <hub name> と <device id> を独自の値に置き換えます。

az iot hub invoke-module-method --method-name 'UploadSupportBundle' -n <hub name> -d <device id> -m '$edgeAgent' --method-payload \
'
    {
        "schemaVersion": "1.0",
        "sasUrl": "Full path to SAS url",
        "since": "2d",
        "until": "1d",
        "edgeRuntimeOnly": false
    }
'

Azure portal で、独自の SAS URL を再レースした後、メソッド名 UploadSupportBundle と次の JSON ペイロードを使用してメソッドを呼び出します。

    {
        "schemaVersion": "1.0",
        "sasUrl": "Full path to SAS url",
        "since": "2d",
        "until": "1d",
        "edgeRuntimeOnly": false
    }

アップロード要求の状態を取得する

GetTaskStatus ダイレクト メソッドを使用して、アップロード ログ要求の状態を確認します。 GetTaskStatus 要求ペイロードは、アップロード ログ要求のcorrelationIdを使用してタスクの状態を取得します。 correlationIdは、UploadModuleLogs ダイレクト メソッド呼び出しへの応答から取得されます。

このメソッドは、次のスキーマを持つ JSON ペイロードを受け取ります。

    {
      "schemaVersion": "1.0",
      "correlationId": "<GUID>"
    }

ログのアップロード要求が成功すると、 "status":200 が返され、UploadModuleLogs 応答と同じスキーマを持つペイロードが後に続きます。

    {
        "status": "string",
        "message": "string",
        "correlationId": "GUID"
    }

次に例を示します。

az iot hub invoke-module-method --method-name 'GetTaskStatus' -n <hub name> -d <device id> -m '$edgeAgent' --method-payload \
'
    {
      "schemaVersion": "1.0",
      "correlationId": "<GUID>"
    }
'

Azure portal で、メソッド名 GetTaskStatus と次の JSON ペイロードを使用してメソッドを呼び出します。 <GUID> は、実際の値に置き換えてください。

    {
      "schemaVersion": "1.0",
      "correlationId": "<GUID>"
    }

次のステップ

IoT Edge エージェントと IoT Edge ハブのモジュール ツインのプロパティ