Como visualizar a saída da porta serial

Uma instância de máquina virtual tem quatro portas seriais virtuais. O sistema operacional da instância, o BIOS e outras entidades em nível de sistema frequentemente gravam a saída nas portas seriais, o que os torna úteis para a solucionar falhas, inicializações com falha, problemas de inicialização ou problemas de desativação.

Nesta página, descrevemos os métodos para visualizar a saída da porta serial, incluindo o uso do Stackdriver Logging para reter a saída da porta serial mesmo depois que uma instância for interrompida ou excluída. Se você precisa enviar comandos para uma porta serial enquanto uma instância estiver em execução, consulte Como interagir com o console serial.

A saída da porta serial será acessível por meio do Console do GCP, da ferramenta gcloud e da API somente quando a instância de VM estiver em execução e os logs tiverem no máximo 1 MB mais recente da saída por porta.

Se você ativar a geração de registros de saída da porta serial para o Stackdriver, os registros serão retidos por 30 dias por padrão, e o Stackdriver fornecerá os primeiros 50 GB de registros por mês gratuitamente. Consulte Preços do Stackdriver para ver mais detalhes.

Antes de começar

Como ativar e desativar a geração de registros da porta serial para o Stackdriver

É possível controlar se as instâncias enviam a saída da porta serial para o Stackdriver ao definir metadados no nível do projeto ou da instância. Também é possível desativar o recurso para todos os usuários em sua organização definindo uma política da organização.

Como definir metadados de projeto e instância

Se a geração de registros de saída da porta serial para o Stackdriver não for restrita para sua organização, será possível ativá-la ou desativá-la para projetos e instâncias de VM individuais, configurando os metadados serial-port-logging-enable como true ou false.

No nível do projeto, se serial-port-logging-enable estiver definido como true, todas as instâncias de VM no projeto herdarão essa configuração implicitamente. Se estiver definido como true no nível da instância da VM, ele será ativado apenas para essa VM, independentemente da configuração do projeto.

Por outro lado, para desativar a geração de registros de saída de porta serial para projetos ou instâncias, defina o valor de metadados serial-port-logging-enable como false. Quando esses metadados são definidos como false no nível do projeto, o registro de saída da porta serial para o Stackdriver é desativado para todas as instâncias no projeto. Quando for definido como false no nível da instância, o registro da porta serial será desativado somente para essa VM, independentemente da configuração do projeto.

É possível definir metadados por meio do Console do Google Cloud Platform, da ferramenta gcloud ou da API. Consulte Como definir metadados personalizados para mais detalhes.

Por exemplo, é possível usar o seguinte comando do gcloud para ativar o registro de saída da porta serial do Stackdriver em uma instância atual. O comando falhará se uma política organizacional impedir essa configuração.

gcloud compute instances add-metadata instance-name \
    --metadata serial-port-logging-enable=true

Para desativar o registro de saída da porta serial para o Stackdriver, defina serial-port-logging-enable como false.

gcloud compute instances add-metadata instance-name \
    --metadata serial-port-logging-enable=false

Filtros de exclusão

A partir do Stackdriver, é possível criar um filtro de exclusão para remover entradas de porta serial específicas do Visualizador de registros. Por exemplo, com serial-port-logging-enable=true no nível do projeto, será possível desativar a criação de registros de saída da porta serial para instâncias de VMs específicas com um filtro avançado, como o seguinte.

logName = "projects/project-id/logs/serialconsole.googleapis.com%2Fserial_port_1_output"
resource.type = "gce_instance"
resource.labels.instance_id != "instance-1-id"
resource.labels.instance_id != "instance-2-id"

Como definir uma política da organização

É possível desativar a geração de registros de saída da porta serial para o Stackdriver para toda sua organização, definindo uma Política da organização, que restringe certas configurações dos recursos do GCP. Especificamente, defina a seguinte restrição booleana: constraints/compute.disableSerialPortLogging. Consulte Como criar e gerenciar políticas da organização para mais informações.

A desativação do registro de porta serial ao definir constraints/compute.disableSerialPortLogging como true não é retroativa: as instâncias de VM atuais que têm metadados para ativar a geração de registros de porta serial no Stackdriver continuarão a registrar no Stackdriver, a menos que você redefina os metadados dessas instâncias.

Depois de definir essa restrição de organização como true, não será possível definir metadados de instância ou de projeto para ativar a geração de registros de saída de porta serial para o Stackdriver em nenhuma instância da organização.

Como visualizar a saída da porta serial

Console

  1. Acesse a página "Instâncias de VMs".

    Acessar a página "Instâncias de VMs"

  2. Selecione a instância de VM para visualizar a saída da porta serial.
  3. Em Registros, clique em Porta serial 1, 2, 3 ou 4. As entidades no nível do sistema geralmente usam a primeira porta serial (porta 1), que também é conhecida como console serial.

gcloud

Use o comando gcloud instances get-serial-port-output.

gcloud compute instances get-serial-port-output instance-name \
  --port port \
  --start start \
  --zone zone

em que:

  • instance-name é o nome da instância;
  • port é o número da porta (1, 2, 3, ou 4) da qual você quer visualizar a saída. As entidades no nível do sistema geralmente usam a primeira porta serial (porta 1), que também é conhecida como console serial. Por padrão, a saída da primeira porta serial é retornada;
  • start especifica o índice de bytes (base zero) do primeiro byte que você quer retornar. Use essa sinalização se quiser continuar recebendo a saída de uma solicitação anterior que era longa demais para ser retornada em uma tentativa.

API

Na API, crie uma solicitação get para o método instances.getSerialPortOutput.

GET https://www.googleapis.com/compute/projects/project-id/zones/zone/instances/instance-name/serialPort

Stackdriver

  1. Ative o registro da porta serial para o Stackdriver.
  2. Acesse a página "Instâncias de VMs".

    Acessar a página "Instâncias de VMs"

  3. Selecione a instância de VM em que você quer ver os registros do agente de inicialização.
  4. Em Registros, clique em Stackdriver Logging para ver os registros do Stackdriver.

  5. Expanda o menu suspenso Todos os registros e selecione a saída da porta serial que você quer ver. As entidades no nível do sistema geralmente usam a primeira porta serial (porta 1), que também é conhecida como console serial. Se uma porta não for exibida no menu suspenso, ela não terá saída disponível.

  6. Se quiser, expanda o menu suspenso Qualquer nível de registro para desativar os registros que estão abaixo do nível de gravidade que você quer ver. Por exemplo, se você selecionar o nível de registro "Informações", desativará as entradas de registro "Depurar". As entradas "Depurar" são normalmente usadas apenas pelo BIOS no momento da inicialização.

  7. Consulte a documentação do Stackdriver em Como visualizar registros para mais detalhes, incluindo filtros básicos e avançados.

Como manipular caracteres não UTF8

A saída da porta serial é marcada com escape usando o método de código aberto CHexEscape() da Biblioteca C++ do Abseil (em inglês). Portanto, os caracteres não UTF8 são codificados como strings hexadecimais. É possível usar o método CUnescape() correspondente para ver a saída exata que foi emitida para a porta serial.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Documentação do Compute Engine