Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Console de débogage locale
Le composant de console de débogage local (aws.greengrass.LocalDebugConsole
) fournit un tableau de bord local qui affiche des informations sur vos AWS IoT Greengrass principaux appareils et leurs composants. Vous pouvez utiliser ce tableau de bord pour déboguer votre appareil principal et gérer les composants locaux.
Nous vous recommandons d'utiliser ce composant uniquement dans les environnements de développement, et non dans les environnements de production. Ce composant permet d'accéder aux informations et aux opérations dont vous n'avez généralement pas besoin dans un environnement de production. Suivez le principe du moindre privilège en déployant ce composant uniquement sur les appareils principaux là où vous en avez besoin.
Versions
Les versions de ce composant sont les suivantes :
Type
Ce composant est un composant de plugin (aws.greengrass.plugin
). Le noyau Greengrass exécute ce composant dans la même machine virtuelle Java (JVM) que le noyau. Le noyau redémarre lorsque vous modifiez la version de ce composant sur le périphérique principal.
Ce composant utilise le même fichier journal que le noyau Greengrass. Pour plus d’informations, consultez AWS IoT GreengrassJournaux de surveillance.
Pour plus d’informations, consultez Types de composants.
Système d’exploitation
Ce composant peut être installé sur les appareils principaux qui exécutent les systèmes d'exploitation suivants :
Prérequis
Ce composant répond aux exigences suivantes :
-
Vous utilisez un nom d'utilisateur et un mot de passe pour vous connecter au tableau de bord. Le nom d'utilisateur, qui estdebug
, vous est fourni. Vous devez utiliser la AWS IoT Greengrass CLI pour créer un mot de passe temporaire qui vous authentifie auprès du tableau de bord d'un appareil principal. Vous devez être en mesure d'utiliser la AWS IoT Greengrass CLI pour utiliser la console de débogage locale. Pour plus d'informations, consultez les exigences de Greengrass CLI. Pour plus d'informations sur la façon de générer le mot de passe et de se connecter, voir Utilisation des composants de la console de débogage locale.
-
Le composant de console de débogage local peut être exécuté dans un VPC.
Dépendances
Lorsque vous déployez un composant, il déploie AWS IoT Greengrass également des versions compatibles de ses dépendances. Cela signifie que vous devez satisfaire aux exigences relatives au composant et à toutes ses dépendances pour réussir le déploiement du composant. Cette section répertorie les dépendances des versions publiées de ce composant et les contraintes de version sémantiques qui définissent les versions des composants pour chaque dépendance. Vous pouvez également consulter les dépendances de chaque version du composant dans la AWS IoT Greengrass console. Sur la page de détails du composant, recherchez la liste des dépendances.
- 2.4.1 – 2.4.2
-
Le tableau suivant répertorie les dépendances pour les versions 2.4.1 à 2.4.2 de ce composant.
- 2.4.0
-
Le tableau suivant répertorie les dépendances pour la version 2.4.0 de ce composant.
- 2.3.0 and 2.3.1
-
Le tableau suivant répertorie les dépendances pour les versions 2.3.0 et 2.3.1 de ce composant.
- 2.2.9
-
Le tableau suivant répertorie les dépendances pour la version 2.2.9 de ce composant.
- 2.2.8
-
Le tableau suivant répertorie les dépendances pour la version 2.2.8 de ce composant.
- 2.2.7
-
Le tableau suivant répertorie les dépendances pour la version 2.2.7 de ce composant.
- 2.2.6
-
Le tableau suivant répertorie les dépendances pour la version 2.2.6 de ce composant.
- 2.2.5
-
Le tableau suivant répertorie les dépendances pour la version 2.2.5 de ce composant.
- 2.2.4
-
Le tableau suivant répertorie les dépendances pour la version 2.2.4 de ce composant.
- 2.2.3
-
Le tableau suivant répertorie les dépendances pour la version 2.2.3 de ce composant.
- 2.2.2
-
Le tableau suivant répertorie les dépendances pour la version 2.2.2 de ce composant.
- 2.2.1
-
Le tableau suivant répertorie les dépendances pour la version 2.2.1 de ce composant.
- 2.2.0
-
Le tableau suivant répertorie les dépendances pour la version 2.2.0 de ce composant.
- 2.1.0
-
Le tableau suivant répertorie les dépendances pour la version 2.1.0 de ce composant.
- 2.0.x
-
Le tableau suivant répertorie les dépendances pour la version 2.0.x de ce composant.
Pour plus d'informations sur les dépendances des composants, consultez la référence de la recette des composants.
Configuration
Ce composant fournit les paramètres de configuration suivants que vous pouvez personnaliser lorsque vous déployez le composant.
- v2.1.x - v2.4.x
-
httpsEnabled
-
(Facultatif) Vous pouvez activer la communication HTTPS pour la console de débogage locale. Si vous activez la communication HTTPS, la console de débogage locale crée un certificat auto-signé. Les navigateurs Web affichent des avertissements de sécurité pour les sites Web qui utilisent des certificats auto-signés. Vous devez donc vérifier le certificat manuellement. Ensuite, vous pouvez contourner l'avertissement. Pour plus d’informations, consultez Utilisation.
Par défaut: true
port
-
(Facultatif) Port sur lequel fournir la console de débogage locale.
Par défaut : 1441
websocketPort
-
(Facultatif) Le port websocket à utiliser pour la console de débogage locale.
Par défaut : 1442
bindHostname
-
(Facultatif) Le nom d'hôte à utiliser pour la console de débogage locale.
Si vous exécutez le logiciel AWS IoT Greengrass Core dans un conteneur Docker, définissez ce paramètre sur afin de pouvoir ouvrir la console de débogage locale en dehors du conteneur Docker. 0.0.0.0
Par défaut : localhost
Exemple : mise à jour de la fusion de configurations
L'exemple de configuration suivant indique d'ouvrir la console de débogage locale sur des ports autres que ceux par défaut et de désactiver le protocole HTTPS.
{
"httpsEnabled": false,
"port": "10441",
"websocketPort": "10442"
}
- v2.0.x
-
port
-
(Facultatif) Port sur lequel fournir la console de débogage locale.
Par défaut : 1441
websocketPort
-
(Facultatif) Le port websocket à utiliser pour la console de débogage locale.
Par défaut : 1442
bindHostname
-
(Facultatif) Le nom d'hôte à utiliser pour la console de débogage locale.
Si vous exécutez le logiciel AWS IoT Greengrass Core dans un conteneur Docker, définissez ce paramètre sur afin de pouvoir ouvrir la console de débogage locale en dehors du conteneur Docker. 0.0.0.0
Par défaut : localhost
Exemple : mise à jour de la fusion de configurations
L'exemple de configuration suivant indique d'ouvrir la console de débogage locale sur des ports autres que ceux par défaut.
{
"port": "10441",
"websocketPort": "10442"
}
Utilisation
Pour utiliser la console de débogage locale, créez une session à partir de la CLI Greengrass. Lorsque vous créez une session, la CLI Greengrass fournit un nom d'utilisateur et un mot de passe temporaire que vous pouvez utiliser pour vous connecter à la console de débogage locale.
Suivez ces instructions pour ouvrir la console de débogage locale sur votre périphérique principal ou sur votre ordinateur de développement.
- v2.1.x - v2.4.x
-
Dans les versions 2.1.0 et ultérieures, la console de débogage locale utilise HTTPS par défaut. Lorsque le protocole HTTPS est activé, la console de débogage locale crée un certificat auto-signé pour sécuriser la connexion. Votre navigateur Web affiche un avertissement de sécurité lorsque vous ouvrez la console de débogage locale en raison de ce certificat auto-signé. Lorsque vous créez une session avec la CLI Greengrass, la sortie inclut les empreintes digitales du certificat, afin que vous puissiez vérifier que le certificat est légitime et que la connexion est sécurisée.
Vous pouvez désactiver le protocole HTTPS. Pour plus d'informations, consultez la section Configuration de la console de débogage locale.
Pour ouvrir la console de débogage locale
-
(Facultatif) Pour afficher la console de débogage locale sur votre ordinateur de développement, vous pouvez transférer le port de la console via SSH. Cependant, vous devez d'abord activer l'AllowTcpForwarding
option dans le fichier de configuration SSH de votre appareil principal. Cette option est activée par défaut. Exécutez la commande suivante sur votre ordinateur de développement pour afficher le tableau de bord localhost:1441
sur votre ordinateur de développement.
ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username
@core-device-ip-address
-
Créez une session pour utiliser la console de débogage locale. Lorsque vous créez une session, vous générez un mot de passe que vous utilisez pour vous authentifier. La console de débogage locale nécessite un mot de passe pour renforcer la sécurité, car vous pouvez utiliser ce composant pour afficher des informations importantes et effectuer des opérations sur le périphérique principal. La console de débogage locale crée également un certificat pour sécuriser la connexion si vous activez le protocole HTTPS dans la configuration du composant. Le protocole HTTPS est activé par défaut.
Utilisez la AWS IoT Greengrass CLI pour créer la session. Cette commande génère un mot de passe aléatoire de 43 caractères qui expire au bout de 8 heures. Remplacez /greengrass/v2
C:\greengrass\v2
par le chemin d'accès au dossier AWS IoT Greengrass V2 racine.
Linux or UnixWindows
- Linux or Unix
sudo /greengrass/v2
/bin/greengrass-cli get-debug-password
- Windows
C:\greengrass\v2
\bin\greengrass-cli get-debug-password
La sortie de commande ressemble à l'exemple suivant si vous avez configuré la console de débogage locale pour utiliser le protocole HTTPS. Vous utilisez les empreintes du certificat pour vérifier que la connexion est sécurisée lorsque vous ouvrez la console de débogage locale.
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
Le composant debug view crée une session d'une durée de 8 heures. Ensuite, vous devez générer un nouveau mot de passe pour afficher à nouveau la console de débogage locale.
-
Ouvrez le tableau de bord et connectez-vous à celui-ci. Consultez le tableau de bord sur votre appareil principal Greengrass ou sur votre ordinateur de développement si vous transférez le port via SSH. Effectuez l’une des actions suivantes :
-
Si vous avez activé le protocole HTTPS dans la console de débogage locale, qui est le paramètre par défaut, procédez comme suit :
-
Ouvrez https://localhost:1441
sur votre périphérique principal ou sur votre ordinateur de développement si vous avez transféré le port via SSH.
Il est possible que votre navigateur affiche un avertissement de sécurité concernant un certificat de sécurité non valide.
-
Si votre navigateur affiche un avertissement de sécurité, vérifiez que le certificat est légitime et contournez l'avertissement de sécurité. Procédez comme suit :
-
Recherchez l'empreinte SHA-256 ou SHA-1 du certificat et vérifiez qu'elle correspond à l'empreinte SHA-256 ou SHA-1 précédemment imprimée par la commande. get-debug-password
Votre navigateur peut fournir une ou les deux empreintes digitales. Consultez la documentation de votre navigateur pour consulter le certificat et ses empreintes digitales. Dans certains navigateurs, l'empreinte du certificat est appelée empreinte numérique.
Si l'empreinte du certificat ne correspond pas, accédez Étape 2 à pour créer une nouvelle session. Si l'empreinte du certificat ne correspond toujours pas, votre connexion n'est peut-être pas sécurisée.
-
Si l'empreinte du certificat correspond, ignorez l'avertissement de sécurité de votre navigateur pour ouvrir la console de débogage locale. Consultez la documentation de votre navigateur pour contourner l'avertissement de sécurité du navigateur.
-
Connectez-vous au site Web en utilisant le nom d'utilisateur et le mot de passe que la get-debug-password
commande a imprimés précédemment.
La console de débogage locale s'ouvre.
-
Si la console de débogage locale affiche une erreur indiquant qu'elle ne peut pas se connecter au WebSocket en raison d'un échec de connexion TLS, vous devez ignorer l'avertissement de sécurité auto-signé pour l'URL. WebSocket
Procédez comme suit :
-
Ouvrez https://localhost:1442
dans le même navigateur que celui dans lequel vous avez ouvert la console de débogage locale.
-
Vérifiez le certificat et contournez l'avertissement de sécurité.
Votre navigateur peut afficher une page HTTP 404 une fois que vous avez ignoré l'avertissement.
-
Ouvrez https://localhost:1441
à nouveau.
La console de débogage locale affiche des informations sur le périphérique principal.
-
Si vous avez désactivé le protocole HTTPS dans la console de débogage locale, procédez comme suit :
-
http://localhost:1441
Ouvrez-le sur votre périphérique principal ou ouvrez-le sur votre ordinateur de développement si vous avez transféré le port via SSH.
-
Connectez-vous au site Web en utilisant le nom d'utilisateur et le mot de passe que la get-debug-password
commande a précédemment imprimés.
La console de débogage locale s'ouvre.
- v2.0.x
-
Pour ouvrir la console de débogage locale
-
(Facultatif) Pour afficher la console de débogage locale sur votre ordinateur de développement, vous pouvez transférer le port de la console via SSH. Cependant, vous devez d'abord activer l'AllowTcpForwarding
option dans le fichier de configuration SSH de votre appareil principal. Cette option est activée par défaut. Exécutez la commande suivante sur votre ordinateur de développement pour afficher le tableau de bord localhost:1441
sur votre ordinateur de développement.
ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username
@core-device-ip-address
-
Créez une session pour utiliser la console de débogage locale. Lorsque vous créez une session, vous générez un mot de passe que vous utilisez pour vous authentifier. La console de débogage locale nécessite un mot de passe pour renforcer la sécurité, car vous pouvez utiliser ce composant pour afficher des informations importantes et effectuer des opérations sur le périphérique principal.
Utilisez la AWS IoT Greengrass CLI pour créer la session. Cette commande génère un mot de passe aléatoire de 43 caractères qui expire au bout de 8 heures. Remplacez /greengrass/v2
C:\greengrass\v2
par le chemin d'accès au dossier AWS IoT Greengrass V2 racine.
Linux or UnixWindows
- Linux or Unix
sudo /greengrass/v2
/bin/greengrass-cli get-debug-password
- Windows
C:\greengrass\v2
\bin\greengrass-cli get-debug-password
La sortie de commande ressemble à l'exemple suivant.
Username: debug
Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE
Password will expire at: 2021-04-01T17:01:43.921999931-07:00
Le composant d'affichage du débogage crée une session qui dure 4 heures, puis vous devez générer un nouveau mot de passe pour afficher à nouveau la console de débogage locale.
-
http://localhost:1441
Ouvrez-le sur votre périphérique principal ou ouvrez-le sur votre ordinateur de développement si vous avez transféré le port via SSH.
-
Connectez-vous au site Web en utilisant le nom d'utilisateur et le mot de passe que la get-debug-password
commande a précédemment imprimés.
La console de débogage locale s'ouvre.
Fichier journal local
Ce composant utilise le même fichier journal que le composant Greengrass nucleus.
- Linux
-
/greengrass/v2
/logs/greengrass.log
- Windows
-
C:\greengrass\v2
\logs\greengrass.log
Pour consulter les journaux de ce composant
Journal des modifications
Le tableau suivant décrit les modifications apportées à chaque version du composant.
Version
|
Modifications
|
2.4.2
|
- Corrections de bogues et améliorations
-
|
2.4.1
|
Version mise à jour pour la version 2.12.0 de Greengrass Nucleus. |
2.4.0
|
- Nouvelles fonctionnalités
-
|
2.3.1
|
Version mise à jour pour la version 2.11.0 de Greengrass Nucleus. |
2.3.0
|
Version mise à jour pour la version 2.10.0 de Greengrass Nucleus.
- Nouvelles fonctionnalités
-
|
2.2.7
|
Version mise à jour pour la version 2.9.0 de Greengrass Nucleus. |
2.2.6
|
Version mise à jour pour la version 2.8.0 de Greengrass Nucleus. |
2.2.5
|
Version mise à jour pour la version 2.7.0 de Greengrass Nucleus.
|
2.2.4
|
Version mise à jour pour la version 2.6.0 de Greengrass Nucleus.
|
2.2.3
|
- Corrections de bogues et améliorations
-
|
2.2.2
|
Version mise à jour pour la version 2.4.0 de Greengrass Nucleus.
|
2.2.1
|
Version mise à jour pour la version 2.3.0 de Greengrass Nucleus.
|
2.2.0
|
Version mise à jour pour la version 2.2.0 de Greengrass Nucleus.
|
2.1.0
|
- Nouvelles fonctionnalités
-
- Corrections de bogues et améliorations
-
|
2.0.3
|
Première version.
|