Mengambil log dari penyebaran IoT Edge

Berlaku untuk: IoT Edge 1.5

Ambil log dari penyebaran IoT Edge Anda tanpa memerlukan akses fisik atau SSH ke perangkat dengan menggunakan metode langsung yang disertakan dalam modul agen IoT Edge. Metode langsung diterapkan pada perangkat, dan kemudian dapat dipanggil dari cloud. Agen IoT Edge menyertakan metode langsung yang membantu Anda memantau dan mengelola perangkat IoT Edge dari jarak jauh. Metode langsung yang dibahas dalam artikel ini umumnya tersedia dengan rilis 1.0.10.

Untuk informasi selengkapnya tentang metode langsung, cara menggunakannya, dan cara mengimplementasikannya dalam modul Anda sendiri, lihat Memahami dan memanggil metode langsung dari IoT Hub.

Nama-nama metode langsung ini ditangani peka huruf besar/kecil.

Format pembuatan log yang direkomendasikan

Meskipun tidak diperlukan, untuk kompatibilitas terbaik dengan fitur ini, format pembuatan log yang direkomendasikan adalah:

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

{Timestamp} harus diformat sebagai yyyy-MM-dd HH:mm:ss.fff zzz, dan {Log Level} harus menggunakan tabel berikut, yang memperoleh tingkat keparahannya dari kode Tingkat Keparahan dalam standar Syslog.

Kelas Logger di IoT Edge berfungsi sebagai implementasi kanonis.

Ambil log modul

Gunakan metode langsung GetModuleLogs untuk mengambil log modul IoT Edge.

Metode ini menerima payload JSON dengan skema berikut:

    {
       "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" 
    }

Pengambilan log yang berhasil mengembalikan "status": 200 diikuti oleh payload yang berisi log yang diambil dari modul, difilter oleh pengaturan yang Anda tentukan dalam permintaan Anda.

Contohnya:

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"
    }
'

Di portal Microsoft Azure, panggil metode dengan nama metode GetModuleLogs dan payload JSON berikut:

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

Anda juga dapat mem-pipa output CLI ke utilitas Linux, seperti gzip, untuk memproses respons terkompresi. Contohnya:

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

Mengunggah log modul

Gunakan metode langsung UploadModuleLogs untuk mengirim log yang diminta ke kontainer Azure Blob Storage tertentu.

Metode ini menerima payload JSON yang mirip dengan GetModuleLogs, dengan penambahan kunci "sasUrl":

    {
       "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" 
    }

Permintaan yang berhasil untuk mengunggah log mengembalikan "status": 200 diikuti dengan payload dengan skema berikut:

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

Contohnya:

Pemanggilan berikut mengunggah 100 baris log terakhir dari semua modul, dalam format JSON terkompresi:

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"
    }
'

Pemanggilan berikut mengunggah 100 baris log terakhir dari edgeAgent dan edgeHub dengan 1000 baris log terakhir dari modul tempSensor dalam format teks yang tidak dikompresi:

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"
    }
'

Di portal Microsoft Azure, panggil metode dengan nama metode UploadModuleLogs dan payload JSON berikut setelah mengisi sasURL dengan informasi Anda:

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

Mengunggah diagnostik bundel dukungan

Gunakan metode langsung UploadSupportBundle untuk menggabungkan dan mengunggah file zip log modul IoT Edge ke kontainer Azure Blob Storage yang tersedia. Metode langsung ini menjalankan iotedge support-bundle perintah pada perangkat IoT Edge Anda untuk mendapatkan log.

Metode ini menerima payload JSON dengan skema berikut:

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

Permintaan yang berhasil untuk mengunggah log mengembalikan "status": 200 diikuti oleh payload dengan skema yang sama dengan respons UploadModuleLogs:

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

Contohnya:

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
    }
'

Di portal Microsoft Azure, panggil metode dengan nama metode UploadSupportBundle dan payload JSON berikut setelah mengisi sasURL dengan informasi Anda:

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

Dapatkan status permintaan unggahan

Gunakan metode langsung GetTaskStatus untuk mengkueri status permintaan log unggahan. Payload permintaan GetTaskStatus menggunakan permintaan correlationId log unggahan untuk mendapatkan status tugas. Yang correlationId dikembalikan sebagai tanggapan terhadap panggilan metode langsung UploadModuleLogs.

Metode ini menerima payload JSON dengan skema berikut:

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

Permintaan yang berhasil untuk mengunggah log mengembalikan "status": 200 diikuti oleh payload dengan skema yang sama dengan respons UploadModuleLogs:

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

Contohnya:

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

Di portal Microsoft Azure, panggil metode dengan nama metode dan GetTaskStatus payload JSON berikut setelah mengisi GUID dengan informasi Anda:

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

Langkah berikutnya

Properti agen IoT Edge dan kembar modul hub IoT Edge