Console de depuração local - AWS IoT Greengrass

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Console de depuração local

O componente do console de depuração local (aws.greengrass.LocalDebugConsole) fornece um painel local que exibe informações sobre seus dispositivos AWS IoT Greengrass principais e seus componentes. Você pode usar esse painel para depurar seu dispositivo principal e gerenciar componentes locais.

Importante

Recomendamos que você use esse componente somente em ambientes de desenvolvimento, não em ambientes de produção. Esse componente fornece acesso a informações e operações que você normalmente não precisará em um ambiente de produção. Siga o princípio do menor privilégio implantando esse componente somente nos dispositivos principais onde você precisar dele.

Versões

Esse componente tem as seguintes versões:

  • 2.3.x

  • 2.2.x

  • 2.1.x

  • 2.0.x

Tipo

Este componente é um componente de plug-in (aws.greengrass.plugin). O núcleo do Greengrass executa esse componente na mesma Java Virtual Machine (JVM) do núcleo. O núcleo reinicia quando você altera a versão desse componente no dispositivo principal.

Esse componente usa o mesmo arquivo de log do núcleo do Greengrass. Para ter mais informações, consulte Monitore AWS IoT Greengrass os registros.

Para ter mais informações, consulte Tipos de componentes.

Sistema operacional

Esse componente pode ser instalado em dispositivos principais que executam os seguintes sistemas operacionais:

  • Linux

  • Windows

Requisitos

Esse componente tem os seguintes requisitos:

  • Você usa um nome de usuário e senha para entrar no painel. O nome de usuário, que édebug, é fornecido para você. Você deve usar a AWS IoT Greengrass CLI para criar uma senha temporária que autentique você com o painel em um dispositivo principal. Você deve ser capaz de usar a AWS IoT Greengrass CLI para usar o console de depuração local. Para obter mais informações, consulte os requisitos da CLI do Greengrass. Para obter mais informações sobre como gerar a senha e fazer login, consulte Uso do componente do console de depuração local.

  • O componente do console de depuração local tem suporte para execução em uma VPC.

Dependências

Quando você implanta um componente, AWS IoT Greengrass também implanta versões compatíveis de suas dependências. Isso significa que você deve atender aos requisitos do componente e de todas as suas dependências para implantá-lo com êxito. Esta seção lista as dependências das versões lançadas desse componente e as restrições de versão semântica que definem as versões dos componentes para cada dependência. Você também pode visualizar as dependências de cada versão do componente no AWS IoT Greengrass console. Na página de detalhes do componente, procure a lista de dependências.

2.4.1 – 2.4.2

A tabela a seguir lista as dependências das versões 2.4.1 a 2.4.2 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.10.0 <2.13.0 Rígido
CLI do Greengrass >=2.10.0 <2.13.0 Rígido
2.4.0

A tabela a seguir lista as dependências da versão 2.4.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2,10,0 <2,12,0 Rígido
CLI do Greengrass >=2,10,0 <2,12,0 Rígido
2.3.0 and 2.3.1

A tabela a seguir lista as dependências das versões 2.3.0 e 2.3.1 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2,10,0 <2,12,0 Rígido
CLI do Greengrass >=2,10,0 <2,12,0 Rígido
2.2.9

A tabela a seguir lista as dependências da versão 2.2.9 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.12.0 Rígido
CLI do Greengrass >=2.1.0 <2.12.0 Rígido
2.2.8

A tabela a seguir lista as dependências da versão 2.2.8 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.11.0 Rígido
CLI do Greengrass >=2.1.0 <2.11.0 Rígido
2.2.7

A tabela a seguir lista as dependências da versão 2.2.7 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.10.0 Rígido
CLI do Greengrass >=2.1.0 <2.10.0 Rígido
2.2.6

A tabela a seguir lista as dependências da versão 2.2.6 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.9.0 Rígido
CLI do Greengrass >=2.1.0 <2.9.0 Rígido
2.2.5

A tabela a seguir lista as dependências da versão 2.2.5 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.8.0 Rígido
CLI do Greengrass >=2.1.0 <2.8.0 Rígido
2.2.4

A tabela a seguir lista as dependências da versão 2.2.4 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.7.0 Rígido
CLI do Greengrass >=2.1.0 <2.7.0 Rígido
2.2.3

A tabela a seguir lista as dependências da versão 2.2.3 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.6.0 Rígido
CLI do Greengrass >=2.1.0 <2.6.0 Rígido
2.2.2

A tabela a seguir lista as dependências da versão 2.2.2 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.5.0 Rígido
CLI do Greengrass >=2.1.0 <2.5.0 Rígido
2.2.1

A tabela a seguir lista as dependências da versão 2.2.1 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.4.0 Rígido
CLI do Greengrass >=2.1.0 <2.4.0 Rígido
2.2.0

A tabela a seguir lista as dependências da versão 2.2.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.3.0 Rígido
CLI do Greengrass >=2.1.0 <2.3.0 Rígido
2.1.0

A tabela a seguir lista as dependências da versão 2.1.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.1.0 <2.2.0 Rígido
CLI do Greengrass >=2.1.0 <2.2.0 Rígido
2.0.x

A tabela a seguir lista as dependências da versão 2.0.x desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo Greengrass >=2.0.3 <2.1.0 Flexível
CLI do Greengrass >=2.0.3 <2.1.0 Flexível

Para obter mais informações sobre dependências de componentes, consulte a referência da receita do componente.

Configuração

Esse componente fornece os seguintes parâmetros de configuração que você pode personalizar ao implantar o componente.

v2.1.x - v2.4.x
httpsEnabled

(Opcional) Você pode ativar a comunicação HTTPS para o console de depuração local. Se você habilitar a comunicação HTTPS, o console de depuração local criará um certificado autoassinado. Os navegadores da Web mostram avisos de segurança para sites que usam certificados autoassinados, portanto, você deve verificar o certificado manualmente. Em seguida, você pode ignorar o aviso. Para ter mais informações, consulte Uso.

Padrão: true

port

(Opcional) A porta na qual fornecer o console de depuração local.

Padrão: 1441

websocketPort

(Opcional) A porta do websocket a ser usada para o console de depuração local.

Padrão: 1442

bindHostname

(Opcional) O nome do host a ser usado no console de depuração local.

Se você executar o software AWS IoT Greengrass Core em um contêiner do Docker, defina esse parâmetro como0.0.0.0, para poder abrir o console de depuração local fora do contêiner do Docker.

Padrão: localhost

exemplo Exemplo: atualização da mesclagem de configurações

O exemplo de configuração a seguir especifica a abertura do console de depuração local em portas não padrão e a desativação do HTTPS.

{ "httpsEnabled": false, "port": "10441", "websocketPort": "10442" }
v2.0.x
port

(Opcional) A porta na qual fornecer o console de depuração local.

Padrão: 1441

websocketPort

(Opcional) A porta do websocket a ser usada para o console de depuração local.

Padrão: 1442

bindHostname

(Opcional) O nome do host a ser usado no console de depuração local.

Se você executar o software AWS IoT Greengrass Core em um contêiner do Docker, defina esse parâmetro como0.0.0.0, para poder abrir o console de depuração local fora do contêiner do Docker.

Padrão: localhost

exemplo Exemplo: atualização da mesclagem de configurações

O exemplo de configuração a seguir especifica a abertura do console de depuração local em portas não padrão.

{ "port": "10441", "websocketPort": "10442" }

Uso

Para usar o console de depuração local, crie uma sessão a partir da CLI do Greengrass. Quando você cria uma sessão, a CLI do Greengrass fornece um nome de usuário e uma senha temporária que você pode usar para entrar no console de depuração local.

Siga estas instruções para abrir o console de depuração local em seu dispositivo principal ou em seu computador de desenvolvimento.

v2.1.x - v2.4.x

Nas versões 2.1.0 e posteriores, o console de depuração local usa HTTPS por padrão. Quando o HTTPS está habilitado, o console de depuração local cria um certificado autoassinado para proteger a conexão. Seu navegador mostra um aviso de segurança quando você abre o console de depuração local devido a esse certificado autoassinado. Quando você cria uma sessão com a CLI do Greengrass, a saída inclui as impressões digitais do certificado, para que você possa verificar se o certificado é legítimo e se a conexão é segura.

Você pode desativar o HTTPS. Para obter mais informações, consulte Configuração do console de depuração local.

Para abrir o console de depuração local
  1. (Opcional) Para visualizar o console de depuração local em seu computador de desenvolvimento, você pode encaminhar a porta do console via SSH. No entanto, você deve primeiro ativar a AllowTcpForwarding opção no arquivo de configuração SSH do seu dispositivo principal. Essa opção é habilitada por padrão. Execute o comando a seguir em seu computador de desenvolvimento para visualizar o painel localhost:1441 em seu computador de desenvolvimento.

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    nota

    Você pode alterar as portas padrão de 1441 1442 e. Para obter mais informações, consulte Configuração do console de depuração local.

  2. Crie uma sessão para usar o console de depuração local. Ao criar uma sessão, você gera uma senha que usa para autenticar. O console de depuração local exige uma senha para aumentar a segurança, pois você pode usar esse componente para visualizar informações importantes e realizar operações no dispositivo principal. O console de depuração local também cria um certificado para proteger a conexão se você habilitar HTTPS na configuração do componente. O HTTPS está habilitado por padrão.

    Use a AWS IoT Greengrass CLI para criar a sessão. Esse comando gera uma senha aleatória de 43 caracteres que expira após 8 horas. Substitua /greengrass/v2 ou C:\greengrass\v2 pelo caminho para a pasta AWS IoT Greengrass V2 raiz.

    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

    A saída do comando se parece com o exemplo a seguir se você tiver configurado o console de depuração local para usar HTTPS. Você usa as impressões digitais do certificado para verificar se a conexão é segura ao abrir o console de depuração 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

    O componente debug view cria uma sessão que dura 8 horas. Depois disso, você deve gerar uma nova senha para visualizar novamente o console de depuração local.

  3. Abra e faça login no painel. Visualize o painel em seu dispositivo principal do Greengrass ou em seu computador de desenvolvimento se você encaminhar a porta por SSH. Execute um destes procedimentos:

    • Se você habilitou o HTTPS no console de depuração local, que é a configuração padrão, faça o seguinte:

      1. Abra https://localhost:1441 em seu dispositivo principal ou em seu computador de desenvolvimento se você encaminhou a porta por SSH.

        Seu navegador pode mostrar um aviso de segurança sobre um certificado de segurança inválido.

      2. Se seu navegador mostrar um aviso de segurança, verifique se o certificado é legítimo e ignore o aviso de segurança. Faça o seguinte:

        1. Encontre a impressão digital SHA-256 ou SHA-1 do certificado e verifique se ela corresponde à impressão digital SHA-256 ou SHA-1 que o comando imprimiu anteriormente. get-debug-password Seu navegador pode fornecer uma ou ambas as impressões digitais. Consulte a documentação do seu navegador para ver o certificado e suas impressões digitais. Em alguns navegadores, a impressão digital do certificado é chamada de impressão digital.

          nota

          Se a impressão digital do certificado não corresponder, acesse Passo 2 para criar uma nova sessão. Se a impressão digital do certificado ainda não corresponder, sua conexão pode estar insegura.

        2. Se a impressão digital do certificado corresponder, ignore o aviso de segurança do seu navegador para abrir o console de depuração local. Consulte a documentação do seu navegador para ignorar o aviso de segurança do navegador.

      3. Faça login no site usando o nome de usuário e a senha que o get-debug-password comando imprimiu anteriormente.

        O console de depuração local é aberto.

      4. Se o console de depuração local mostrar um erro informando que não é possível se conectar ao WebSocket devido a uma falha no handshake de TLS, você deverá ignorar o aviso de segurança autoassinado do URL. WebSocket

        O erro de handshake WebSocket TLS no console de depuração local.

        Faça o seguinte:

        1. Abra https://localhost:1442 no mesmo navegador em que você abriu o console de depuração local.

        2. Verifique o certificado e ignore o aviso de segurança.

          Seu navegador pode mostrar uma página HTTP 404 depois que você ignorar o aviso.

        3. Abra https://localhost:1441 novamente.

          O console de depuração local mostra informações sobre o dispositivo principal.

    • Se você desativou o HTTPS no console de depuração local, faça o seguinte:

      1. Abra http://localhost:1441 em seu dispositivo principal ou abra-o em seu computador de desenvolvimento se você encaminhou a porta por SSH.

      2. Faça login no site usando o nome de usuário e a senha que o get-debug-password comando imprimiu anteriormente.

        O console de depuração local é aberto.

v2.0.x
Para abrir o console de depuração local
  1. (Opcional) Para visualizar o console de depuração local em seu computador de desenvolvimento, você pode encaminhar a porta do console via SSH. No entanto, você deve primeiro ativar a AllowTcpForwarding opção no arquivo de configuração SSH do seu dispositivo principal. Essa opção é habilitada por padrão. Execute o comando a seguir em seu computador de desenvolvimento para visualizar o painel localhost:1441 em seu computador de desenvolvimento.

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    nota

    Você pode alterar as portas padrão de 1441 1442 e. Para obter mais informações, consulte Configuração do console de depuração local.

  2. Crie uma sessão para usar o console de depuração local. Ao criar uma sessão, você gera uma senha que usa para autenticar. O console de depuração local exige uma senha para aumentar a segurança, pois você pode usar esse componente para visualizar informações importantes e realizar operações no dispositivo principal.

    Use a AWS IoT Greengrass CLI para criar a sessão. Esse comando gera uma senha aleatória de 43 caracteres que expira após 8 horas. Substitua /greengrass/v2 ou C:\greengrass\v2 pelo caminho para a pasta AWS IoT Greengrass V2 raiz.

    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

    A saída do comando se parece com o exemplo a seguir.

    Username: debug Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE Password will expire at: 2021-04-01T17:01:43.921999931-07:00

    O componente de visualização de depuração cria uma sessão que dura 4 horas e, em seguida, você deve gerar uma nova senha para visualizar novamente o console de depuração local.

  3. Abra http://localhost:1441 em seu dispositivo principal ou abra-o em seu computador de desenvolvimento se você encaminhou a porta por SSH.

  4. Faça login no site usando o nome de usuário e a senha que o get-debug-password comando imprimiu anteriormente.

    O console de depuração local é aberto.

Arquivo de log local

Esse componente usa o mesmo arquivo de log do componente do núcleo do Greengrass.

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
Para ver os registros desse componente
  • Execute o comando a seguir no dispositivo principal para visualizar o arquivo de log desse componente em tempo real. Substitua /greengrass/v2 ou C:\greengrass\v2 pelo caminho para a pasta AWS IoT Greengrass raiz.

    Linux
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

Changelog

A tabela a seguir descreve as alterações em cada versão do componente.

Version (Versão)

Alterações

2.4.2

Correções de erros e melhorias
  • Melhorias e correções de erros gerais.

2.4.1

Versão atualizada para a versão 2.12.0 do Greengrass nucleus.

2.4.0

Novos atributos
  • Adiciona o console de depuração do gerenciador de streams.

2.3.1

Versão atualizada para a versão 2.11.0 do Greengrass nucleus.

2.3.0

Versão atualizada para a versão 2.10.0 do Greengrass nucleus.
Novos atributos
  • Inclui um PubSub cliente de depuração AWS IoT Core MQTT.

2.2.7

Versão atualizada para a versão 2.9.0 do Greengrass nucleus.

2.2.6

Versão atualizada para a versão 2.8.0 do Greengrass nucleus.

2.2.5

Versão atualizada para a versão 2.7.0 do Greengrass nucleus.

2.2.4

Versão atualizada para a versão 2.6.0 do Greengrass nucleus.

2.2.3

Correções de erros e melhorias
  • Corrige um problema que impedia a inicialização quando o componente não conseguia descriptografar o repositório de chaves que contém a chave privada SSL.

  • Versão atualizada para a versão 2.5.0 do Greengrass nucleus.

2.2.2

Versão atualizada para a versão 2.4.0 do Greengrass nucleus.

2.2.1

Versão atualizada para a versão 2.3.0 do Greengrass nucleus.

2.2.0

Versão atualizada para a versão 2.2.0 do Greengrass nucleus.

2.1.0

Novos atributos
  • Usa HTTPS para proteger sua conexão com o console de depuração local. O HTTPS está habilitado por padrão.

Correções de erros e melhorias
  • Você pode ignorar as mensagens da barra de flash no editor de configuração.

2.0.3

Versão inicial.