Instalar o agente do Cloud Logging em VMs individuais

O agente Logging transmite registos das suas instâncias de VM e de pacotes de software de terceiros selecionados para o Cloud Logging. É uma prática recomendada executar o agente de registo em todas as instâncias da VM.

As imagens de VM para o Compute Engine e o Amazon Elastic Compute Cloud (EC2) não incluem o agente de registo, pelo que tem de concluir estes passos para o instalar nessas instâncias. O agente é executado no Linux e no Windows.

Se as suas VMs estiverem a ser executadas no Google Kubernetes Engine ou no App Engine, o agente já está incluído na imagem da VM, pelo que pode ignorar esta página.

Antes de começar

Para instalar o agente, certifique-se de que tem o seguinte:

  • Uma instância de VM suportada num Google Cloud projeto ou numa conta dos Amazon Web Services (AWS).

    • Quando instalar o agente Logging, é necessário um mínimo de 250 MiB de memória, mas recomenda-se 1 GiB.

    Certifique-se também de que a VM está a executar um sistema operativo compatível.

  • Credenciais na instância de VM que autorizam a comunicação com o Cloud Logging ou o Cloud Monitoring. As instâncias de VM do Compute Engine têm geralmente as credenciais corretas por predefinição. Se algum dos seguintes cenários se aplicar a si, é possível que não tenha as credenciais adequadas e tem de concluir os procedimentos de autorização do agente de registo:

    • Se estiver a executar instâncias de VMs do AWS EC2, tem de instalar credenciais de autorização nas VMs antes de instalar o agente.

    • Executar instâncias do Compute Engine muito antigas ou instâncias do Compute Engine criadas sem as credenciais predefinidas.

    Para verificar se tem as credenciais adequadas, execute os procedimentos de validação das credenciais do Compute Engine.

  • Para informações sobre preços, aceda aos preços do Google Cloud Observability.

  • Se estiver a usar VMs que não têm acesso a repositórios de pacotes remotos, consulte a secção VMs sem acesso a pacotes remotos para mais informações.

Instale o agente a partir da linha de comandos

Para instalar o agente através da linha de comandos, siga as instruções abaixo.

Instale a versão mais recente do agente

Para instalar a versão mais recente do agente, conclua os passos seguintes.

Linux

  1. Abra uma ligação de terminal à sua instância de VM através de SSH ou de uma ferramenta semelhante e certifique-se de que tem acesso sudo.

  2. Altere para um diretório ao qual tenha acesso de escrita, por exemplo, o seu diretório inicial.

  3. Transfira e execute o script de instalação do agente através dos seguintes comandos:

    curl -sSO https://dl.google.com/cloudagents/add-logging-agent-repo.sh
    sudo bash add-logging-agent-repo.sh --also-install
    

    Após a instalação, o agente é iniciado automaticamente.

Windows

  1. Estabeleça ligação à sua instância através do RDP ou de uma ferramenta semelhante e inicie sessão no Windows.

  2. Abra um terminal do PowerShell com privilégios de administrador clicando com o botão direito do rato no ícone do PowerShell e selecionando Executar como administrador.

  3. Execute os seguintes comandos do PowerShell:

    (New-Object Net.WebClient).DownloadFile("https://dl.google.com/cloudagents/windows/StackdriverLogging-v1-22.exe", "${env:UserProfile}\StackdriverLogging-v1-22.exe")
    & "${env:UserProfile}\StackdriverLogging-v1-22.exe"
    

Instalar uma versão específica do agente

Para instalar uma versão específica do agente, conclua os passos seguintes.

Linux

  1. Abra uma ligação de terminal à sua instância de VM através de SSH ou de uma ferramenta semelhante e certifique-se de que tem acesso sudo.

  2. Altere para um diretório ao qual tenha acesso de escrita, por exemplo, o seu diretório inicial.

  3. Transfira o script de instalação do agente:

    curl -sSO https://dl.google.com/cloudagents/add-logging-agent-repo.sh
    

    Quando executa o script add-logging-agent-repo.sh, também pode definir as seguintes flags:

    • --verbose: ativa o registo verboso durante a execução do script.
    • --also-install: instala o agente depois de adicionar o repositório do pacote do agente.
    • --version: define a versão do agente para o script a instalar. Para ver informações sobre a versão, consulte o artigo Liste todas as versões do agente.
    • --uninstall: desinstala o agente.
    • --remove-repo: remove o repositório de pacotes do agente correspondente após a instalação ou a desinstalação do agente.
    • --dry-run: aciona apenas um teste de execução do script e imprime os comandos que deve executar.

    Consulte os comentários do script para ver mais informações e exemplos de utilização.

  4. Adicione o repositório de pacotes do agente e instale o agente:

    1. Para ver uma lista das versões do agente disponíveis, consulte o artigo Liste todas as versões do agente.

    2. Para ambientes de produção, recomendamos que fixe uma versão principal para evitar a instalação de versões principais que possam incluir alterações retroincompatíveis. Para fixar uma versão principal, execute:

      sudo bash add-logging-agent-repo.sh --also-install \
        --version=MAJOR_VERSION.*.*
      

      Por exemplo, para fixar à versão 1.x.x do agente, execute:

      sudo bash add-logging-agent-repo.sh --also-install \
        --version=1.*.*
      
    3. Para instalar uma versão específica do agente, execute:

      sudo bash add-logging-agent-repo.sh --also-install \
        --version=MAJOR_VERSION.MINOR_VERSION.PATCH_VERSION
      
  5. Reinicie o serviço do agente

    É necessário reiniciar para que as configurações instaladas pelos pacotes gerais acima entrem em vigor.

    sudo service google-fluentd restart
    

Pode eliminar o script de instalação depois de ser executado com êxito.

  • Para verificar se o agente está a funcionar conforme esperado, execute:

    sudo service google-fluentd status
    

    O estado do agente deve ser OK.

  • Também pode examinar os registos e garantir que não existem erros:

    tail /var/log/google-fluentd/google-fluentd.log
    

Se tiver problemas com a instalação, consulte a página de Resolução de problemas.

Windows

  1. Estabeleça ligação à sua instância através do RDP ou de uma ferramenta semelhante e inicie sessão no Windows.

  2. Abra um terminal do PowerShell com privilégios de administrador clicando com o botão direito do rato no ícone do PowerShell e selecionando Executar como administrador.

    1. Execute os seguintes comandos do PowerShell:

      (New-Object Net.WebClient).DownloadFile("https://dl.google.com/cloudagents/windows/StackdriverLogging-v1-22.exe", "${env:UserProfile}\StackdriverLogging-v1-22.exe")
      & "${env:UserProfile}\StackdriverLogging-v1-22.exe"
      

    Em alternativa, pode aceder ao seguinte URL para transferir e executar o instalador do agente:

    https://dl.google.com/cloudagents/windows/StackdriverLogging-v1-22.exe

    Para instalar o agente de forma silenciosa, anexe a opção /S à invocação do instalador:

    & "${env:UserProfile}\StackdriverLogging-v1-22.exe" /S
    

    No modo "silencioso", use a opção /D para especificar o diretório de instalação, por exemplo:

    & "${env:UserProfile}\StackdriverLogging-v1-22.exe" /S /D="C:\Stackdriver\Google Cloud Observability\"
    

    Pode eliminar o instalador quando a instalação for concluída com êxito.

    Se tiver problemas com a instalação, consulte a página de Resolução de problemas.

Ver informações do agente através da Google Cloud consola

Pode encontrar informações de estado sobre o agente no painel de controlo das instâncias de VM do Monitoring pré-configuradas. Para aceder a este painel de controlo, faça o seguinte:

Na Google Cloud consola, aceda à página Painel de controlo de instâncias de VM:

Aceda ao painel de controlo de instâncias de VM

Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

A vista Lista no separador Inventário do painel de controlo lista todas as VMs e inclui uma coluna de estado para o seu agente, conforme mostrado na captura de ecrã seguinte:

O painel de controlo de instâncias de VM no Monitoring mostra o estado
dos
agentes.

A coluna Agente comunica os seguintes valores:

  • Não detetado: não tem um agente instalado ou não está em execução. Se não tiver a certeza de que instalou um agente, pode consultar a versão instalada. Se tiver instalado o agente, pode reiniciá-lo.

  • Ops Agent: está a executar o Ops Agent. Se não vir uma marca de verificação verde junto à entrada, significa que existe uma atualização do agente disponível com base no sistema operativo detetado da sua VM.

    Quando passa o cursor do rato sobre o indicador do agente de operações na tabela, são apresentadas informações sobre a versão do agente de operações. Se estiver a executar uma versão mais antiga, também vê uma recomendação para atualizar o agente.

  • Pendente: o Ops Agent está a ser instalado ou atualizado.

  • Falha na instalação do agente: falha na instalação do agente de operações.

  • Não está a recolher telemetria: a instalação do agente Ops foi bem-sucedida, mas o agente ainda não está a enviar telemetria.

  • Agente antigo: está a executar a monitorização antiga ou o agente de registo. Consulte o artigo Migrar dos agentes antigos para o agente de operações para obter informações sobre a transição para o agente de operações.

  • Não aplicável: esta VM não é uma plataforma suportada para executar o agente.

  • VM parada: a VM não está em execução, pelo que o estado do agente é desconhecido.

Pode instalar o agente de operações fazendo o seguinte:

  • Selecione as instâncias de VM nas quais quer instalar agentes.
  • Clique na opção Instalar/atualizar agente de operações na tabela Instâncias.

Também pode instalar ou atualizar o agente de operações a partir da página Detalhes da VM para uma VM específica.

Sempre que possível, o agente é instalado através de uma política do SO do agente de operações. Para mais informações, consulte o artigo Faça a gestão das VMs abrangidas pela política do SO do agente de operações. As políticas do SO do agente de operações não são suportadas em todas as versões de todos os sistemas operativos. Neste caso, se clicar em Instalar/atualizar o agente de operações, são apresentados uma série de comandos para executar no Cloud Shell.

Por predefinição, o agente de operações recolhe métricas e registos. Pode alterar este comportamento predefinido configurando o agente Ops.

Tarefas opcionais

Esta secção descreve como realizar tarefas de manutenção comuns.

Ative o registo estruturado

Quando executa o script de instalação numa VM Linux, o script instala por predefinição o pacote google-fluentd-catch-all quando a flag --also-install está presente. Para mudar para o registo estruturado, conclua os seguintes passos.

  1. Faça uma cópia de segurança de todas as alterações locais a /etc/google-fluentd/config.d/.

  2. Execute um dos seguintes comandos, consoante a sua distribuição Linux:

    • YUM:

      sudo yum remove -y google-fluentd-catch-all-config
      sudo yum install -y google-fluentd-catch-all-config-structured
      sudo service google-fluentd restart
      
    • APT:

      sudo apt-get remove -y google-fluentd-catch-all-config
      sudo apt-get install -y google-fluentd-catch-all-config-structured
      sudo service google-fluentd restart
      

Para obter informações sobre o registo estruturado, consulte o guia de registo estruturado.

Configurar o agente de registos

O agente é pré-configurado para monitorizar determinadas localizações de registo conhecidas. No Linux, essas localizações são descritas no pacote google-fluentd-catch-all-config, que é automaticamente extraído pelo script de instalação. No Windows, o agente monitoriza o registo de eventos do Windows por predefinição.

Para ajustar a configuração do agente, consulte o artigo Configure o agente de registo.

Configure um proxy HTTP

Se usar um proxy HTTP para encaminhar pedidos para as APIs Logging e Monitoring, faça o seguinte:

Linux

  1. Edite o seguinte ficheiro de configuração (crie o ficheiro se ainda não existir):

     /etc/default/google-fluentd
    
  2. Adicione o seguinte ao ficheiro:

     export http_proxy="http://proxy-ip:proxy-port"
     export https_proxy="http://proxy-ip:proxy-port"
     export no_proxy=169.254.169.254  # Skip proxy for the local Metadata Server.
    
  3. Reinicie o agente executando o seguinte comando na sua instância de VM:

     sudo service google-fluentd restart
    

Windows

  1. Se usar um proxy HTTP, execute o seguinte comando a partir de uma linha de comandos de administrador. Isto define as variáveis de ambiente http_proxy e https_proxy para que o agente possa enviar dados através de HTTPS de saída:

    setx http_proxy http://proxy-ip:proxy-port /m
    setx https_proxy http://proxy-ip:proxy-port /m
    setx no_proxy 169.254.169.254 /m
    

Determine a versão do agente

Para determinar a versão do agente Logging no seu sistema, execute os seguintes comandos na sua instância de VM:

AMAZON LINUX AMI / CENTOS / RHEL

Execute o seguinte comando no Amazon Linux, Red Hat ou CentOS Linux:

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' google-fluentd google-fluentd-catch-all-config google-fluentd-catch-all-config-structured

DEBIAN / UBUNTU

Execute o seguinte comando no Debian ou Ubuntu:

dpkg-query --show --showformat '${Package} ${Version} ${Architecture} ${Status}\n' google-fluentd google-fluentd-catch-all-config google-fluentd-catch-all-config-structured

SLES / SUSE

Execute o seguinte comando no SUSE:

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' google-fluentd google-fluentd-catch-all-config google-fluentd-catch-all-config-structured

WINDOWS

  1. Estabeleça ligação à sua instância através do RDP ou de uma ferramenta semelhante e inicie sessão no Windows.

  2. Abra um terminal do PowerShell com privilégios de administrador clicando com o botão direito do rato no ícone do PowerShell e selecionando Executar como administrador.

  3. Execute o seguinte comando do PowerShell:

     reg query HKLM\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\GoogleStackdriverLoggingAgent\ /v Version
    

Reinicie o agente

Tem de reiniciar o agente de registo para aplicar as alterações nos ficheiros de configuração. Para reiniciar o agente, siga as instruções abaixo.

LINUX

Execute o seguinte comando na sua instância:


     sudo service google-fluentd restart

Depois de reiniciar o agente Logging, é recomendável enviar uma mensagem de teste.

Windows

  1. Estabeleça ligação à sua instância através do RDP ou de uma ferramenta semelhante e inicie sessão no Windows.

  2. Abra um terminal do PowerShell com privilégios de administrador clicando com o botão direito do rato no ícone do PowerShell e selecionando Executar como administrador.

  3. Execute o seguinte comando do PowerShell:

Restart-Service -Name StackdriverLogging

Atualize o agente

Para atualizar o agente Logging para a versão mais recente, siga as instruções abaixo:

Linux

Para atualizar o agente para a versão mais recente, execute o seguinte comando:

sudo bash add-logging-agent-repo.sh --also-install

Para atualizar o agente para a versão de lançamento mais recente de uma versão principal específica, execute o seguinte comando:

sudo bash add-logging-agent-repo.sh --also-install \
  --version=MAJOR_VERSION.*.*

Windows

Para atualizar para a versão mais recente do agente, instale o agente mais recente, conforme descrito em Instalar no Windows nesta página. O instalador pede-lhe para desinstalar a versão anterior do agente.

Apresentar todas as versões do agente

Para apresentar uma lista das versões disponíveis do agente, execute o seguinte comando:

AMAZON LINUX AMI / CENTOS / RHEL

Indique as versões disponíveis do agente:

sudo yum list --showduplicates google-fluentd

DEBIAN / UBUNTU

Indique as versões disponíveis do agente:

sudo apt-cache madison google-fluentd

SLES / SUSE

Indique as versões disponíveis do agente:

sudo zypper search -s google-fluentd

WINDOWS

A instalação de versões anteriores do agente no Windows não é suportada.

Desinstale o agente

Para remover o agente de registo e os respetivos ficheiros de configuração, siga as instruções abaixo.

Depois de desinstalar o agente, a Google Cloud consola pode demorar até uma hora a comunicar esta alteração.

Linux

Execute o seguinte comando:

sudo bash add-logging-agent-repo.sh --uninstall

Opcionalmente, para remover o repositório, além de desinstalar o agente, acrescente --remove-repo ao comando anterior.

Windows

No Painel de controlo do Windows, escolha Desinstalar um programa. Deverá ver o agente de registo na lista de programas que pode desinstalar. Também pode executar uninstall.exe a partir do diretório onde instalou o agente de registo.

VMs sem acesso a pacotes remotos

A instalação do agente Logging requer acesso a repositórios de pacotes remotos, tanto para o pacote do agente como (no Linux) para as respetivas dependências.

Se estiver a usar o VPC-SC ou uma rede privada, a configuração de rede também pode afetar a sua capacidade de instalar dependências de agentes de repositórios a montante. Os pacotes de agentes estão acessíveis através do acesso privado da Google. Isto pode ser configurado seguindo as instruções em Ative o acesso privado à Google.

Se a política de segurança do anfitrião da VM negar o acesso a repositórios de pacotes remotos, recomendamos que crie uma imagem de VM personalizada com o agente pré-instalado e desative a gestão de pacotes nessa imagem.

O que se segue?