Instalar e gerenciar o Agente de operações usando políticas do VM Extension Manager

É possível instalar e gerenciar o Agente de Operações em uma frota de VMs do Compute Engine em uma zona específica usando políticas do Gerenciador de extensões de VM. Por exemplo, é possível usar essas políticas para realizar tarefas como as seguintes:

  • Instalação em toda a frota: instale o agente de operações em todas as VMs em uma zona ou em um conjunto de subconjuntos de VMs identificados por rótulos em uma zona.

  • Controle de versão:

    • Mantenha o agente de operações atualizado com a versão mais recente.
    • Fixe a versão do agente de operações em um lançamento específico.

  • Gerenciamento de configuração: aplique uma configuração personalizada ao agente de operações em todas as VMs gerenciadas por uma política.

Com o VM Extension Manager, você cria políticas que declaram quais extensões quer instalar nas VMs. O agente de operações é uma das extensões disponíveis. As políticas do VM Extension Manager podem gerenciar o Agente de Operações versão 2.58.0 ou mais recente, quando o Agente de Operações tiver sido instalado usando o VM Extension Manager. Essas políticas não podem gerenciar versões do agente de operações anteriores à 2.58.0, instâncias do agente de operações instaladas por outros meios ou qualquer versão do agente do Monitoring ou do agente do Logging legados.

É possível criar e gerenciar políticas de extensão de VM usando o console Google Cloud ou a CLI gcloud do Google Cloud.

Antes de começar

Antes de começar a usar as políticas de extensão do VM Extension Manager, faça o seguinte:

Revisar os sistemas operacionais compatíveis

Antes de usar as políticas do VM Extension Manager para gerenciar o agente de operações, verifique se o sistema operacional de destino é compatível com o agente de operações e o VM Extension Manager.

O Gerenciador de extensões de VM é compatível com todos os sistemas operacionais compatíveis com o Agente de operações, exceto SUSE Linux Enterprise Server (SLES) e Ubuntu. Para mais informações sobre os sistemas operacionais compatíveis com o agente de operações, consulte Sistemas operacionais.

Se o sistema operacional for compatível com o Agente de operações e o VM Extension Manager, siga o restante deste documento.

Ative as APIs necessárias para usar o Agente de operações

Para usar o Agente de operações e gravar registros e métricas, ative a API Cloud Logging e Cloud Monitoring no seu projeto Google Cloud .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Conceder os papéis necessários para usar o agente de operações

Para receber as permissões necessárias para usar o agente de operações e gravar registros e métricas, peça ao administrador para conceder a você os seguintes papéis do IAM na sua conta de serviço:

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 mais informações sobre papéis e o Agente de operações, consulte Autorizar o Agente de operações.

Conceder os papéis necessários para usar o VM Extension Manager

Para ter as permissões necessárias para criar, visualizar, modificar e excluir políticas de extensão de VM, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para criar, visualizar, modificar e excluir políticas de extensão de VM. Para acessar as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As permissões a seguir são necessárias para criar, visualizar, modificar e excluir políticas de extensão de VM:

  • Para criar políticas de extensão: compute.vmExtensionPolicies.create
  • Para conferir as políticas de extensão: compute.vmExtensionPolicies.list
  • Para conferir detalhes de uma política de extensão: compute.vmExtensionPolicies.get
  • Para modificar as políticas de extensão: compute.vmExtensionPolicies.update
  • Para excluir políticas de extensão: compute.vmExtensionPolicies.delete

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Para mais informações sobre papéis e permissões do IAM no Compute Engine, consulte Papéis e permissões do Compute Engine.

Instalar a CLI do Google Cloud

É possível criar e gerenciar políticas de extensão de VM usando o console Google Cloud ou a CLI gcloud do Google Cloud. Para usar a gcloud, primeiro instale-a seguindo estas etapas:

  1. Instale a Google Cloud CLI, caso ainda não tenha feito isso.

    As políticas de extensão descritas neste documento usam o grupo de comandos beta.

  1. Se ainda não tiver feito isso, instale o componente beta da CLI gcloud executando o seguinte comando:

    gcloud components install beta

    Para verificar se você tem o componente beta instalado, execute o seguinte comando:

    gcloud components list

    Se você instalou o componente beta anteriormente, verifique se tem a versão mais recente:

    gcloud components update

Desinstalar todos os agentes de observabilidade

Antes de criar uma política do VM Extension Manager para gerenciar o agente de operações em uma VM, verifique se não há instâncias do agente de operações ou do agente legado do Monitoring e do Logging já na VM. A execução do agente de operações e dos agentes legados na mesma VM pode causar a ingestão de registros duplicados ou conflitos no processamento de métricas.

Se você usar uma política de extensão para instalar o agente de operações em uma VM em que outro agente de observabilidade já está instalado, a política vai instalar o agente, mas ele não será executado porque um conflito foi detectado.

A forma de remover os agentes depende de como eles foram instalados.

Instalar o agente de operações criando políticas de extensão de VM

Crie políticas de extensão de VM para instalar e gerenciar automaticamente o agente de operações em uma frota de máquinas virtuais (VMs) do Compute Engine. Ao definir uma política, você garante que extensões específicas, como o agente de operações, sejam instaladas e mantidas em todas as VMs que corresponderem aos critérios especificados, como rótulos de VM.

Conflitos e prioridades de políticas

O Gerenciador de extensões de VM associa uma prioridade a cada nova política. Números menores indicam prioridades mais altas. A prioridade padrão é 1.000. Uma VM pode ser coberta por várias políticas para uma extensão, como o agente de operações, mas apenas uma política para a extensão do agente de operações é efetiva na VM.

O VM Extension Manager usa prioridades para resolver conflitos entre políticas aplicadas a uma VM. Para mais informações sobre o processo de resolução, consulte Prioridade da política e resolução de conflitos.

Instalar a versão mais recente do agente de operações em todas as VMs de uma zona

Para criar uma política que instale a versão mais recente do agente de operações em todas as VMs de uma zona e atualize o agente quando uma nova versão for lançada, faça o seguinte:

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Clique em + Criar.
  3. No campo Nome, digite um nome para a política.
  4. Opcional: no campo Descrição, insira uma descrição para a política.
  5. No campo Prioridade, especifique um número de prioridade para resolver conflitos entre políticas. Números menores indicam maior prioridade. O valor padrão é 1000.

  6. Na lista Zona, selecione a zona em que você quer aplicar essa política.

  7. Na seção Gerenciar extensões, clique em Adicionar extensão e faça o seguinte:

    1. Na lista Extensão, selecione Google Cloud's Extension for Ops Agent.
    2. Deixe o campo Versão em branco.

  8. Clique em Criar.

gcloud

Use o seguinte comando gcloud beta compute zone-vm-extension-policies create para criar a política:

gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE \
  --extensions=ops-agent

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

O gcloud beta compute zone-vm-extension-policies create usa uma opção --version. Se você omitir a opção --version, a política vai instalar a versão mais recente e atualizar o agente de operações quando uma nova versão for lançada.

Fixar o agente de operações em uma versão específica em todas as VMs de uma zona

Para criar uma política que instale uma versão específica do agente de operações em todas as VMs em uma zona, faça o seguinte:

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Clique em + Criar.
  3. No campo Nome, digite um nome para a política.
  4. Opcional: no campo Descrição, insira uma descrição para a política.
  5. No campo Prioridade, especifique um número de prioridade para resolver conflitos entre políticas. Números menores indicam maior prioridade. O valor padrão é 1000.

  6. Na lista Zona, selecione a zona em que você quer aplicar essa política.

  7. Na seção Gerenciar extensões, clique em Adicionar extensão e faça o seguinte:

    1. Na lista Extensão, selecione Google Cloud's Extension for Ops Agent.
    2. Na lista Versão, selecione a versão a ser instalada. Use a versão 2.58.0 ou mais recente.

  8. Clique em Criar.

gcloud

Use o seguinte comando gcloud beta compute zone-vm-extension-policies create para criar a política:

gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE \
  --extensions=ops-agent
  --version=ops-agent=VERSION

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

  • VERSION: a versão do Agente de operações a ser instalada. Use a versão 2.58.0 ou mais recente.

    Se você omitir a opção --version, a política vai instalar a versão mais recente e atualizar o agente de operações quando uma nova versão for lançada, conforme mostrado no exemplo que instala a versão mais recente.

Para ver uma lista de versões do agente de operações, consulte a página de versões do agente de operações no GitHub.

Instalar o agente de operações em VMs em uma zona com um rótulo específico

Para criar uma política que instale a versão mais recente do agente de operações nas VMs em uma zona com um rótulo específico, faça o seguinte:

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Clique em + Criar.
  3. No campo Nome, digite um nome para a política.
  4. Opcional: no campo Descrição, insira uma descrição para a política.
  5. No campo Prioridade, especifique um número de prioridade para resolver conflitos entre políticas. Números menores indicam maior prioridade. O valor padrão é 1000.

  6. Na lista Zona, selecione a zona em que você quer aplicar essa política.

  7. Na seção Extensões, clique em Adicionar extensão e faça o seguinte:

    1. Na lista Extensão, selecione Google Cloud's Extension for Ops Agent.
    2. Deixe o campo Versão em branco.

  8. Na seção Instâncias de VM de destino, selecione as VMs para a política. Para selecionar VMs com rótulos específicos, clique em Adicionar rótulos e inclua o par de chave-valor.

  9. Clique em Criar.

gcloud

Use a opção --inclusion-labels no comando gcloud beta compute zone-vm-extension-policies create para especificar uma lista separada por vírgulas de pares de chave-valor:

gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE \
  --extensions=ops-agent
  --inclusion-labels=KEY1=VALUE1,KEY2=VALUE2

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

  • KEY1=VALUE1,KEY2=VALUE2: uma lista separada por vírgulas de pares de chave-valor que definem rótulos de inclusão para um seletor. As VMs precisam ter todos os rótulos especificados em um seletor (AND lógico) para serem incluídas. Se você especificar a opção --inclusion_labels várias vezes, a política vai segmentar as VMs que correspondem a todos os rótulos em qualquer um dos seletores (OR lógico). Se você omitir essa opção, a política vai segmentar todas as VMs na zona especificada.

Instalar o agente de operações com uma configuração personalizada em todas as VMs de uma zona

Para criar uma política que instale a versão mais recente do agente de operações em todas as VMs de uma zona e forneça uma configuração personalizada para o agente de operações, faça o seguinte:

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Clique em + Criar.
  3. No campo Nome, digite um nome para a política.
  4. Opcional: no campo Descrição, insira uma descrição para a política.
  5. No campo Prioridade, especifique um número de prioridade para resolver conflitos entre políticas. Números menores indicam maior prioridade. O valor padrão é 1000.

  6. Na lista Zona, selecione a zona em que você quer aplicar essa política.

  7. Na seção Extensões, clique em Adicionar extensão e faça o seguinte:

    1. Na lista Extensão, selecione Google Cloud's Extension for Ops Agent.
    2. Deixe o campo Versão em branco.
    3. No campo Conteúdo do arquivo de configuração, insira a string de configuração YAML do agente de operações.

  8. Clique em Criar.

gcloud

Use a opção --config-from-file no comando gcloud beta compute zone-vm-extension-policies create para especificar um arquivo de configuração:

gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE \
  --extensions=ops-agent
  --config-from-file=ops-agent="OPS_AGENT_CONFIG_PATH"

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

  • OPS_AGENT_CONFIG_PATH: o caminho para um arquivo que contém a string de configuração YAML do Agente de operações. Esse arquivo precisa estar no ambiente em que você executa o comando gcloud.

    O YAML de configuração do Agente de operações pode ser longo. Colocar a configuração em um arquivo e transmitir o arquivo para a CLI gcloud é muito menos propenso a erros do que tentar inserir YAML formatado corretamente na linha de comando. Mudar esse arquivo depois de criar a política não a atualiza. Para isso, use o comando gcloud beta compute zone-vm-extension-policies update.

Se você fornecer uma configuração personalizada para o agente de operações ao criar ou atualizar uma política de extensão, a política vai implantar o agente de operações com a configuração personalizada. Não é necessário reiniciar o agente manualmente.

A configuração é armazenada com a política de extensão. Portanto, não inclua dados sensíveis, como senhas, na configuração. Como a configuração é armazenada com a política de extensão, modificar o arquivo de configuração não muda a configuração do agente. É necessário atualizar a configuração armazenada com a política usando o comando gcloud beta compute zone-vm-extension-policies update.

Quando você fornece uma configuração personalizada para o agente de operações, o VM Extension Manager copia a configuração para o local usado pelo agente de operações para arquivos de configuração especificados pelo usuário na VM de destino:

  • Linux: /etc/google-cloud-ops-agent/config.yaml
  • Windows: C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml

Se houver um arquivo config.yaml na VM, a política de extensão o vai substituir.

Para informações gerais sobre como usar o consoleGoogle Cloud e a CLI gcloud para criar políticas de extensão de VM, consulte Instalar extensões de VM criando políticas de extensão .

Gerenciar o agente de operações atualizando as políticas de extensão de VM

Para mudar como uma política gerencia o agente de operações, atualize a política. Quando você atualiza uma política, o Gerenciador de extensões de VM implementa as mudanças em todas as VMs aplicáveis, geralmente em um minuto. Se você modificar os rótulos de inclusão, o Agente de operações poderá ser instalado em novas VMs ou desinstalado de VMs atuais, dependendo se as VMs corresponderem aos rótulos atualizados.

As seções a seguir mostram como gerenciar o Agente de operações para fazer o seguinte:

Atualizar a versão fixada do agente de operações em todas as VMs em uma zona

Para mudar a versão fixada do agente de operações em todas as VMs de uma zona, faça o seguinte:

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Selecione a política que você quer atualizar.
  3. Clique em Editar.
  4. Na seção Gerenciar extensões, faça o seguinte:
    1. Selecione Google Cloud's Extension for Ops Agent.
    2. Modifique o campo Versão. Use a versão 2.58.0 ou mais recente.
    3. Clique em Concluído.
  5. Clique em Salvar.

gcloud

Use o comando gcloud beta compute zone-vm-extension-policies update com a opção --version para modificar a versão fixada do agente.

Quando você atualiza uma política usando gcloud, a solicitação funciona como uma substituição completa. Os campos opcionais omitidos voltam aos valores padrão em vez de manter os valores atuais da política modificada.

Para mudar a versão do agente de operações instalada em todas as VMs de uma zona por uma política, use o seguinte comando:

gcloud beta compute zone-vm-extension-policies update POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE \
  --extensions=ops-agent
  --version=ops-agent=VERSION

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

  • VERSION: a versão do Agente de operações a ser instalada. Use a versão 2.58.0 ou mais recente. Para ver uma lista de versões, consulte a página de lançamentos do Agente de operações no GitHub.

    Se você omitir a opção --version, a política vai instalar a versão mais recente e atualizar o agente de operações quando uma nova versão for lançada, conforme mostrado no exemplo que instala a versão mais recente.

Modificar a configuração do agente de operações em todas as VMs de uma zona

Para modificar a configuração do Agente de operações em todas as VMs de uma zona, faça o seguinte:

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Selecione a política que você quer atualizar.
  3. Clique em Editar.
  4. Na seção Gerenciar extensões, faça o seguinte:
    1. Selecione Google Cloud's Extension for Ops Agent.
    2. Modifique o campo Conteúdo do arquivo de configuração.
    3. Clique em Concluído.
  5. Clique em Salvar.

gcloud

Use gcloud beta compute zone-vm-extension-policies update com a opção --config-from-file ou --config para especificar uma nova configuração.

Quando você atualiza uma política usando gcloud, a solicitação age como uma substituição completa. Os campos opcionais omitidos voltam aos valores padrão em vez de manter os valores atuais da política modificada.

Para mudar a configuração do agente de operações instalado em todas as VMs de uma zona por uma política, use o seguinte comando:

gcloud beta compute zone-vm-extension-policies update POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE \
  --extensions=ops-agent
  --config-from-file=ops-agent="OPS_AGENT_CONFIG_PATH"

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

  • OPS_AGENT_CONFIG_PATH: o caminho para um arquivo que contém a string de configuração YAML do Agente de operações. Esse arquivo precisa estar no ambiente em que você executa o comando gcloud.

    O YAML de configuração do agente de operações pode ser longo. Colocar a configuração em um arquivo e transmitir o arquivo para a CLI gcloud é muito menos propenso a erros do que tentar inserir YAML formatado corretamente na linha de comando.

Se você fornecer uma configuração personalizada para o agente de operações ao criar ou atualizar uma política de extensão, a política vai implantar o agente de operações com a configuração personalizada. Não é necessário reiniciar o agente manualmente.

A configuração é armazenada com a política de extensão. Portanto, não inclua dados sensíveis, como senhas, na configuração. Como a configuração é armazenada com a política de extensão, modificar o arquivo de configuração não muda a configuração do agente. É necessário atualizar a configuração armazenada com a política usando o comando gcloud beta compute zone-vm-extension-policies update.

Quando você fornece uma configuração personalizada para o agente de operações, o VM Extension Manager copia a configuração para o local usado pelo agente de operações para arquivos de configuração especificados pelo usuário na VM de destino:

  • Linux: /etc/google-cloud-ops-agent/config.yaml
  • Windows: C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml

Se houver um arquivo config.yaml na VM, a política de extensão o vai substituir.

Para informações gerais sobre como usar o consoleGoogle Cloud e a CLI gcloud para gerenciar políticas de extensão de VM, consulte Modificar extensões atualizando uma política de extensão de VM.

Desinstalar o agente de operações excluindo políticas de extensão de VM

Para desinstalar o agente de operações, exclua a política de extensão de VM que gerencia o agente. Se outra política ativa de menor prioridade se aplicar a uma VM e também gerenciar o agente de operações, ele vai permanecer instalado nessa VM com base na política de menor prioridade.

O Gerenciador de extensões de VM remove o Agente de operações de todas as VMs acessíveis em até um minuto após a exclusão da política. Se uma VM estiver inacessível, o VM Extension Manager vai pular a exclusão do agente. Se a VM ficar disponível novamente, o VM Extension Manager removerá o agente nesse momento.

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Selecione a política que você quer excluir.
  3. Clique em Excluir.
  4. Na caixa de diálogo de confirmação, clique em Excluir.

gcloud

Para excluir a política de extensão de VM que gerencia o agente de operações, use o comando gcloud beta compute zone-vm-extension-policies delete:

gcloud beta compute zone-vm-extension-policies delete POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

Recuperar informações sobre políticas de extensão de VM

É possível recuperar as seguintes informações sobre as políticas de extensão de VM atuais:

  • Uma lista de todas as políticas no seu projeto Google Cloud .
  • Informações de configuração sobre uma política específica.

Console

  1. No console do Google Cloud , acesse a página Políticas de extensão:

    Acessar as políticas de extensão

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

    Nesta página, listamos todas as políticas de extensão de VM no seu projeto.
  2. Para ver detalhes de uma política de extensão específica, clique no nome dela.

gcloud

Listar políticas de extensão de VM

Para listar informações sobre todas as políticas de extensão de VM em uma zona, use o gcloud beta compute zone-vm-extension-policies list:

gcloud beta compute zone-vm-extension-policies list \
  --project=PROJECT_ID \
  --zone=ZONE \
  --page-size=PAGE_SIZE_INTEGER

Substitua as seguintes variáveis no comando:

  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.
  • PAGE_SIZE_INTEGER: o número de políticas a serem listadas por página. Por exemplo, 2. Para mais informações sobre as opções de classificação e filtragem, consulte gcloud beta compute zone-vm-extension-policies list.

Descrever uma política de extensão de VM nomeada

Para recuperar a configuração de uma política nomeada em uma zona, use o gcloud beta compute zone-vm-extension-policies describe:

gcloud beta compute zone-vm-extension-policies describe POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE

Substitua as seguintes variáveis no comando:

  • POLICY_NAME: um nome para a política de extensão de VM.
  • PROJECT_ID: o identificador do projeto.
  • ZONE: a zona de destino, por exemplo, us-central1-f.

Para informações gerais sobre como usar o console doGoogle Cloud e a CLI gcloud para recuperar informações sobre políticas de extensão de VM, consulte Ver políticas de extensão.

Verificar a instalação do agente de operações

Esta seção explica como fazer o seguinte:

Verificar o status ou a versão de uma instalação do agente de operações

Para determinar o status ou a versão do Agente de operações, use uma das seguintes páginas do consoleGoogle Cloud :

Compute Engine

  1. No Google Cloud console, acesse a página Instâncias de VM:

    Acessar Instâncias de VM

    Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

  2. Selecione uma VM na lista.
  3. Clique na guia Observabilidade.

Cloud Monitoring

  1. No console do Google Cloud , acesse a página Instâncias de VM:

    Acessar Instâncias de VM

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Selecione a visualização Lista.

Quando o agente de operações é instalado na VM e coleta registros e métricas, o status do agente é marcado com uma marca de seleção verde ao lado do rótulo Agente de operações.

Para determinar a versão do agente instalado, passe o cursor sobre o rótulo Agente de operações no painel do Compute Engine ou do Monitoring.

Verificar se o agente de operações está coletando telemetria

Se o Agente de operações tiver sido instalado e estiver funcionando corretamente, ele enviará métricas para o Cloud Monitoring e registros para o Cloud Logging.

Reiniciar um Agente de operações instalado por uma política de extensão

Quando o Agente de operações é instalado e gerenciado pelo VM Extension Manager, ele não é gerenciado pelo serviço de gerenciamento de sistema do sistema operacional, ou seja, systemd no Linux ou o Gerenciador de serviços do Windows no Windows. Portanto, os comandos systemctl do Linux e *-Service do Windows não funcionam com um agente de operações instalado por uma política de extensão.

Para reiniciar um Agente de operações instalado por uma política de extensão, faça uma das seguintes opções:

  • Recrie a política.

    1. Exclua a política. A exclusão da política interrompe e desinstala o agente de operações.

    2. Crie uma nova política. A nova política instala e inicia o Agente de operações.

  • Use uma política temporária de maior prioridade. Se a política original afetar um grande número de VMs, mas você só quiser reiniciar o agente de operações em um pequeno número, adicione um rótulo a essas VMs e configure a nova política para filtrar com base no rótulo.

    Por exemplo, se uma política com prioridade 1000 não iniciar o agente de operações em uma VM, adicione um rótulo como status=failed à VM. Em seguida, crie uma política com uma prioridade maior, como 500. Por exemplo, um comando da Google Cloud CLI pode ser parecido com este:

    gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
  --project=PROJECT_ID \
  --zone=ZONE \
  --extensions=ops-agent
  --inclusion-labels=status=failed \
  --priority=500 \
  --config-from-file=ops-agent=/usr/ops-agent-config.yaml

    Substitua as seguintes variáveis no comando:

    • POLICY_NAME: um nome para a política de extensão de VM.
    • PROJECT_ID: o identificador do projeto.
    • ZONE: a zona de destino, por exemplo, us-central1-f.

    Depois que a nova política instalar o agente de operações, exclua a política e remova o rótulo das VMs. O agente de operações permanece instalado na VM porque a política original ainda está ativa.

Ativar o registro de depuração do agente convidado na VM

As políticas do VM Extension Manager usam o agente convidado do Compute Engine para gerenciar o Agente de operações como uma extensão de VM. Para informações sobre como ativar o registro de depuração do agente convidado, consulte Ver registros de depuração do agente convidado.

Resolver problemas com políticas de extensão

Nesta seção, você encontra informações sobre como solucionar problemas no uso de políticas de extensão para gerenciar o Agente de operações:

Para informações sobre como resolver problemas do Agente de operações, consulte Resolver problemas do Agente de operações.

Falha nos comandos gcloud beta compute zone-vm-extension-policies

Quando um comando gcloud beta compute zone-vm-extension-policies falha, a resposta inclui sugestões de solução de problemas. Corrija os erros nas flags ou nos argumentos de comando sugeridos pela mensagem de erro.

Se a saída do comando mencionar permissões insuficientes do IAM, consulte os papéis e permissões necessários descritos em Conceder os papéis necessários para usar o Gerenciador de extensões de VM.

A política de extensão é criada, mas o status do agente de operações é "não detectado"

Você criou uma política de extensão, mas o agente de operações mostra um status "não detectado" na VM.

O agente de operações pode aparecer como "não detectado" se ocorrer uma das seguintes situações:

  • A política de extensão não instala o Agente de operações.
  • Um Agente de operações instalado encontra uma condição de erro que impede a execução.

As seções a seguir descrevem como diagnosticar esses casos.

Verificar se o Agente de operações foi instalado pela política

As políticas do VM Extension Manager usam o agente convidado do Compute Engine para gerenciar o Agente de operações como uma extensão de VM.

Para determinar se o Agente de operações foi instalado pela política de extensão, use uma das seguintes opções para procurar entradas de registro do agente convidado:

Explorador de registros

  1. No console Google Cloud , acesse a página Análise de registros.

    Acessar a Análise de registros

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Digite a seguinte consulta e clique em Executar consulta:

    log_id("GCEGuestAgentManager")

Linux

Execute o comando a seguir na VM do Compute Engine:

journalctl -u google-guest-agent-manager

Windows

Execute o comando a seguir na VM do Compute Engine:

Get-Eventlog -Source google_guest_agent_manager -LogName Application

Se você encontrar registros que contenham uma string como Failed to install plugin "ops-agent-plugin" ... ou se a consulta não retornar nenhum registro, a política de extensão não instalou o agente de operações. Para as próximas etapas, consulte A política de extensão não instala o Agente de operações.

Se você encontrar registros com uma string como Successfully installed plugin "ops-agent_nnnnnnnn", a política de extensão instalou o Agente de operações com sucesso. Para as próximas etapas, consulte O Agente de operações instalado não é detectado.

A política de extensão não instala o Agente de operações

Uma política de extensão pode ser ineficaz se uma das seguintes condições for verdadeira:

  • O agente convidado não está instalado na VM. Para diagnosticar e corrigir essa condição, faça o seguinte:

    1. Verifique se a VM está usando um dos sistemas operacionais compatíveis com o ambiente convidado do Compute Engine.

    2. Confira os pacotes instalados na VM para verificar se google-guest-agent está incluído.

    3. Se o google-guest-agent não estiver instalado, instale o agente convidado.

  • O agente convidado está instalado, mas desatualizado. Para diagnosticar e corrigir essa condição, faça o seguinte:

    1. Valide o ambiente de convidado para determinar a versão do pacote google-guest-agent. O VM Extension Manager exige a versão 20241209.01 ou mais recente.

    2. Se a versão do google-guest-agent for mais antiga que 20241209.01, atualize o ambiente convidado.

  • O sistema operacional da VM não é compatível com o VM Extension Manager. Para mais informações, consulte Analisar sistemas operacionais compatíveis.

O Agente de operações instalado tem o status "não detectado"

O Agente de operações pode ter o status "não detectado" se uma das seguintes condições for verdadeira:

Verificar se a configuração do Agente de operações é válida

Você forneceu uma configuração personalizada ao agente de operações criando ou atualizando uma política de extensão, mas o status do agente é "não detectado". O problema pode ser um erro na sua configuração personalizada. Use os registros de depuração do agente convidado para procurar erros de configuração.

Ativar a geração de registros de depuração do agente convidado

Para saber como ativar o registro de depuração do agente convidado, consulte Ver registros de depuração do agente convidado.

Analisar registros de depuração

Explorador de registros

  1. No console Google Cloud , acesse a página Análise de registros.

    Acessar a Análise de registros

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Digite a seguinte consulta e clique em Executar consulta:

    severity>=DEBUG log_id("GCEGuestAgentManager") "The agent config file is not valid"

Linux

Execute o comando a seguir na VM do Compute Engine Linux:

journalctl -u google-guest-agent-manager | grep "The agent config file is not valid"

Windows

Execute o comando a seguir na VM do Compute Engine do Windows:

Get-Eventlog -Source google_guest_agent_manager -LogName Application | Where-Object {$_.Message -like "*The agent config file is not valid*"}

Se você encontrar registros que contenham a string The agent config file is not valid, a configuração personalizada do Agente de operações fornecida ao criar ou atualizar a política de extensão será inválida.

Para corrigir esse problema, faça o seguinte:

  • Corrija a configuração consultando Configurar o agente de operações. Para informações sobre a estrutura de um arquivo de configuração do agente de operações.

  • Atualize a política de extensão com a configuração corrigida.

Os comandos Linux systemctl status e Windows Get-Service não funcionam com o agente de operações

Você executa um comando como sudo systemctl status google-cloud-ops-agent"*", mas ele não retorna nenhuma informação.

Quando o Agente de operações é instalado e gerenciado pelo VM Extension Manager, ele não é gerenciado pelo serviço de gerenciamento de sistema do sistema operacional, ou seja, systemd no Linux ou o Gerenciador de serviços do Windows no Windows.

Para encontrar as informações de status de um agente de operações gerenciado pelo VM Extension Manager, consulte o seguinte:

Os comandos Linux systemctl restart e Windows Restart-Service não funcionam com o agente de operações

Você executa um comando como sudo systemctl restart google-cloud-ops-agent, mas o Agente de operações não é reiniciado.

Quando o Agente de operações é instalado e gerenciado pelo VM Extension Manager, ele não é gerenciado pelo serviço de gerenciamento de sistema do sistema operacional, ou seja, systemd no Linux ou o Gerenciador de serviços do Windows no Windows. Portanto, não é possível parar ou iniciar o Agente de operações manualmente, e comandos como os seguintes não funcionam com ele:

  • Linux: sudo systemctl [stop|start|restart]
  • Windows: Stop-Service, Start-Service, Restart-Service

Para interromper ou reiniciar um agente de operações gerenciado pelo Gerenciador de extensões de VM, desinstale o agente excluindo a política de extensão. Para mais informações sobre como interromper ou reiniciar o agente de operações, consulte Reiniciar um agente de operações instalado por uma política de extensão.

Outras informações sobre solução de problemas

Para mais informações sobre como resolver problemas na criação e no uso de políticas do VM Extension Manager, consulte Resolver problemas de extensões de VM.

Para mais informações sobre como resolver problemas do agente de operações, consulte Resolver problemas do agente de operações.

Cota

Para informações sobre o número de políticas de extensão que podem ser criadas em um projeto Google Cloud , consulte Quota.

Preços

Para informações sobre os custos associados ao uso do VM Extension Manager, consulte Preços.

Se você instalar o Agente de operações, poderá receber cobranças pelas métricas, pelos registros ou pelos traces que ele enviar ao seu projeto Google Cloud . Para informações sobre preços, consulte Preços do Google Cloud Observability.

A seguir