从IoT Edge部署中检索日志

适用范围：IoT Edge 1.5 checkmark IoT Edge 1.5

使用 IoT Edge 代理模块中的直接方法获取 IoT Edge 部署的日志，而无需物理访问或 SSH 访问。 直接方法在设备上运行，你可以从云中调用它们。 IoT Edge代理具有直接方法，可帮助你远程监视和管理IoT Edge设备。 本文中的直接方法从版本 1.0.10 开始提供。

有关直接方法、如何使用它们以及如何将其添加到自己的模块的详细信息，请参阅 了解并调用来自 IoT Hub 的直接方法。

这些直接方法的名称区分大小写。

推荐的日志记录格式

为了与此功能保持最佳兼容性，请使用以下日志记录格式：

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

格式 {Timestamp} 为 yyyy-MM-dd HH:mm:ss.fff zzz. 根据 Syslog 标准中的严重性代码，使用 {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 输出传输到 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 Storage容器。

此方法接受类似于 GetModuleLogs 的 JSON 有效负载，并添加了“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"
    }

例如，以下调用从压缩 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>"
    }

成功上传日志请求后，会返回“状态: 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>"
    }

Azure 门户的截图，显示如何调用直接方法 GetTaskStatus。

后续步骤

IoT Edge 代理和IoT Edge中心模块孪生的属性