استرداد السجلات من عمليات نشر 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} أن يستخدم الجدول التالي، الذي يستمد مستويات الخطورة الخاصة به من التعليمات البرمجية للخطورة في معيار Syslog.

تعمل فئة المسجل في IoT Edge كتنفيذ متعارف عليه.

استرداد سجلات الوحدة النمطية

استخدم الأسلوب المباشر 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" 
    }

يرجع الاسترداد الناجح للسجلات "الحالة": 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"
    }
'

في مدخل Microsoft Azure، استدع الأسلوب باسم GetModuleLogs الأسلوب وحمولة JSON التالية:

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

يمكنك أيضا توجيه إخراج CLI إلى أدوات Linux المساعدة، مثل gzip، لمعالجة استجابة مضغوطة. على سبيل المثال:

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 محددة.

يقبل هذا الأسلوب حمولة JSON مشابهة ل GetModuleLogs، مع إضافة مفتاح "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" 
    }

يرجع الطلب الناجح لتحميل السجلات "الحالة": 200 متبوعا بحمولة بالمخطط التالي:

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

على سبيل المثال:

يقوم استدعاء التالي بتحميل آخر 100 سطر سجل من جميع الوحدات النمطية بتنسيق JSON مضغوط:

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

يقوم الاستدعاء التالي بتحميل آخر 100 سطر سجل من edgeAgent وedgeHub مع آخر 1000 سطر سجل من وحدة tempSensor بتنسيق نصي غير مضغوط:

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

في مدخل Microsoft Azure، استدع الأسلوب باسم UploadModuleLogs الأسلوب وحمولة JSON التالية بعد ملء sasURL بمعلوماتك:

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

تحميل تشخيصات حزمة الدعم

استخدم الأسلوب المباشر UploadSupportBundle لتجميع وتحميل ملف مضغوط من سجلات وحدة IoT Edge إلى حاوية Azure Blob Storage المتوفرة. يقوم هذا الأسلوب المباشر بتشغيل iotedge support-bundle الأمر على جهاز IoT Edge للحصول على السجلات.

يقبل هذا الأسلوب حمولة JSON مع المخطط التالي:

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

يرجع الطلب الناجح لتحميل السجلات "الحالة": 200 متبوعا بحمولة بنفس المخطط كاستجابة UploadModuleLogs :

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

على سبيل المثال:

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

في مدخل Microsoft Azure، استدع الأسلوب باسم UploadSupportBundle الأسلوب وحمولة JSON التالية بعد ملء sasURL بمعلوماتك:

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

الحصول على حالة طلب التحميل

استخدم الأسلوب المباشر GetTaskStatus للاستعلام عن حالة طلب سجلات التحميل. تستخدم correlationId حمولة طلب GetTaskStatus طلب سجلات التحميل للحصول على حالة المهمة. correlationId يتم إرجاع استجابة لاستدعاء الأسلوب المباشر UploadModuleLogs.

يقبل هذا الأسلوب حمولة JSON مع المخطط التالي:

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

يرجع الطلب الناجح لتحميل السجلات "الحالة": 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>"
    }
'

في مدخل Microsoft Azure، استدع الأسلوب باسم GetTaskStatus الأسلوب وحمولة JSON التالية بعد ملء GUID بمعلوماتك:

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

الخطوات التالية

خصائص عامل IoT Edge وتوائم وحدة مركز IoT Edge