Cuando ejecutas compilaciones, Cloud Build recopila y almacena los registros de compilación. En esta página, se explica cómo almacenar, ver y borrar registros de compilación.
Elige dónde almacenar los registros de compilación
Puedes configurar Cloud Build para almacenar registros de compilación en Cloud Logging o Cloud Storage si incluyes el campo logging
en el archivo de configuración de Cloud Build.
Si no especificas un campo logging
en el archivo de configuración de compilación, Cloud Build almacena los registros de compilación en Logging y Cloud Storage.
En los siguientes pasos, se almacenan registros de compilación solo en Logging:
En tu archivo de configuración de compilación, establece el valor de
logging
comoCLOUD_LOGGING_ONLY
:YAML
steps: - name: 'gcr.io/cloud-builders/docker' args: ['build', '-t', 'us-east1-docker.pkg.dev/myproject/myimage', '.'] options: logging: CLOUD_LOGGING_ONLY
JSON
{ "steps": [ { "name": "gcr.io/cloud-builders/docker", "args": [ "build", "-t", "us-east1-docker.pkg.dev/myproject/myimage", "." ] } ], "options": { "logging": "CLOUD_LOGGING_ONLY" } }
Usa el archivo de configuración de compilación para iniciar una compilación con la línea de comandos, la API o los activadores.
Asigna campos de registro de compilación a campos de entrada de registro
Puedes configurar el JSON de tus registros de compilación para que los campos de registro de compilación especificados se asignen a campos LogEntry
cuando el registro de compilación se envíe a Logging.
Por ejemplo, si el registro de compilación contiene un message
, el mensaje aparecerá en textPayload
o jsonPayload.message
en la entrada de registro resultante. Los campos del registro de compilación que no se pueden asignar aparecen en la entrada de registro jsonPayload
.
Para habilitar la asignación de campos en tus registros de compilación, establece el campo enableStructuredLogging
de BuildOptions
en TRUE
.
En la siguiente tabla, se muestran los campos del registro de compilación que se asignan a un campo de entrada de registro:
Campo BuildLog (JSON) | Campo LogEntry | Descripción | Notas |
---|---|---|---|
message |
textPayload o jsonPayload.message |
Permite que los usuarios establezcan el mensaje de registro | Debe ser una cadena. Si el registro de compilación solo contiene campos asignables, el mensaje aparecerá en Si el registro de compilación contiene varios pasos, el identificador de pasos aparecerá al comienzo del mensaje. |
severity |
severity |
Permite que los usuarios establezcan la gravedad del registro. | Debe ser una enumeración de LogSeverity . |
Los siguientes campos de registro de compilación no se pueden asignar y se quitarán de la entrada de registro si aparecen en un registro de compilación:
httpRequest
logging.googleapis.com/insertId
logging.googleapis.com/labels
logging.googleapis.com/operation
logging.googleapis.com/sourceLocation
logging.googleapis.com/spanId
logging.googleapis.com/trace
logging.googleapis.com/trace_sampled
time
timestamp
timestampSeconds
timestampNanos
Todos los demás campos del registro de compilación aparecerán como parte del jsonPayload
de la entrada de registro.
Almacena registros de compilación en el bucket predeterminado creado por Google
De forma predeterminada, Cloud Build almacena tus registros de compilación en un bucket de Cloud Storage creado por Google. Puedes ver registros de compilación almacenados en el bucket de Cloud Storage creado por Google, pero no puedes realizar ningún otro cambio. Si necesitas control total sobre tu bucket de registros, almacena los registros en un bucket de Cloud Storage creado por el usuario.
Almacena registros de compilación en un bucket creado por el usuario
Permisos de IAM:
Para almacenar registros de compilación en tu propio bucket de Cloud Storage, primero debes otorgar los permisos de IAM necesarios a la cuenta de servicio que usas para la compilación:
Si tu bucket de Cloud Storage y Cloud Build están en el mismo proyecto de Google Cloud y usas la cuenta de servicio heredada de Cloud Build, esta tiene los permisos de IAM necesarios de forma predeterminada. No es necesario otorgar permisos adicionales.
En cualquier otro caso, otorga el rol de Administrador de almacenamiento a la cuenta de servicio que usas para la compilación:
Abre la página de IAM en el proyecto en el que se encuentra tu bucket de Cloud Storage:
Haz clic en Otorgar acceso.
Ingresa la dirección de correo electrónico de la cuenta de servicio.
Selecciona Cloud Storage > Administrador de almacenamiento.
Haz clic en Guardar.
Para especificar un depósito de Cloud Storage a fin de almacenar registros de compilación sigue estos pasos:
En tu proyecto de Google Cloud, crea un bucket de Cloud Storage sin una política de retención establecida para almacenar tus registros de compilación.
En tu archivo de configuración de compilación , agrega un campo
logsBucket
que apunte al bucket de Cloud Storage que creaste para almacenar registros de compilación. En el siguiente archivo de configuración de compilación de ejemplo, se incluyen instrucciones para compilar una imagen de contenedor y almacenar los registros de compilación en un bucket llamadomylogsbucket
:YAML
steps: - name: 'gcr.io/cloud-builders/docker' args: [ 'build', '-t', 'us-east1-docker.pkg.dev/myproject/myimage', '.' ] logsBucket: 'gs://mylogsbucket' options: logging: GCS_ONLY
JSON
{ "steps": [ { "name": "gcr.io/cloud-builders/docker", "args": [ "build", "-t", "us-east1-docker.pkg.dev/myproject/myimage", "." ] } ], "logsBucket": "gs://mylogsbucket", "options": { "logging": "GCS_ONLY" } }
Usa el archivo de configuración de compilación para iniciar una compilación con la línea de comandos, la API o los activadores.
Cuando se completa la compilación, Cloud Build almacena los registros en el bucket de Cloud Storage que especificaste en el archivo de configuración de compilación.
Almacena registros de compilación en un bucket regionalizado y propiedad del usuario
De forma predeterminada, Cloud Build almacena los registros de compilación en una región especificada por Google que puede ser diferente de la ubicación en la que ejecutas una compilación. La opción defaultLogsBucketBehavior
te permite configurar Cloud Build para que use un bucket de registros predeterminado dentro de tu propio proyecto y en la misma región que la compilación. Esta configuración te brinda más control sobre la ubicación de los datos de tus registros, lo que puede ayudarte a cumplir con los requisitos de residencia de datos.
Se te cobrará un costo por almacenar registros en tu propio proyecto. Para obtener detalles sobre los precios, consulta Precios de Cloud Storage.
Configura Cloud Build para usar registros regionalizados que pertenecen al usuario:
Otorga los permisos de IAM necesarios.
Si usas la cuenta de servicio heredada de Cloud Build, esta tiene los permisos de IAM necesarios de forma predeterminada. No es necesario otorgar permisos adicionales.
Para otras cuentas de servicio, otorga el rol de Administrador de almacenamiento a la cuenta de servicio que usas para la compilación. Si deseas obtener instrucciones para otorgar un rol a una cuenta de servicio, consulta Otorga roles en el proyecto.
En tu configuración de compilación, agrega la opción
defaultLogsBucketBehavior
y establece su valor enREGIONAL_USER_OWNED_BUCKET
:YAML
steps: - name: 'gcr.io/cloud-builders/docker' args: [ 'build', '-t', 'us-central1-docker.pkg.dev/myproject/myrepo/myimage', '.' ] options: defaultLogsBucketBehavior: REGIONAL_USER_OWNED_BUCKET
JSON
{ "steps": [ { "name": "gcr.io/cloud-builders/docker", "args": [ "build", "-t", "us-central1-docker.pkg.dev/myproject/myrepo/myimage", "." ] } ], "options": { "defaultLogsBucketBehavior": "REGIONAL_USER_OWNED_BUCKET" } }
Usa el archivo de configuración de compilación para iniciar una compilación con la línea de comandos, la API o los activadores.
Cuando ejecutas la compilación, Cloud Build crea el bucket de registros nuevo en la región en la que la ejecutas y, luego, almacena los registros de compilación en este bucket. Las compilaciones posteriores en el mismo proyecto y la misma región usarán el bucket existente de forma predeterminada.
Si configuras la opción defaultLogsBucketBehavior
y, luego, creas compilaciones en varias regiones, Cloud Build crea varios buckets para tus registros de compilación.
Los registros de compilación regionalizados almacenados en tu propio proyecto no tienen una política de retención. Este parámetro de configuración es inmutable.
Prioridad entre la configuración de registros
Si agregas la opción defaultLogsBucketBehavior
a un archivo de configuración de compilación existente y ya configuraste las opciones logging
o logsBucket
, te recomendamos que borres esa configuración para evitar conflictos entre los parámetros.
Específicamente, defaultLogsBucketBehavior
no funcionará si configuraste lo siguiente:
logging: CLOUD_LOGGING_ONLY
para almacenar tus registros de compilación en Cloud Logging.logging: NONE
para desactivar el registro.
Cuando ejecutas una compilación sin opciones de registro configuradas en la configuración de compilación,
Cloud Build establece
logging: LEGACY
y almacena los registros en el bucket predeterminado de Cloud Storage creado por Google. Si
añades defaultLogsBucketBehavior: REGIONAL_USER_OWNED_BUCKET
, esta opción
anula logging: LEGACY
.
Visualiza registros de compilación
Permisos de IAM:
Si tus registros de compilación están en Logging, otorga la función visualizador de registros en el proyecto en el que la compilación está configurada para los principales que desean ver los registros de compilación:
Abrir la página de IAM
Selecciona tu proyecto y haz clic en Open.
En la tabla de permisos, busca el ID de correo electrónico del principal y haz clic en el ícono de lápiz.
Selecciona la función Logging > Visor de registros.
Haz clic en Guardar.
Si tus registros de compilación están en el bucket predeterminado de Cloud Storage creado por Google, otorga la función Visualizador del proyecto en el proyecto en el que la compilación está configurada a los principales que desean ver los registros de compilación:
Abrir la página de IAM
Selecciona tu proyecto y haz clic en Open.
En la tabla de permisos, busca el ID de correo electrónico del principal y haz clic en el ícono de lápiz.
Selecciona la función Proyecto Visualizador.
Haz clic en Guardar.
Si tus registros de compilación se encuentran en un bucket de Cloud Storage creado o que pertenece al usuario, otorga el rol de visualizador de objetos de almacenamiento a las principales que quieran ver registros de compilación:
Abrir la página de IAM
Selecciona tu proyecto y haz clic en Open.
En la tabla de permisos, busca el ID de correo electrónico del principal y haz clic en el ícono de lápiz.
Selecciona la función Cloud Storage > Visualizador de objetos de almacenamiento.
Haz clic en Guardar.
Para ver los registros de compilación en Cloud Build, haz lo siguiente:
Console
Abre la página de Cloud Build en la consola de Google Cloud.
Selecciona tu proyecto y haz clic en Open.
En el menú desplegable Región, selecciona la región para tu compilación.
En la página Historial de compilación, haz clic en una compilación específica.
En la página Build details, en Steps, haz clic en Build summary para ver los registros de compilación de toda tu compilación o haz clic en un paso de compilación para ver registros de compilación para ese paso.
Si tus registros se almacenan en Logging, en el panel Registro de compilación, haz clic en el ícono
para ver los registros en el Explorador de registros.
gcloud
Ejecuta el comando gcloud builds log
, en el que build-id es el ID de la compilación para la que deseas obtener registros de compilación. El ID de compilación se muestra al final del proceso de envío de la compilación cuando ejecutas gcloud builds submit
o en la columna de ID cuando ejecutas gcloud builds list
.
gcloud builds log build-id
Para ver los registros de compilación en GitHub y GitHub Enterprise, haz lo siguiente:
Si creas un activador de GitHub o GitHub Enterprise y especificas --include-logs-with-status
como opción, podrás ver tus registros de compilación en GitHub y GitHub Enterprise.
Para ver los registros de compilación en GitHub y GitHub Enterprise, sigue estos pasos:
Navega al repositorio asociado con tu activador.
Navega a tu lista de confirmaciones.
Busca la fila de la confirmación para la que deseas ver los registros de compilación.
Haz clic en el ícono de resultado en la fila de tu confirmación.
Verás una lista de las verificaciones asociadas con tu confirmación.
Haz clic en Detalles en la fila de la que deseas ver los registros de compilación.
Verás la página Resumen asociada con tu confirmación. Si creaste un activador con la marca
--include-logs-with-status
, verás los registros de compilación en la sección Detalles de la página.
Borra registros de compilación
No puedes borrar los registros de compilación en el bucket de registros creado por Google.
Para borrar registros de compilación en un bucket de registros creado por el usuario, haz lo siguiente:
Otorga la función administrador de objetos de almacenamiento al usuario o a la cuenta de servicio que borra los registros.
Borra los registros de compilación con las instrucciones para borrar objetos de Cloud Storage en Borra objetos.
Para borrar el bucket de registros creado por el usuario, haz lo siguiente:
Otorga la función administrador de almacenamiento al usuario o a la cuenta de servicio que borra el depósito de registros.
Borra el bucket de registros con las instrucciones para borrar un bucket en Borra buckets.
¿Qué sigue?
- Obtén más información sobre los registros de auditoría creados por Cloud Build.
- Aprende a ver resultados de compilación.
- Obtén más información sobre los permisos de IAM de Cloud Build.