IoT Edge dağıtımlarından günlükleri alma

Şunlar için geçerlidir: IoT Edge 1.5 IoT Edge 1.4

IoT Edge aracı modülünde yer alan doğrudan yöntemleri kullanarak cihaza fiziksel veya SSH erişimine gerek kalmadan IoT Edge dağıtımlarınızdan günlükleri alın. Doğrudan yöntemler cihazda uygulanır ve ardından buluttan çağrılabilir. IoT Edge aracısı, IoT Edge cihazlarınızı uzaktan izlemenize ve yönetmenize yardımcı olan doğrudan yöntemler içerir. Bu makalede açıklanan doğrudan yöntemler genel olarak 1.0.10 sürümüyle kullanılabilir.

Doğrudan yöntemler, bunları kullanma ve bunları kendi modüllerinizde uygulama hakkında daha fazla bilgi için bkz . IoT Hub'dan doğrudan yöntemleri anlama ve çağırma.

Bu doğrudan yöntemlerin adları büyük/küçük harfe duyarlı olarak işlenir.

Önerilen günlük biçimi

Gerekli olmasa da, bu özellikle en iyi uyumluluk için önerilen günlüğe kaydetme biçimi şu şekildedir:

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

{Timestamp}olarak yyyy-MM-dd HH:mm:ss.fff zzzbiçimlendirilmelidir ve {Log Level} önem düzeylerini Syslog standardındaki Önem Derecesi kodundan türeyen aşağıdaki tabloyu kullanmalıdır.

IoT Edge'deki Logger sınıfı kurallı bir uygulama işlevi görür.

Modül günlüklerini alma

IoT Edge modülünün günlüklerini almak için GetModuleLogs doğrudan yöntemini kullanın.

Bu yöntem aşağıdaki şemaya sahip bir JSON yükünü kabul eder:

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

Günlüklerin başarıyla alınması bir "durum" döndürür: 200 ve ardından modülden alınan günlükleri içeren yük isteğinizde belirttiğiniz ayarlara göre filtrelenir.

Örneğin:

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ında yöntemini yöntem adı GetModuleLogs ve aşağıdaki JSON yüküyle çağırın:

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

Sıkıştırılmış bir yanıtı işlemek için CLI çıkışını gzip gibi Linux yardımcı programlarına da yöneltebilirsiniz. Örneğin:

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

Modül günlüklerini karşıya yükleme

İstenen günlükleri belirtilen Azure Blob Depolama kapsayıcısına göndermek için UploadModuleLogs doğrudan yöntemini kullanın.

Bu yöntem, "sasUrl" anahtarının eklenmesiyle GetModuleLogs'a benzer bir JSON yükünü kabul eder:

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

Günlükleri karşıya yükleme isteği başarılı bir "durum" döndürür: 200 ve ardından aşağıdaki şemaya sahip bir yük:

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

Örneğin:

Aşağıdaki çağrı, tüm modüllerden son 100 günlük satırı sıkıştırılmış JSON biçiminde karşıya yükler:

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

Aşağıdaki çağrı, tempSensor modülündeki son 1000 günlük satırıyla edgeAgent ve edgeHub'dan son 100 günlük satırı sıkıştırılmamış metin biçiminde karşıya yükler:

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ında sasURL'yi bilgilerinizle doldurup yöntem adı UploadModuleLogs ve aşağıdaki JSON yüküyle yöntemini çağırın:

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

Destek paketi tanılamalarını karşıya yükleme

IoT Edge modül günlüklerinin zip dosyasını paketleyip kullanılabilir bir Azure Blob Depolama kapsayıcısına yüklemek için UploadSupportBundle doğrudan yöntemini kullanın. Bu doğrudan yöntem, günlükleri almak için IoT Edge cihazınızda komutunu çalıştırır iotedge support-bundle .

Bu yöntem aşağıdaki şemaya sahip bir JSON yükünü kabul eder:

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

Günlükleri karşıya yükleme isteği başarılı bir "durum" döndürür: 200 ve ardından UploadModuleLogs yanıtıyla aynı şemaya sahip bir yük gelir:

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

Örneğin:

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ında sasURL'yi bilgilerinizle doldurup yöntem adı UploadSupportBundle ve aşağıdaki JSON yüküyle yöntemini çağırın:

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

Karşıya yükleme isteği durumunu alma

Karşıya yükleme günlükleri isteğinin durumunu sorgulamak için GetTaskStatus doğrudan yöntemini kullanın. GetTaskStatus istek yükü, görevin durumunu almak için karşıya yükleme günlükleri isteğini kullanırcorrelationId. correlationId, UploadModuleLogs doğrudan yöntem çağrısına yanıt olarak döndürülür.

Bu yöntem aşağıdaki şemaya sahip bir JSON yükünü kabul eder:

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

Günlükleri karşıya yükleme isteği başarılı bir "durum" döndürür: 200 ve ardından UploadModuleLogs yanıtıyla aynı şemaya sahip bir yük gelir:

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

Örneğin:

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ında, GUID'yi bilgilerinizle doldurup yöntem adı GetTaskStatus ve aşağıdaki JSON yüküyle yöntemini çağırın:

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

Sonraki adımlar

IoT Edge aracısının ve IoT Edge hub modül ikizlerinin özellikleri