Como usar o Cloud Logging com o Container-Optimized OS

O Container-Optimized OS inclui um agente de registro que exporta alguns registros de sistema e de contêiner para o Cloud Logging. Até Container-Optimized OS 101, imagens do Container-Optimized OS baseadas em x86 usadas um agente do Logging conteinerizado com base no README. Container-Optimized OS 105 começou a lançar uma implementação alternativa de agente de geração de registros, o Fluent-bit. A partir do Container-Optimized OS 109, o agente de registro fluent-bit é o padrão. O agente do Logging legado, fluentd, vai ser removido em Container-Optimized OS 113.

Todas as versões das imagens do Container-Optimized OS baseadas em Arm enviam o agente de registro fluent-bit.

Ativar o agente do Logging

O agente do Logging está desativado por padrão. É possível ativar esse recurso ao criar uma nova instância ou atualizar uma instância existente.

Requisitos de acesso

O Cloud Logging fornece o IAM funções que você pode usar para conceder o acesso apropriado. Para conferir seus registros em um projeto, é necessário ter a função roles/logging.viewer e os aplicativos precisam ter permissão para gravar registros. Você pode conceder essa permissão atribuindo o papel do IAM roles/logging.logWriter à conta de serviço de uma para o aplicativo.

Para mais informações sobre permissões e papéis, consulte Papéis predefinidos.

Criar uma instância com um agente de registro ativado

Console

executar uma instância do Compute Engine no Container-Optimized OS com a geração de registros fluent-bit; ativado, faça o seguinte:

  1. Abra a página de criação de instâncias do Compute Engine no console do Google Cloud.

    Crie uma nova instância do Compute Engine

  2. Especifique um Nome para sua instância.

  3. Na seção Disco de inicialização, selecione uma imagem do Container-Optimized OS.

  4. Clique em Gerenciamento, segurança, discos, rede, locatário único para expandir outras opções.

  5. Na guia Gerenciamento, role até a seção Metadados. Adicione uma nova entrada de metadados, com Chave como google-logging-enabled e Valor como true.

  6. Se quiser, especifique qualquer outra opção para seu caso de uso. Consulte Como criar e configurar instâncias para mais detalhes.

  7. Clique em Criar para criar e inicializar a instância.

gcloud

Para executar uma instância do Compute Engine no Container-Optimized OS com a geração de registros agente ativado, use o comando gcloud compute instances create e inclua google-logging-enabled=true nos metadados. Exemplo:

gcloud compute instances create instance-name \
    --image image-name \
    --image-project cos-cloud \
    --zone compute-zone \
    --metadata google-logging-enabled=true

Substitua:

  • instance-name: o nome da instância de VM.
  • image-name: o nome da imagem do Container-Optimized OS para a instância. Por exemplo, --image=cos-113-18244-85-29.
  • compute-zone: a zona de computação da instância.

Para mais informações sobre o comando gcloud, consulte a documentação de referência de gcloud compute instances create. Para mais detalhes sobre como criar instâncias do Container-Optimized OS, consulte Como criar e configurar instâncias.

Como selecionar o agente do Logging

As imagens 105 e 109 do Container-Optimized OS com base em x86 enviam duas implementações do agente de geração de registros: virtualenv (legado) e fluent-bit. O Container-Optimized OS 105 usa o fluentd por padrão, e o Container-Optimized OS 109 usa o fluent-bit por padrão. Você pode usar o google-logging-use-fluentbit entrada de metadados para alterar o comportamento padrão.

Para usar o agente de geração de registros fluent-bit no Container-Optimized OS 105 definido Valor de google-logging-use-fluentbit para true.

Para usar o agente de geração de registros fluentd no Container-Optimized OS 109 definido Valor de google-logging-use-fluentbit para false.

Ativar o agente do Logging nos metadados do projeto

A partir do marco 97, a geração de registros pode ser ativada nos metadados do projeto:

  gcloud compute project-info add-metadata \
    --metadata google-logging-enabled=true

Registros de acesso

Console

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

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

  2. Clique no nome da instância do Container-Optimized OS da qual você quer acessar os registros.

  3. Na seção Registros, clique em Cloud Logging.

  4. Isso abre o Explorador de registros da instância especificada. Para mais informações, consulte Como usar o Explorador de registros.

gcloud

Para acessar os registros, use o comando gcloud logging read. Exemplo:

gcloud logging read \
"resource.type=gce_instance AND resource.labels.instance_id=instance-id" \
    --limit 10 \
    --format json \
    --freshness 30d

Substitua:

  • instance-id: o ID da instância da VM.

Esse comando tenta ler registros da instância de VM com instance-id, limitando a 10 registros, no formato JSON, dos últimos 30 dias.

Para mais informações sobre o comando gcloud, consulte a documentação de referência de gcloud logging read.

Como funciona?

O agente do Logging é configurado por padrão para enviar registros de um sistema específico serviços críticos e contêineres de aplicativos do usuário para o Cloud Logging back-end. Por exemplo, registros de contêineres do Docker, serviços systemd selecionados, registros de auditoria, erros de registro de diário etc. Consulte a fonte de configuração específica do Container-Optimized OS (imagens x86 e imagens Arm) para ver a configuração completa de geração de registros padrão.

Para imagens x86 do Container-Optimized OS 105 e anteriores, o agente de registro é o agente de registro legado contêinerizado da Observability do Google Cloud. O comando do Docker que inicia o agente do Logging é definido no Container-Optimized OS fonte do serviço systemd stackdriver-logging. A versão do agente contêinerizado em execução é definida no diretório de origem app-admin/stackdriver do Container-Optimized OS.

Para imagens Arm de todas as versões e imagens x86 para o Container-Optimized OS 109 e versões mais recentes, o agente de registro é um pacote integrado do SO chamado fluent-bit. O agente é integrado ao SO e atualizado com as imagens do SO.

Limitações conhecidas

Compatibilidade com o driver gcplogs

A partir do março 89, se o agente do Logging incluído no Container-Optimized OS estiver ativado e o driver de geração de registros do gcplogs no Docker estiver ativado para um ou mais contêineres, os registros de aviso excessivos podem ser emitidos pelo agente do Logging incluído. Isso pode criar ruídos de registro e/ou aumentar as cobranças relacionadas ao Cloud Logging.

Uma solução alternativa é não usar gcplogs como um driver de geração de registros do Docker e, em vez disso, usar o driver padrão, conforme configurado pelo Container-Optimized OS. O agente do Logging incluído no Container-Optimized OS exportará os registros de contêiner para o Cloud Logging. Portanto, não é necessário usar as duas soluções simultaneamente.

Compatibilidade da configuração do agente do Logging

O agente de geração de registros é um contêiner baseado em FedRAMP em x86 Imagens do Container-Optimized OS e um binário fluent-bit baseado em ARM Imagens do Container-Optimized OS. As configurações dos dois agentes não são compatíveis. Isso não será um problema se você confiar apenas na geração de registros padrão integrada nas imagens do SO. No entanto, se você tiver uma configuração de registro personalizada, poderá ocorrer uma falha ao migrar cargas de trabalho para imagens baseadas em uma arquitetura diferente ou para uma versão mais recente do Container-Optimized OS.

Referências

  • Agente do Logging legado do Google Cloud Observability documentação. O agente de geração de registros contêinerizado incluído no Container-Optimized OS é um subconjunto do agente de geração de registros legada. Portanto, esta documentação pode fornecer contexto sobre o agente de maneira mais geral, fora do escopo do Container-Optimized OS.
  • Documentação do Google Cloud Observability. Página inicial da documentação do Google Cloud Observability. Pode ser útil para o contexto.