Usa Cloud Logging con Container-Optimized OS

Container-Optimized OS incluye un agente de registro que exporta algunos registros del sistema y del contenedor a Cloud Logging. Hasta la versión 101 de Container-Optimized OS, las imágenes de Container-Optimized OS basadas en x86 usaban un agente de registro en contenedor basado en fluentd. Container-Optimized OS 105 comenzó a enviar una implementación alternativa de agente de registro, fluent-bit. A partir de Container-Optimized OS 109, el agente de registro Fluent-bit es el predeterminado. El agente de registro heredado, fluentd, se quitará en el SO optimizado para contenedores 113.

Todas las versiones de las imágenes de Container-Optimized OS basadas en Arm incluyen el agente de registro Fluent-bit.

Nota: El registro está disponible automáticamente cuando eliges Container-Optimized OS como la imagen de nodo para ejecutar los clústeres de Google Kubernetes Engine. Estas instrucciones son para aquellas situaciones en las que utilizas Container-Optimized OS fuera de GKE, como en Compute Engine.

Habilita el agente de registro

El agente de registro está inhabilitado de forma predeterminada. Puedes habilitar esta función cuando creas una instancia nueva o actualizas una existente.

Requisitos de acceso

Cloud Logging proporciona roles de IAM que puedes usar para otorgar el acceso adecuado. Para ver tus registros en un proyecto, debes tener el rol roles/logging.viewer y las aplicaciones deben tener permiso para escribir registros. Para otorgar este permiso, asigna el rol de IAM roles/logging.logWriter a la cuenta de servicio de una aplicación.

Para obtener más información sobre los permisos y roles, consulta Roles predefinidos.

Crea una instancia con un agente de registro habilitado

Console

Para ejecutar una instancia de Compute Engine en Container-Optimized OS con el agente de registro fluent-bit habilitado, sigue estos pasos:

1. Abre la página de creación de instancias de Compute Engine en la consola de Google Cloud.

   Crea una instancia nueva de Compute Engine

2. Especifica un nombre para tu instancia.

3. En la sección Disco de arranque, selecciona una imagen de Container-Optimized OS

4. Haz clic en Administración, seguridad, discos, redes, usuario único para expandir las opciones adicionales.

5. En la pestaña Administración, desplázate hasta la sección Metadatos. Agrega una entrada de metadatos nueva, con Clave como google-logging-enabled y Valor como true.

6. De manera opcional, especifica cualquier otra opción para tu caso de uso. Consulta Cómo crear y configurar instancias para obtener más detalles.

7. Haz clic en Crear para crear y, además, iniciar la instancia.

gcloud

Para ejecutar una instancia de Compute Engine en Container-Optimized OS con el agente de registro habilitado, usa el comando gcloud compute instances create y, además, incluye google-logging-enabled=true en los metadatos. Por ejemplo:

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

Reemplaza lo siguiente:

• instance-name por el nombre de tu instancia de VM.
• image-name: El nombre de la imagen de Container-Optimized OS para la instancia. Por ejemplo, --image=cos-113-18244-85-29
• compute-zone por la zona de procesamiento de tu instancia.

Para obtener más información sobre el comando gcloud, consulta la documentación de referencia de gcloud compute instances create. Para obtener más detalles sobre cómo crear instancias de Container-Optimized OS, consulta Cómo crear y configurar instancias.

Selecciona el agente de registro

Las imágenes de Container-Optimized OS 105 y 109 basadas en x86 incluyen dos implementaciones del agente de registro: fluentd (heredado) y fluent-bit. Container-Optimized OS 105 usa fluentd de forma predeterminada, y Container-Optimized OS 109 usa fluent-bit de forma predeterminada. Puedes usar la entrada de metadatos google-logging-use-fluentbit para cambiar el comportamiento predeterminado.

Para usar el agente de registro de Fluent-bit en Container-Optimized OS 105, establece el valor de google-logging-use-fluentbit en true.

Para usar el agente de registro de fluentd en Container-Optimized OS 109, establece el valor de google-logging-use-fluentbit en false.

Habilita el agente de registro en los metadatos del proyecto

A partir del hito 97, se puede habilitar el registro en los metadatos del proyecto:

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

Nota: Las marcas de metadatos definidas a nivel de la instancia tienen prioridad sobre las marcas de metadatos definidas a nivel del proyecto.

Registros de acceso

Console

1. Ve a la página Instancias de VM

   Ir a la página Instancias de VM

2. Haz clic en el nombre de la instancia de Container-Optimized OS desde la que deseas acceder a los registros.

3. En la sección Registros, haz clic en Cloud Logging.

4. Se abrirá el Explorador de registros de la instancia determinada. Para obtener más información, consulta Usa el Explorador de registros.

Nota: En el compilador de consultas, puedes filtrar por nombre de registro. Haz clic en Nombre del registro y selecciona el nombre de registro determinado. Por ejemplo, cos_audit para los registros de auditoría o cos_containers para los registros de contenedores de Docker.

gcloud

Para acceder a los registros, usa el comando gcloud logging read. Por ejemplo:

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

Reemplaza lo siguiente:

• instance-id: El ID de tu instancia de VM.

Este comando intenta leer los registros de la instancia de VM con instance-id, con un límite de 10 registros, en formato JSON, de los últimos 30 días.

Para obtener más información sobre el comando gcloud, consulta la documentación de referencia de gcloud logging read.

¿Cómo funciona?

El agente de registro se configura de forma predeterminada para enviar registros de ciertos servicios críticos del sistema y contenedores de aplicaciones de usuario al backend de Cloud Logging. Por ejemplo, registros de contenedores de Docker, servicios systemd seleccionados, registros de auditoría, errores de registro de journal, etcétera. Consulta la fuente de configuración específica de Container-Optimized OS (imágenes x86 y imágenes Arm) para obtener la configuración de registro predeterminada completa.

En el caso de las imágenes x86 de Container-Optimized OS 105 y versiones anteriores, el agente de registro es el agente de registro heredado de Google Cloud Observability. El comando docker que inicia el agente de registro se define en la fuente de Container-Optimized OS para el servicio systemd de stackdriver-logging. La versión del agente en contenedor que se ejecuta se define en el directorio app-admin/stackdriver de la fuente de Container-Optimized OS.

En el caso de las imágenes de Arm de todas las versiones y las imágenes de x86 para Container-Optimized OS 109 y versiones posteriores, el agente de registro es un paquete del SO integrado llamado fluent-bit. El agente está integrado en el SO y se actualiza junto con las imágenes del SO.

Limitaciones conocidas

Compatibilidad con el controlador gcplogs

A partir del hito 89, si el agente de registro incluido con Container-Optimized OS está habilitado y el controlador de registro gcplogs de Docker está habilitado para uno o más contenedores, el agente de registro incluido puede generar registros de advertencia excesivos. Esto puede generar ruido en los registros o aumentar los cargos relacionados con Cloud Logging.

Una solución alternativa es no usar gcplogs como controlador de registro de Docker y, en su lugar, usar el controlador predeterminado según la configuración de Container-Optimized OS. Ten en cuenta que el agente de registro incluido con Container-Optimized OS exportará los registros de contenedores a Cloud Logging, por lo que no es necesario usar ambas soluciones de forma simultánea.

Compatibilidad de configuración del agente de Logging

El agente de registro es un contenedor basado en Fluentd en imágenes de Container-Optimized OS basadas en x86 y un objeto binario de Fluent-bit en imágenes de Container-Optimized OS basadas en Arm. Las configuraciones de los dos agentes no son compatibles. Esto no es un problema si solo dependes de la configuración de registro predeterminada integrada en las imágenes del SO. Sin embargo, si tienes una configuración de registro personalizada, es posible que experimentes fallas cuando migres cargas de trabajo a imágenes que se basan en una arquitectura diferente o a una versión más reciente de Container-Optimized OS.

Referencias

• Documentación del agente de Logging heredado de Google Cloud Observability El agente de registro en contenedor que se incluye con Container-Optimized OS es un subconjunto del agente de registro heredado, por lo que esta documentación puede proporcionar contexto sobre el agente de manera más general, fuera del alcance de Container-Optimized OS.
• Documentación de Google Cloud Observability. Página principal de la documentación de Google Cloud Observability. Puede ser útil para obtener contexto.