Consola de depuración local
El componente de la consola de depuración local (aws.greengrass.LocalDebugConsole) proporciona un panel local que muestra información sobre los dispositivos principales y sus componentes de AWS IoT Greengrass. Puede usar este panel para depurar su dispositivo principal y administrar los componentes locales.
Se recomienda usar este componente solo en entornos de desarrollo y no en entornos de producción. Este componente brinda acceso a información y operaciones que, por lo general, no necesitará en un entorno de producción. Siga el principio de privilegio mínimo al implementar este componente solo en los dispositivos principales donde lo necesite.
Versiones
Este componente tiene las siguientes versiones:
-
2.4.x
-
2.3.x
-
2.2.x
-
2.1.x
-
2.0.x
Tipo
Este componente es un componente de complemento (aws.greengrass.plugin). El núcleo de Greengrass ejecuta este componente en la misma máquina virtual Java (JVM) que el núcleo. El núcleo se reinicia al cambiar la versión de este componente en el dispositivo principal.
Este componente usa el mismo archivo de registro que el núcleo de Greengrass. Para obtener más información, consulte Supervisión de los registros de AWS IoT Greengrass.
Para obtener más información, consulte Tipos de componentes.
Sistema operativo
Este componente se puede instalar en los dispositivos principales que ejecutan los siguientes sistemas operativos:
Requisitos
Este componente tiene los siguientes requisitos:
-
Puede utilizar un nombre de usuario y una contraseña para iniciar sesión en el panel de control. Se le proporciona el nombre de usuario, que es debug. Debe usar la CLI de AWS IoT Greengrass para crear una contraseña temporal que lo autentique con el panel de control de un dispositivo principal. Debe poder usar la CLI de AWS IoT Greengrass para usar la consola de depuración local. Para obtener más información, consulte los requisitos de la CLI de Greengrass. Para obtener más información sobre cómo generar la contraseña e iniciar sesión, consulte Uso de los componentes de la consola de depuración local.
-
Se admite la ejecución del componente de la consola de depuración local en una VPC.
Dependencias
Cuando implementa un componente, AWS IoT Greengrass también implementa versiones compatibles de sus dependencias. Esto significa que debe cumplir los requisitos del componente y de todas sus dependencias para poder implementar el componente correctamente. En esta sección, se enumeran las dependencias de las versiones publicadas de este componente y las restricciones de las versiones semánticas que definen las versiones de los componentes para cada dependencia. También puede ver las dependencias de cada versión del componente en la consola de AWS IoT Greengrass. En la página de detalles del componente, busque la lista de Dependencias.
- 2.4.3
-
En la siguiente tabla, se muestran las dependencias de la versión 2.4.3 de este componente.
- 2.4.3
-
En la siguiente tabla, se muestran las dependencias de la versión 2.4.3 de este componente.
- 2.4.1 – 2.4.2
-
En la siguiente tabla, se muestran las dependencias de las versiones 2.4.1 a 2.4.2 de este componente.
- 2.4.0
-
En la siguiente tabla, se muestran las dependencias de la versión 2.4.0 de este componente.
- 2.3.0 and 2.3.1
-
En la siguiente tabla, se muestran las dependencias de las versiones 2.3.0 y 2.3.1 de este componente.
- 2.2.9
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.9 de este componente.
- 2.2.8
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.8 de este componente.
- 2.2.7
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.7 de este componente.
- 2.2.6
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.6 de este componente.
- 2.2.5
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.5 de este componente.
- 2.2.4
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.4 de este componente.
- 2.2.3
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.3 de este componente.
- 2.2.2
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.2 de este componente.
- 2.2.1
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.1 de este componente.
- 2.2.0
-
En la siguiente tabla, se muestran las dependencias de la versión 2.2.0 de este componente.
- 2.1.0
-
En la siguiente tabla, se muestran las dependencias de la versión 2.1.0 de este componente.
- 2.0.x
-
En la siguiente tabla, se muestran las dependencias de la versión 2.0.x de este componente.
Para obtener más información sobre las dependencias del componente, consulte la referencia de receta de componentes.
Configuración
Este componente ofrece los siguientes parámetros de configuración que puede personalizar cuando implemente el componente.
- v2.1.x - v2.4.x
-
httpsEnabled-
(Opcional) Puede habilitar la comunicación HTTPS para la consola de depuración local. Si habilita la comunicación HTTPS, la consola de depuración local crea un certificado autofirmado. Los navegadores web muestran advertencias de seguridad para los sitios web que utilizan certificados autofirmados, por lo que debe verificar el certificado manualmente. A continuación, puede omitir la advertencia. Para obtener más información, consulte Uso.
Valor predeterminado: true
port-
(Opcional) El puerto en el que se va a proporcionar la consola de depuración local.
Valor predeterminado: 1441
websocketPort-
(Opcional) El puerto websocket que se utilizará en la consola de depuración local.
Valor predeterminado: 1442
bindHostname-
(Opcional) El nombre de host que se utilizará en la consola de depuración local.
Si ejecuta el software AWS IoT Greengrass Core en un contenedor de Docker, defina este parámetro en 0.0.0.0 para poder abrir la consola de depuración local fuera del contenedor de Docker.
Valor predeterminado: localhost
ejemplo Ejemplo: actualización de la combinación de configuraciones
En el siguiente ejemplo de configuración, se especifica abrir la consola de depuración local en puertos no predeterminados e inhabilitar HTTPS.
{
"httpsEnabled": false,
"port": "10441",
"websocketPort": "10442"
}
- v2.0.x
-
port-
(Opcional) El puerto en el que se va a proporcionar la consola de depuración local.
Valor predeterminado: 1441
websocketPort-
(Opcional) El puerto websocket que se utilizará en la consola de depuración local.
Valor predeterminado: 1442
bindHostname-
(Opcional) El nombre de host que se utilizará en la consola de depuración local.
Si ejecuta el software AWS IoT Greengrass Core en un contenedor de Docker, defina este parámetro en 0.0.0.0 para poder abrir la consola de depuración local fuera del contenedor de Docker.
Valor predeterminado: localhost
ejemplo Ejemplo: actualización de la combinación de configuraciones
En el siguiente ejemplo de configuración, se especifica abrir la consola de depuración local en puertos no predeterminados.
{
"port": "10441",
"websocketPort": "10442"
}
Uso
Para usar la consola de depuración local, cree una sesión desde la CLI de Greengrass. Cuando crea una sesión, la CLI de Greengrass proporciona un nombre de usuario y una contraseña temporal que puede usar para iniciar sesión en la consola de depuración local.
Siga estas instrucciones para abrir la consola de depuración local en su dispositivo principal o en su computadora de desarrollo.
- v2.1.x - v2.4.x
-
En las versiones 2.1.0 y posteriores, la consola de depuración local usa HTTPS de forma predeterminada. Cuando HTTPS está activado, la consola de depuración local crea un certificado autofirmado para proteger la conexión. Su navegador web muestra una advertencia de seguridad cuando abre la consola de depuración local debido a este certificado autofirmado. Cuando crea una sesión con la CLI de Greengrass, el resultado incluye las huellas digitales del certificado para que pueda comprobar que el certificado es legítimo y que la conexión es segura.
Puede deshabilitar HTTPS. Para obtener más información, consulte Configuración de la consola de depuración local.
Cómo abrir la consola de depuración local
-
(Opcional) Para ver la consola de depuración local en su computadora de desarrollo, puede reenviar el puerto de la consola a través de SSH. Sin embargo, primero debe habilitar la opción AllowTcpForwarding en el archivo de configuración SSH de su dispositivo principal. Esta opción está habilitada de forma predeterminada. Ejecute el siguiente comando en su computadora de desarrollo para ver el panel de control en localhost:1441 en su computadora de desarrollo.
ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
-
Cree una sesión para usar la consola de depuración local. Cuando crea una sesión, genera una contraseña que se utiliza para autenticarse. La consola de depuración local requiere una contraseña para aumentar la seguridad, ya que puede utilizar este componente para ver información importante y realizar operaciones en el dispositivo principal. La consola de depuración local también crea un certificado para proteger la conexión si se habilita HTTPS en la configuración del componente. HTTPS está habilitado de forma predeterminada.
Utilice la CLI de AWS IoT Greengrass para crear la sesión. Este comando genera una contraseña aleatoria de 43 caracteres que caduca a las 8 horas. Reemplace /greengrass/v2C:\greengrass\v2 por la ruta a la carpeta raíz de AWS IoT Greengrass V2.
Linux or UnixWindows
- Linux or Unix
sudo /greengrass/v2
- Windows
C:\greengrass\v2\bin\greengrass-cli get-debug-password
El resultado del comando es similar al del siguiente ejemplo si ha configurado la consola de depuración local para que utilice HTTPS. Use las huellas digitales del certificado para comprobar que la conexión es segura cuando abra la consola de depuración local.
Username: debug
Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE
Password expires at: 2021-04-01T17:01:43.921999931-07:00
The local debug console is configured to use TLS security. The certificate is self-signed so you will need to bypass your web browser's security warnings to open the console.
Before you bypass the security warning, verify that the certificate fingerprint matches the following fingerprints.
SHA-256: 15 0B 2C E2 54 8B 22 DE 08 46 54 8A B1 2B 25 DE FB 02 7D 01 4E 4A 56 67 96 DA A6 CC B1 D2 C4 1B
SHA-1: BC 3E 16 04 D3 80 70 DA E0 47 25 F9 90 FA D6 02 80 3E B5 C1
El componente de vista de depuración crea una sesión que dura 8 horas. Después de eso, debe generar una nueva contraseña para volver a ver la consola de depuración local.
-
Abra e inicie sesión en el panel de control. Vea el panel de control en su dispositivo principal de Greengrass o en su computadora de desarrollo si reenvía el puerto a través de SSH. Realice una de las siguientes acciones siguientes:
-
Si habilitó HTTPS en la consola de depuración local, que es la configuración predeterminada, haga lo siguiente:
-
Abra https://localhost:1441 en su dispositivo principal o en su computadora de desarrollo si reenvió el puerto a través de SSH.
Es posible que su navegador muestre una advertencia de seguridad sobre un certificado de seguridad no válido.
-
Si su navegador muestra una advertencia de seguridad, compruebe que el certificado sea legítimo y omita la advertencia de seguridad. Haga lo siguiente:
-
Busque la huella digital SHA-256 o SHA-1 del certificado y compruebe que coincida con la huella digital SHA-256 o SHA-1 que el comando get-debug-password imprimió anteriormente. Es posible que su navegador proporcione una huella digital o ambas. Consulte la documentación de su navegador para ver el certificado y sus huellas digitales. En algunos navegadores, la huella digital del certificado se denomina huella digital.
Si la huella digital del certificado no coincide, vaya a Paso 2 para crear una nueva sesión. Si la huella digital del certificado sigue sin coincidir, es posible que la conexión no sea segura.
-
Si la huella digital del certificado coincide, omita la advertencia de seguridad del navegador para abrir la consola de depuración local. Consulte la documentación del navegador para omitir la advertencia de seguridad del navegador.
-
Inicie sesión en el sitio web con el nombre de usuario y la contraseña que el comando get-debug-password imprimió anteriormente.
Se abre la consola de depuración local.
-
Si la consola de depuración local muestra un error que indica que no se puede conectar al WebSocket debido a un error en el protocolo de enlace TLS, debe omitir la advertencia de seguridad autofirmada de la URL del WebSocket.
Haga lo siguiente:
-
Abra https://localhost:1442 en el mismo navegador en el que abrió la consola de depuración local.
-
Compruebe el certificado y omita la advertencia de seguridad.
Es posible que su navegador muestre una página HTTP 404 después de omitir la advertencia.
-
Abra https://localhost:1441 de nuevo.
La consola de depuración local muestra información sobre el dispositivo principal.
-
Si ha deshabilitado HTTPS en la consola de depuración local, haga lo siguiente:
-
Abra http://localhost:1441 en su dispositivo principal o ábralo en su computadora de desarrollo si reenvió el puerto a través de SSH.
-
Inicie sesión en el sitio web con el nombre de usuario y la contraseña que el comando get-debug-password imprimió anteriormente.
Se abre la consola de depuración local.
- v2.0.x
-
Cómo abrir la consola de depuración local
-
(Opcional) Para ver la consola de depuración local en su computadora de desarrollo, puede reenviar el puerto de la consola a través de SSH. Sin embargo, primero debe habilitar la opción AllowTcpForwarding en el archivo de configuración SSH de su dispositivo principal. Esta opción está habilitada de forma predeterminada. Ejecute el siguiente comando en su computadora de desarrollo para ver el panel de control en localhost:1441 en su computadora de desarrollo.
ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
-
Cree una sesión para usar la consola de depuración local. Cuando crea una sesión, genera una contraseña que se utiliza para autenticarse. La consola de depuración local requiere una contraseña para aumentar la seguridad, ya que puede utilizar este componente para ver información importante y realizar operaciones en el dispositivo principal.
Utilice la CLI de AWS IoT Greengrass para crear la sesión. Este comando genera una contraseña aleatoria de 43 caracteres que caduca a las 8 horas. Reemplace /greengrass/v2C:\greengrass\v2 por la ruta a la carpeta raíz de AWS IoT Greengrass V2.
Linux or UnixWindows
- Linux or Unix
sudo /greengrass/v2
- Windows
C:\greengrass\v2\bin\greengrass-cli get-debug-password
El resultado del comando tendrá un aspecto similar al siguiente ejemplo.
Username: debug
Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE
Password will expire at: 2021-04-01T17:01:43.921999931-07:00
El componente de vista de depuración crea una sesión que dura 4 horas y, a continuación, debe generar una nueva contraseña para volver a ver la consola de depuración local.
-
Abra http://localhost:1441 en su dispositivo principal o ábralo en su computadora de desarrollo si reenvió el puerto a través de SSH.
-
Inicie sesión en el sitio web con el nombre de usuario y la contraseña que el comando get-debug-password imprimió anteriormente.
Se abre la consola de depuración local.
Archivo de registro local
Este componente utiliza el mismo archivo de registro que el componente núcleo de Greengrass.
- Linux
-
/greengrass/v2
- Windows
-
C:\greengrass\v2\logs\greengrass.log
Visualización de los registros de este componente
Registros de cambios
En la siguiente tabla, se describen los cambios en cada versión del componente.
|
Versión
|
Cambios
|
|
2.4.3
|
Versión actualizada para el lanzamiento de la versión 2.13.0 del núcleo de Greengrass.
- Mejoras y correcciones de errores
-
|
|
2.4.2
|
- Mejoras y correcciones de errores
-
|
|
2.4.1
|
Versión actualizada para el lanzamiento de la versión 2.12.0 del núcleo de Greengrass. |
|
2.4.0
|
|
|
2.3.1
|
Versión actualizada para el lanzamiento de la versión 2.11.0 del núcleo de Greengrass. |
|
2.3.0
|
Versión actualizada para el lanzamiento de la versión 2.10.0 del núcleo de Greengrass. |
|
2.2.7
|
Versión actualizada para el lanzamiento de la versión 2.9.0 del núcleo de Greengrass. |
|
2.2.6
|
Versión actualizada para el lanzamiento de la versión 2.8.0 del núcleo de Greengrass. |
|
2.2.5
|
Versión actualizada para el lanzamiento de la versión 2.7.0 del núcleo de Greengrass.
|
|
2.2.4
|
Versión actualizada para el lanzamiento de la versión 2.6.0 del núcleo de Greengrass.
|
|
2.2.3
|
- Mejoras y correcciones de errores
-
-
Corrige un problema que impedía el arranque cuando el componente no podía descifrar el almacén de claves que contiene la clave privada SSL.
-
Versión actualizada para el lanzamiento de la versión 2.5.0 del núcleo de Greengrass.
|
|
2.2.2
|
Versión actualizada para el lanzamiento de la versión 2.4.0 del núcleo de Greengrass.
|
|
2.2.1
|
Versión actualizada para el lanzamiento de la versión 2.3.0 del núcleo de Greengrass.
|
|
2.2.0
|
Versión actualizada para el lanzamiento de la versión 2.2.0 del núcleo de Greengrass.
|
|
2.1.0
|
- Nuevas características
-
- Mejoras y correcciones de errores
-
|
|
2.0.3
|
Versión inicial.
|
