Como coletar informações de diagnóstico

Neste documento, você verá como coletar informações sobre uma instância de máquina virtual (VM) usando uma ferramenta de diagnóstico. Use as informações coletadas pelas ferramentas para ajudar na solução de problemas básicos antes de entrar em contato com o Cloud Customer Care.

A ferramenta faz o seguinte:

  • Coleta informações somente da VM especificada.

  • Armazena as informações apenas no seu projeto.

  • Armazena as informações por 10 dias em um bucket do Cloud Storage que, por padrão, só pode ser acessado por você.

Antes de compartilhar as informações coletadas com o Atendimento ao Cliente, faça o seguinte:

  1. Revise as informações em busca de informações confidenciais ou de identificação pessoal (PII, na sigla em inglês).

  2. Exclua ou mascare as informações conforme necessário.

Antes de começar

  • O Compute Engine instala a ferramenta de diagnóstico por padrão em versões públicas das imagens do Windows Server posteriormente a v20190714. Caso contrário, se a versão de imagem do Windows Server for anterior a v20190714 ou se você estiver usando uma imagem personalizada, instale a ferramenta usando o comando googet install google-compute-engine-diagnostics.
  • Configure a autenticação, caso ainda não tenha feito isso. Com isso, você confirma sua identidade para acesso a serviços e APIs do Google Cloud . Para executar códigos ou amostras de um ambiente de desenvolvimento local, autentique-se no Compute Engine selecionando uma das seguintes opções:

    Selecione a guia para como planeja usar as amostras nesta página:

    Console

    Quando você usa o console do Google Cloud para acessar os serviços e as APIs do Google Cloud , não é necessário configurar a autenticação.

    gcloud

    1. Instale a CLI do Google Cloud. Após a instalação, inicialize a Google Cloud CLI executando o seguinte comando: 

      gcloud init

      Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

  • Defina uma região e uma zona padrão.

Informações de diagnóstico coletadas da VM

Com essa ferramenta de diagnóstico, é possível coletar informações sobre o seguinte:

Para informações detalhadas sobre como o Compute Engine coleta essas informações, consulte o repositório público do GitHub.

Limitações

  • Só é possível coletar informações de diagnóstico de VMs criadas com base no Windows Server.

Funções exigidas

Para receber as permissões necessárias para executar a ferramenta de diagnóstico usando a Google Cloud CLI, peça ao administrador para conceder a você o papel do IAM de Criador de token da conta de serviço (roles/iam.serviceAccountTokenCreator) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.

Para anexar informações de diagnóstico a um caso de suporte, você também precisa do papel de editor de suporte técnico (roles/cloudsupport.techSupportEditor).

Como coletar informações de diagnóstico de uma VM

Execute a ferramenta de diagnóstico diretamente da VM ou remotamente, usando a CLI do Google Cloud.

gcloud

  1. Se ainda não tiver feito isso, conceda o papel iam.serviceAccountTokenCreator no projeto à conta de usuário ou de serviço que executará o comando gcloud compute diagnose export-logs:

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member user:EMAIL \
    --role roles/iam.serviceAccountTokenCreator

    Substitua:

    • PROJECT_ID: o ID do projeto;
    • EMAIL: endereço de e-mail para conceder o papel iam.serviceAccountTokenCreator

  2. Exporte as informações de diagnóstico como um objeto para um bucket do Cloud Storage usando o comando diagnose export-logs.

    gcloud compute diagnose export-logs VM_NAME \
  [--collect-process-traces]

    A flag opcional --collect-process-traces especifica se a ferramenta de diagnóstico coleta um trace de 10 minutos do sistema em execução, que inclui atividades de CPU, disco, arquivo e atividade da rede. Em VMs baseadas no Windows, isso usa o Gravador de desempenho do Windows.

    Substitua VM_NAME pelo nome da VM de onde você quer coletar informações de diagnóstico.

  3. O processo de exportação de registros pode levar alguns minutos para ser concluído. Confira o status usando o comando gcloud compute instances get-serial-port-output.

  4. Com o Compute Engine, é possível formatar o nome do bucket que contém as informações de diagnóstico como diagnostic_logs_project_PROJECT_NUMBER. Veja ou faça o download do bucket usando a CLI gcloud ou, no console doGoogle Cloud , na página Cloud Storage:

    Acesse "Armazenamento"

Localmente (somente Windows)

Para executar a ferramenta de diagnóstico em uma VM do Windows, faça o seguinte:

  1. Conecte-se à VM do Windows.

  2. Abra um prompt de comando ou uma janela do PowerShell com privilégios de administrador.

  3. Navegue até o diretório que contém a ferramenta de diagnóstico:

    cd "C:\Program Files\Google\Compute Engine\diagnostics"

  4. Execute a ferramenta de diagnóstico:

    .\diagnostics.exe

    Depois que a ferramenta terminar de ser executada, ela vai salvar as informações de diagnóstico coletadas no arquivo compactado logs.zip no diretório de trabalho atual.

Sinalizações opcionais

  • -trace: captura outras informações de rastreamento. A ferramenta captura um rastreamento de 10 minutos do sistema usando o Gravador de Desempenho do Windows, que inclui atividades de CPU, disco, arquivo e atividade da rede.

Anexar informações de diagnóstico a um caso de suporte

Se você tiver um caso aberto com o Cloud Customer Care, poderá anexar informações de diagnóstico diretamente ao caso ao coletá-las. Essa opção evita que você faça o download do arquivo do Cloud Storage e o anexe ao caso.

As informações de diagnóstico são anexadas ao caso sem uma etapa de revisão. Se você precisar revisar as informações ou remover informações confidenciais ou de identificação pessoal (PII) antes de compartilhá-las, não use essa opção. Em vez disso, colete as informações conforme descrito em Como coletar informações de diagnóstico de uma VM, revise o arquivo no Cloud Storage e anexe-o ao caso.

Antes de anexar informações de diagnóstico a um caso de suporte, verifique se:

  • Sua organização tem um plano de atendimento ao cliente que permite criar casos de suporte técnico (Suporte Standard, Enhanced ou Premium).
  • Você tem o papel de Editor de suporte técnico (roles/cloudsupport.techSupportEditor). Se o caso pertencer a uma organização, você precisará do papel na organização.
  • A API Cloud Support está ativada no projeto.
  • O caso está aberto.

Para anexar informações de diagnóstico a um caso de suporte, faça o seguinte:

  1. Verifique se você instalou o componente de comandos Alfa:

    gcloud components install alpha

  2. Execute o comando gcloud alpha compute diagnose export-logs com a sinalização --support-case.

    gcloud alpha compute diagnose export-logs INSTANCE_NAME \
    --zone=ZONE \
    --support-case=CASE_NUMBER

    Substitua:

    • INSTANCE_NAME: o nome da instância de computação do Windows Server.
    • ZONE: a zona da instância.
    • CASE_NUMBER: o número de um caso de suporte aberto.

    O comando verifica se o caso existe e se é possível adicionar anexos a ele antes de começar a coleta. Em seguida, ele aguarda a instância terminar de coletar informações de diagnóstico, o que pode levar alguns minutos, e faz o upload do arquivo para o caso. O arquivo também permanece no bucket do Cloud Storage, assim como quando você omite a flag --support-case.

A seguir