Recupere logs de implantações do Azure IoT Edge

Aplica-se a: IoT Edge 1.5 IoT Edge 1.4

Recupere logs de suas implantações do IoT Edge sem precisar de acesso físico ou por SSH ao dispositivo, usando os métodos diretos incluídos no módulo do agente do IoT Edge. Os métodos diretos são implementados no dispositivo e depois podem ser invocados na nuvem. O agente do IoT Edge inclui métodos diretos que ajudam você a monitorar e gerenciar seus dispositivos do IoT Edge remotamente. Os métodos diretos discutidos neste artigo, em geral, estão disponíveis com a versão 1.0.10.

Para obter mais informações sobre os métodos diretos, como usá-los e como implementá-los nos seus módulos, confira Entender e invocar métodos diretos do Hub IoT.

Os nomes desses métodos diretos são tratados com diferenciação de maiúsculas e minúsculas.

Formato de log recomendado

Embora não seja necessário, para obter a melhor compatibilidade com esse recurso, o formato de log recomendado é:

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

{Timestamp} deve ser formatado como yyyy-MM-dd HH:mm:ss.fff zzz e {Log Level} deve seguir a tabela abaixo, que deriva seus níveis de severidade do Código de severidade no padrão do Syslog.

A classe de agente no Azure IoT Edge serve como implementação canônica.

Recuperar logs de módulo

Use o método direto GetModuleLogs para recuperar os logs de um módulo do Azure IoT Edge.

Esse método aceita uma carga JSON com o esquema a seguir:

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

Uma recuperação bem-sucedida de logs retorna um "status": 200 seguido por um conteúdo que contém os logs recuperados do módulo, filtrados pelas configurações especificadas na solicitação.

Por exemplo:

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

No portal do Azure, invoque o método de nome GetModuleLogs e o seguinte conteúdo JSON:

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

Você também usar um pipe na saída da CLI para utilitários do Linux, como gzip, para processar uma resposta compactada. Por exemplo:

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

Carregar logs de módulo

Use o método direto UploadModuleLogs para enviar os logs solicitados para um contêiner de Armazenamento de Blobs do Azure especificado.

Esse método aceita um payload JSON semelhante a GetModuleLogs, com a adição da chave "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" 
    }

Uma solicitação bem-sucedida para carregar logs retorna um "status": 200 seguido por um payload com o seguinte esquema:

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

Por exemplo:

A invocação a seguir carrega as últimas 100 linhas de log de todos os módulos no formato JSON compactado:

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 seguinte invocação carrega as últimas 100 linhas de log do edgeAgent e edgeHub com as últimas 1000 linhas de log do módulo tempSensor no formato de texto descompactado:

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

Na portal do Azure, invoque o método com o nome do método UploadModuleLogs e o seguinte conteúdo JSON, depois de preencher o sasURL com suas informações:

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

Carregue o diagnóstico do Pacote de Suporte

Use o método direto UploadSupportBundle para agrupar e carregar um arquivo zip de logs do módulo do Azure IoT Edge para um contêiner de Armazenamento de Blobs do Azure disponível. Esse método direto executa o comando iotedge support-bundle em seu dispositivo do IoT Edge para obter os logs.

Esse método aceita uma carga JSON com o esquema a seguir:

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

Uma solicitação bem-sucedida para carregar logs retorna um "status": 200 seguido por um payload com o mesmo esquema que a resposta UploadModuleLogs:

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

Por exemplo:

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

Na portal do Azure, invoque o método com o nome do método UploadSupportBundle e o seguinte conteúdo JSON, depois de preencher o sasURL com suas informações:

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

Obter status da solicitação de carregamento

Use o método direto GetTaskStatus para consultar o status de uma solicitação de logs de upload. O payload da solicitação GetTaskStatus usa a correlationId da solicitação para carregar logs, para obter o status da tarefa. A correlationId é retornada em resposta à chamada de método direto UploadModuleLogs.

Esse método aceita uma carga JSON com o esquema a seguir:

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

Uma solicitação bem-sucedida para carregar logs retorna um "status": 200 seguido por um payload com o mesmo esquema que a resposta UploadModuleLogs:

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

Por exemplo:

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

Na portal do Azure, invoque o método com o nome do método GetTaskStatus e o seguinte conteúdo JSON, depois de preencher o GUID com suas informações:

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

Próximas etapas

Propriedades do agente do IoT Edge e dos gêmeos de módulo do hub do IoT Edge