Recopilación remota de registros de diagnóstico de dispositivos mediante Device Update for IoT Hub

Obtenga información sobre cómo iniciar una operación de registro de Device Update for IoT Hub y ver los registros recopilados en Azure Blob Storage.

Prerrequisitos

• Acceso a una instancia de IoT Hub con Device Update para IoT Hub habilitado.
• Un dispositivo IoT (o simulador) aprovisionado para Device Update en IoT Hub e implementación de la interfaz de diagnóstico.
• Una cuenta de Azure Blob Storage en la misma suscripción que la cuenta de Device Update for IoT Hub.

Nota

Actualmente, la característica de recopilación remota de registros solo es compatible con los dispositivos que implementan la interfaz de diagnóstico y pueden cargar archivos en Azure Blob Storage. La implementación del agente de referencia también espera que el dispositivo escriba archivos de registro en una ruta de acceso de archivo especificada por el usuario en el dispositivo.

Azure Portal

Exploradores admitidos:

• Microsoft Edge
• Google Chrome

CLI de Azure

Un entorno de la CLI de Azure:

• Use el entorno de Bash en Azure Cloud Shell.

  

• O bien, si prefiere ejecutar comandos de referencia de la CLI localmente, instale la CLI de Azure.

  • Inicie sesión en la CLI de Azure mediante el comando az login.
  • Ejecute az version para buscar cuál es la versión y las bibliotecas dependientes que están instaladas. Para realizar la actualización a la versión más reciente, ejecute az upgrade.
  • Cuando se le solicite, instale las extensiones de la CLI de Azure la primera vez que lo use. Los comandos de este artículo usan la extensión azure-iot. Ejecute az extension update --name azure-iot para asegurarse de usar la versión más reciente de la extensión.

Sugerencia

Los comandos de la Interfaz de la línea de comandos de Azure citados en este artículo usan el carácter de la barra diagonal inversa \ para la continuación de línea y facilitar la lectura de los argumentos del comando. Esta sintaxis funciona en entornos Bash. Si ejecuta estos comandos en PowerShell, reemplace las barras diagonales inversas por acentos graves ``` o quítelas totalmente.

Vinculación de la cuenta de Azure Blob Storage a la instancia de Device Update

Para usar la característica de recopilación remota de registros, primero debe vincular una cuenta de Azure Blob Storage a la instancia de Device Update. Esta cuenta de Azure Blob Storage es donde los dispositivos cargarán los registros de diagnóstico.

Azure Portal

1. En el Azure Portal, vaya a la cuenta de Device Update for IoT Hub.

2. Seleccione Instancias en la sección Administración de instancias del panel de navegación.

3. Seleccione la instancia de Device Update en la lista y, a continuación, Configurar diagnósticos.

4. Seleccione la pestaña Diagnósticos del cliente y, a continuación, Seleccionar cuenta de Azure Storage.

5. Elija la cuenta de almacenamiento deseada en la lista y seleccione Guardar.

6. Una vez que vuelva a la lista de instancias, seleccione Actualizar periódicamente hasta que el estado de aprovisionamiento de la instancia muestre "Correcto". Normalmente, esto tarda entre 2 y 3 minutos.

CLI de Azure

El comando az iot du instance create se usa para configurar diagnósticos de la instancia de Device Update.

Sugerencia

Puede usar el comando az iot du instance create en una instancia de Device Update existente y configurará la instancia con los parámetros actualizados.

Reemplace los marcadores de posición siguientes por su propia información:

• <account_name>: el nombre de su cuenta de Device Update.
• <instance_name>: el nombre de su instancia de Device Update.
• <storage_id>: el identificador de recurso de la cuenta de almacenamiento donde se almacenarán los registros de diagnóstico. Puede recuperar el identificador de recurso mediante el comando az storage show y la consulta del valor de identificador: az storage account show -n <storage_name> --query id.

az iot du instance update --account <account_name> --instance <instance_name> --set enableDiagnostics=true diagnosticStorageProperties.resourceId=<storage_id>

Configurar la recopilación de registros

El agente de actualización de dispositivos se refiere a un archivo de configuración en el dispositivo, ubicado en /etc/adu/du-diagnostics-config.json en el agente de referencia.

Rutas de acceso del archivo de recopilación de registros

El agente de Device Update de un dispositivo recopilará archivos de rutas de acceso de archivo específicas en el dispositivo cuando reciba una señal de inicio de carga de registros del servicio Device Update. Estas rutas de acceso de archivo se definen en el archivo de configuración de diagnóstico.

Dentro del archivo de configuración, cada archivo de registro que se va a recopilar y cargar se representa como un objeto logComponent con las propiedades componentName y logPath. Esta configuración se puede modificar según sea necesario.

Tamaño máximo del archivo de registro

El agente de Device Update solo recopilará archivos de registro con un tamaño de archivo determinado. Este tamaño máximo de archivo se define en el archivo de configuración de diagnóstico.

El parámetro pertinente "maxKilobytesToUploadPerLogPath" se aplicará a cada objeto logComponent y se puede modificar según sea necesario.

Crear una operación nueva

Las operaciones de registro son una acción controlada por el servicio que puede indicar a los dispositivos IoT que operen a través del servicio Device Update. Para obtener una explicación más detallada de cómo funcionan las operaciones de registro, consulte la página del concepto Diagnóstico de actualización de dispositivos.

Azure Portal

1. Vaya a IoT Hub y seleccione la pestaña Actualizaciones en la sección Administración de dispositivos del panel de navegación.

2. Seleccione la pestaña Diagnósticos en la interfaz de usuario. Si no ve una pestaña Diagnósticos, asegúrese de que usa la versión más reciente de la interfaz de usuario de Device Update for IoT Hub. Si ve "Diagnostics must be enabled for this Device Update instance" (Los diagnósticos deben estar habilitados para esta instancia de Device Update), asegúrese de que ha vinculado una cuenta de Azure Blob Storage con la instancia de Device Update.

3. Seleccione Add log upload operation (Agregar operación de carga de registros) para ir a la página de creación de la operación de registro.

4. Escriba un nombre (id.) y una descripción para la nueva operación de registro y, a continuación, seleccione Agregar dispositivos para seleccionar de qué dispositivos IoT quiere recopilar registros de diagnóstico.

5. Seleccione Agregar.

6. Una vez de nuevo en la pestaña Diagnósticos, seleccione Actualizar hasta que vea la operación de registro en la tabla de operaciones.

7. Una vez que el estado de la operación sea Correcto o Con errores, seleccione el nombre de la operación para ver sus detalles. Una operación se marcará como "Correcto" solo si todos los dispositivos de destino completaron correctamente la carga del registro. Si algunos dispositivos de destino se realizaron correctamente y otros no, la operación de registro se marcará como "Con errores". Puede usar la hoja de detalles de la operación de registro para ver qué dispositivos se realizaron correctamente y cuáles no.

8. En los detalles de la operación de registro, puede ver el estado específico del dispositivo y ver la ruta de acceso de la ubicación del registro. Esta ruta de acceso corresponde a la ruta de acceso del directorio virtual dentro de la cuenta de Azure Blob Storage donde se han cargado los registros de diagnóstico.

CLI de Azure

El comando az iot du device log collect sirve para configurar una operación de recopilación de registros de diagnóstico.

El comando device log collect toma los argumentos siguientes:

• --account: nombre de cuenta de Device Update.
• --instance: nombre de instancia de Device Update.
• --log-collection-id: nombre de la operación de recopilación de registros.
• --agent-id: pares clave-valor que identifican un agente de Device Update de destino para esta operación de recopilación de registros. Se utiliza deviceId=<device name> si el agente tiene una identidad del dispositivo. Se emplea deviceId=<device name> moduleId=<module name> si el agente tiene una identidad de módulo. Puede usar el parámetro --agent-id varias veces para tener varios dispositivos como destino.

Por ejemplo:

az iot du device log collect \
    --account <Device Update account name> \
    --instance <Device Update instance name> \
    --log-collection-id <log collection name} \
    --agent-id deviceId=<device name> \
    --agent-id deviceId=<device name> moduleId=<module name>

El comando az iot du device log show se usa para ver los detalles de una operación de recopilación de registros de diagnóstico específica.

az iot du device log show \
    --account <Device Update account name> \
    --instance <Device Update instance name> \
    --log-collection-id <log collection name>

Visualización y exportación de los registros de diagnóstico recopilados

1. Una vez que la operación de registro se haya realizado correctamente, vaya a la cuenta de Azure Blob Storage.

2. Seleccione Contenedores en la sección Almacenamiento de datos del panel de navegación.

3. Seleccione el contenedor con el mismo nombre que la instancia de Device Update.

4. Use la ruta de acceso de la ubicación del registro de los detalles de la operación de registro para ir al directorio correcto que contiene los registros. De forma predeterminada, la característica de recopilación de registros remota indica a los dispositivos de destino que carguen los registros de diagnóstico mediante el siguiente modelo de ruta de acceso de directorio: Contenedor de almacenamiento de blobs/Id. de dispositivo de destino/Id. de operación de registro/Ruta de acceso de registro en dispositivo.

5. Si no ha modificado el componente de diagnóstico del agente de Device Update, el dispositivo responderá a todas las operaciones de registro intentando cargar dos archivos de registro con texto no cifrado: el registro de diagnóstico de agente de Device Update ("aduc.log") y el registro de diagnóstico de agente de DO ("do-agent.log"). Puede obtener más información sobre los archivos de registro que el agente de referencia de Device Update recopila en la página de conceptos Diagnósticos de Device Update.

6. Para ver el contenido del archivo de registro, seleccione el nombre del archivo, seleccione el elemento de menú (puntos suspensivos) y haga clic en Ver/Editar. También puede descargar o eliminar el archivo de registro seleccionando las opciones etiquetadas respectivamente.

   

Pasos siguientes

Para más información sobre las funcionalidades de diagnóstico de Device Update, consulte Información general sobre la característica de diagnóstico de actualización de dispositivos