Intercala y enruta los registros a nivel de la organización a destinos compatibles

En este documento, se describe cómo crear receptores agregados. Para obtener información sobre cómo administrar los receptores existentes, consulta Enruta registros a destinos compatibles: Administra los receptores.

Descripción general

Los receptores agregados combinan y enrutan entradas de registro de los recursos de Google Cloud que contiene una organización o carpeta. Por ejemplo, puedes agregar y enrutar entradas de registro de auditoría de todas las carpetas que contiene una organización a un bucket de Cloud Storage.

Sin la función de receptor agregado, los receptores se limitan a exportar entradas de registro desde el recurso exacto en el que se creó el receptor, como un proyecto, una organización, una carpeta o una cuenta de facturación de Google Cloud.

Puedes crear receptores agregados para organizaciones y carpetas de Google Cloud. Debido a que ni los proyectos de Google Cloud ni las cuentas de facturación contienen recursos secundarios, no puedes crear receptores agregados para ellos.

Destinos admitidos

Puedes usar los receptores agregados para enrutar los registros dentro de las mismas organizaciones y carpetas, o entre ellas, a los siguientes destinos:

  • Buckets de registros de Cloud Logging: Proporciona almacenamiento en Cloud Logging. Un bucket de registros puede almacenar registros que reciben varios proyectos de Google Cloud. Puedes combinar tus datos de Cloud Logging con otros datos si actualizas un bucket de registros para usar el análisis de registros y, luego, creas un conjunto de datos de BigQuery vinculado. Para obtener información sobre cómo ver los registros almacenados en buckets de registros, consulta Descripción general de consultas y vistas de registros y Visualiza los registros enrutados a buckets de Cloud Logging.
  • Proyectos de Google Cloud: Enruta las entradas de registro a un proyecto de Google Cloud diferente. Cuando enrutas registros a un proyecto de Google Cloud diferente, el enrutador de registros del proyecto de destino recibe los registros y los procesa. Los receptores en el proyecto de destino determinan cómo se enrutan las entradas de registro recibidas. Error Reporting no puede analizar las entradas de registro que se enrutan a un proyecto de Google Cloud diferente.
  • Temas de Pub/Sub: Proporciona compatibilidad con integraciones de terceros, como Splunk. Las entradas de registro se formatean en JSON y, luego, se enrutan a un tema de Pub/Sub. Para obtener información sobre cómo ver los registros enrutados a Pub/Sub, consulta Visualiza los registros enrutados a Pub/Sub.
  • Conjuntos de datos de BigQuery: Proporciona almacenamiento de entradas de registro en conjuntos de datos de BigQuery. Puedes usar capacidades de análisis de macrodatos en los registros almacenados. A fin de combinar tus datos de Cloud Logging con otras fuentes de datos, te recomendamos que actualices tus buckets de registros para usar el análisis de registros y, luego, crees un conjunto de datos de BigQuery vinculado. Para obtener información sobre cómo ver los registros enrutados a BigQuery, consulta Visualiza los registros enrutados a BigQuery.
  • Depósitos de Cloud Storage: Proporciona almacenamiento de datos de registro en Cloud Storage. Las entradas de registro se almacenan como archivos JSON. Para obtener información sobre cómo ver los registros enrutados a Cloud Storage, consulta Visualiza los registros enrutados a Cloud Storage.

Antes de comenzar

Antes de crear un receptor, asegúrate de lo siguiente:

  • Tienes una organización o carpeta de Google Cloud con registros que puedes ver en el Explorador de registros.

  • Tienes una de las siguientes funciones de IAM para la organización o carpeta de Google Cloud desde la que enrutas los registros.

    • Propietario (roles/owner)
    • Administrador de Logging (roles/logging.admin)
    • Escritor de configuración de registros (roles/logging.configWriter)

    Los permisos contenidos en estos roles te permiten crear, borrar o modificar receptores. Para obtener información sobre cómo configurar las funciones de IAM, consulta la Guía de control de acceso de Logging.

  • Tienes un recurso en un destino admitido o tienes la capacidad de crear uno.

    El destino de enrutamiento debe crearse antes que el receptor mediante la CLI de Google Cloud, la consola de Google Cloud o las APIs de Google Cloud. Puedes crear el destino en cualquier proyecto de Google Cloud de cualquier organización, pero debes asegurarte de que la cuenta de servicio del receptor tenga permisos para escribir en el destino.

Crea un receptor agregado

Para usar receptores agregados, crea un receptor en una organización o carpeta de Google Cloud y establece el parámetro includeChildren del receptor en True. Ese receptor puede enrutar entradas de registro de la organización o carpeta, además de (de forma recurrente) desde cualquier carpeta, cuenta de facturación o proyecto de Google Cloud. Establece los filtros de inclusión y exclusión del receptor para especificar las entradas de registro que deseas enrutar a tu destino.

Puedes crear hasta 200 receptores por carpeta o por organización.

A fin de crear un receptor agregado para tu organización o carpeta, haz lo siguiente:

Consola

  1. En la consola de Google Cloud, selecciona Logging y, luego, Enrutador de registros, o haz clic en el siguiente botón:

    Ir al Enrutador de registros

  2. Selecciona una organización o carpeta existente.

  3. Selecciona Crear receptor.

  4. En el panel Detalles del receptor, ingresa los siguientes detalles:

    • Nombre del receptor: proporciona un identificador para el receptor; ten en cuenta que, después de crear el receptor, no puedes cambiarle el nombre, pero puedes borrarlo y crear uno nuevo.

    • Descripción del receptor (opcional): Describe el propósito o el caso de uso del receptor.

  5. En el panel Destino del receptor, selecciona el servicio y el destino del receptor:

    • Selecciona el servicio del receptor: Selecciona el servicio al que deseas enrutar los registros.

    Según el servicio que selecciones, puedes elegir entre los siguientes destinos:

    • Bucket de Cloud Logging: selecciona o crea un bucket de Logging. Si creas un bucket de registros, debe estar a nivel de proyecto. No puedes crear un bucket de registros a nivel de la organización o de la carpeta.
    • Tabla de BigQuery: selecciona o crea el conjunto de datos particular para recibir los registros enrutados. También tienes la opción de usar tablas particionadas.
    • Bucket de Cloud Storage: Selecciona o crea el bucket de Cloud Storage en particular para recibir los registros enrutados.
    • Tema de Pub/Sub: selecciona o crea el tema específico para recibir los registros enrutados.

    • Splunk: Selecciona el tema de Pub/Sub para el servicio de Splunk.

      Por ejemplo, si el destino de tu receptor es un conjunto de datos de BigQuery, el destino del receptor sería el siguiente:

      bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID

  6. En el panel Elige registros para incluirlos en el receptor, haz lo siguiente:

    1. Selecciona Incluir registros transferidos por este recurso y todos los recursos secundarios, lo que crea un receptor agregado.

    2. En el campo Crear filtro de inclusión, ingresa una expresión de filtro que coincida con las entradas de registro que deseas incluir. Si no estableces un filtro, todos los registros del recurso seleccionado se enrutarán al destino.

      Por ejemplo, es posible que desees compilar un filtro para enrutar todos los registros de auditoría de acceso a los datos a un solo bucket de Logging. Este filtro se verá de la siguiente manera:

      LOG_ID("cloudaudit.googleapis.com/data_access") OR LOG_ID("externalaudit.googleapis.com/data_access")

      Ten en cuenta que la longitud de un filtro no puede superar los 20,000 caracteres.

    3. Para verificar que ingresaste el filtro correcto, selecciona Obtener vista previa de los registros. Esto abrirá el Explorador de registros en una pestaña nueva con el filtro ya propagado.

  7. En el panel Elige registros para excluir del receptor (opcional), haz lo siguiente:

    1. En el campo Nombre del filtro de exclusión, ingresa un nombre.

    2. En el campo Compila un filtro de exclusión, ingresa una expresión de filtro que coincida con las entradas de registro que deseas excluir. También puedes usar la función sample para seleccionar una parte de las entradas de registro que deseas excluir.

      Por ejemplo, para excluir los registros de un proyecto específico para que no se enruten al destino, agrega el siguiente filtro de exclusión:

      logName:projects/PROJECT_ID

      Si deseas excluir registros de varios proyectos, usa el operador lógico OR para unir las cláusulas logName.

    Puedes crear hasta 50 filtros de exclusión por receptor. Ten en cuenta que la longitud de un filtro no puede superar los 20,000 caracteres.

  8. Selecciona Crear receptor.

API

Para crear un receptor, usa organizations.sinks.create o folders.sinks.create en la API de Logging. Prepara los argumentos del método de la siguiente manera:

  1. Establece el parámetro parent para que sea la organización o carpeta de Google Cloud en la que se crea el receptor. El superior debe ser uno de los siguientes:

    • organizations/ORGANIZATION_ID
    • folders/FOLDER_ID

  2. En el objeto LogReceiver en el cuerpo de la solicitud del método, haz lo siguiente:

  3. Llama a organizations.sinks.create o folders.sinks.create para crear el receptor.

  4. Recupera el nombre de la cuenta de servicio del campo writer_identity que muestra la respuesta de la API.

  5. Otorga permiso a esa cuenta de servicio para escribir en el destino del receptor.

    Si no tienes permiso para realizar ese cambio en el destino del receptor, envía el nombre de la cuenta de servicio a alguien que pueda realizarlo por ti.

    Si quieres obtener más información a fin de otorgar permisos a cuentas de servicio para recursos, consulta la sección Configura permisos de destino.

gcloud

Para crear un receptor, usa el comando logging sinks create.

  1. Proporciona el nombre del receptor, el destino del receptor, el filtro y el ID de la carpeta o la organización desde la que enrutas los registros:

    gcloud logging sinks create SINK_NAME \
  SINK_DESTINATION  --include-children \
  --folder=FOLDER_ID --log-filter="LOG_FILTER"

    Por ejemplo, si creas un receptor agregado a nivel de carpeta y cuyo destino es un conjunto de datos de BigQuery, el comando podría verse de la siguiente manera:

    gcloud logging sinks create SINK_NAME \
  bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID --include-children \
  --folder=FOLDER_ID --log-filter="logName:activity"

    Notas:

    • Para crear un receptor a nivel de la organización, reemplaza --folder=FOLDER_ID por --organization=ORGANIZATION_ID.

    • Para que el receptor incluya todos los recursos dentro de la organización, se debe establecer la marca --include-children, incluso cuando la marca --organizationse pasa a create. Cuando se establece como false (la opción predeterminada), un receptor solo exporta los registros del recurso de host.

    • Si quieres ver algunos ejemplos útiles, consulta Crea filtros para receptores agregados.

  2. Recupera el nombre de la cuenta de servicio usado para crear el receptor del resultado del comando.

  3. Otorga permiso a esa cuenta de servicio para escribir en el destino del receptor.

    Si no tienes permiso para realizar ese cambio en el destino del receptor, envía el nombre de la cuenta de servicio a alguien que pueda realizarlo por ti.

    Si quieres obtener más información a fin de otorgar permisos a cuentas de servicio para recursos, consulta la sección Configura permisos de destino.

Cualquier cambio realizado en un receptor puede tardar unos minutos en aplicarse.

Crea filtros para los receptores agregados

Como cualquier receptor, tu receptor agregado contiene un filtro que selecciona entradas de registro individuales. Si quieres ver ejemplos de filtros que puedes usar para crear tu receptor agregado, consulta Ejemplos de consultas con el Explorador de registros.

A continuación, se presentan algunos ejemplos de comparaciones de consultas que son útiles cuando se usa la función de receptores agregados. Algunos ejemplos usan la siguiente notación:

  • : es el operador de la substring. No sustituyas el operador =.
  • ...… representa cualquier comparación de filtro adicional.
  • Las variables se indican mediante texto de color. Reemplázalos con valores válidos.

Ten en cuenta que la longitud de un filtro no puede superar los 20,000 caracteres.

Para obtener más detalles sobre la sintaxis de filtros, consulta Lenguaje de consulta de Logging.

Selecciona la fuente del archivo de registro

Para enrutar registros de organizaciones, carpetas o proyectos específicos de Google Cloud, usa una de las siguientes comparaciones de muestra:

logName:"projects/PROJECT_ID/logs/" AND ... 
logName:("projects/PROJECT_A_ID/logs/" OR "projects/PROJECT_B_ID/logs/") AND ... 
logName:"folders/FOLDER_ID/logs/" AND ... 
logName:"organizations/ORGANIZATION_ID/logs/" AND ...

Selecciona el recurso supervisado

Para enrutar registros de solo un recurso supervisado específico en un proyecto de Google Cloud, usa varias comparaciones a fin de especificar el recurso con exactitud:

logName:"projects/PROJECT_ID/logs" AND
resource.type=RESOURCE_TYPE AND
resource.labels.instance_id=INSTANCE_ID

Para obtener una lista de tipos de recursos, consulta Tipos de recursos supervisados.

Selecciona una muestra de entradas de registro

Para enrutar una muestra aleatoria de entradas de registro, agrega la función integrada sample. Por ejemplo, para enrutar solo el diez por ciento de las entradas de registro que coincidan con tu filtro actual, usa esta adición:

sample(insertId, 0.10) AND ...

Para obtener más información, consulta la función sample.

Para obtener más información sobre los filtros de Cloud Logging, consulta Lenguaje de consulta de Logging.

Configura permisos de destino

En esta sección, se describe cómo otorgar a Logging los permisos de Identity and Access Management para escribir los registros en el destino de tu receptor. Para obtener la lista completa de las funciones y los permisos de Logging, consulta Control de acceso.

Cuando creas o actualizas un receptor que enrute los registros a cualquier destino que no sea un bucket de registros en el proyecto actual, se requiere una cuenta de servicio para ese receptor. Logging crea y administra de forma automática la cuenta de servicio por ti:

  • A partir del 22 de mayo de 2023, cuando creas un receptor y no existe una cuenta de servicio para el recurso subyacente, Logging crea la cuenta de servicio. Logging usa la misma cuenta de servicio para todos los receptores del recurso subyacente. Los recursos pueden ser un proyecto de Google Cloud, una organización, una carpeta o una cuenta de facturación.
  • Antes del 22 de mayo de 2023, Logging creó una cuenta de servicio para cada receptor. A partir del 22 de mayo de 2023, Logging usa una cuenta de servicio compartida para todos los receptores del recurso subyacente.

La identidad de escritor de un receptor es el identificador de la cuenta de servicio asociada con ese receptor. Todos los receptores tienen una identidad de escritor, a menos que escriban en un bucket de registros del proyecto actual de Google Cloud.

Para enrutar registros a un recurso protegido por un perímetro de servicio, debes agregar la cuenta de servicio para ese receptor a un nivel de acceso y, luego, asignarla al perímetro de servicio de destino. Esto no es necesario para los receptores no agregados. Para obtener más información, consulta Controles del servicio de VPC: Cloud Logging.

A fin de configurar los permisos para que tu receptor se enrute a su destino, haz lo siguiente:

Consola

  1. Para obtener información sobre la cuenta de servicio del receptor, haz lo siguiente:

    1. En la consola de Google Cloud, selecciona Logging y, luego, Enrutador de registros, o haz clic en el siguiente botón:

      Ir al Enrutador de registros

    2. Selecciona Menú y, luego, Ver detalles del receptor.

      En el panel Detalles del receptor, el campo writerIdentity contiene la identidad de la cuenta de servicio. La string serviceAccount: forma parte de la identidad de la cuenta de servicio. Por ejemplo:

      serviceAccount:service-123456789012@gcp-sa-logging.iam.gserviceaccount.com

  2. En el proyecto de destino, otorga a la identidad de escritor la función necesaria para que la cuenta de servicio escriba en el destino. Para otorgar un rol a una principal, debes tener el rol de propietario (roles/owner):

    • Para los destinos de Cloud Storage, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de Creador de objetos de almacenamiento (roles/storage.objectCreator).
    • Para los destinos de BigQuery, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de editor de datos de BigQuery (roles/bigquery.dataEditor).
    • Para los destinos de Pub/Sub, incluido Splunk, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de Publicador de Pub/Sub (roles/pubsub.publisher).
    • Para los destinos de buckets de Logging en diferentes proyectos de Google Cloud, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de escritor del bucket de registros (roles/logging.bucketWriter).
    • Para los destinos de proyectos de Google Cloud, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de escritor de registros (roles/logging.logWriter). Específicamente, una principal necesita el permiso logging.logEntries.route.
    Si no tienes acceso de Propietario al destino del receptor, pídele a un propietario del proyecto que agregue la identidad de escritor como principal.

API

  1. Para obtener información sobre la cuenta de servicio del receptor, llama al método de la API organizations.sinks.get o folders.sinks.get.

    El campo writerIdentity contiene la identidad de la cuenta de servicio. La string serviceAccount: forma parte de la identidad de la cuenta de servicio. Por ejemplo:

    serviceAccount:service-123456789012@gcp-sa-logging.iam.gserviceaccount.com

  2. En el proyecto de destino, otorga a la identidad de escritor la función necesaria para que la cuenta de servicio escriba en el destino. Para otorgar un rol a una principal, debes tener el rol de propietario (roles/owner):

    • Para los destinos de Cloud Storage, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de Creador de objetos de almacenamiento (roles/storage.objectCreator).
    • Para los destinos de BigQuery, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de editor de datos de BigQuery (roles/bigquery.dataEditor).
    • Para los destinos de Pub/Sub, incluido Splunk, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de Publicador de Pub/Sub (roles/pubsub.publisher).
    • Para los destinos de buckets de Logging en diferentes proyectos de Google Cloud, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de escritor del bucket de registros (roles/logging.bucketWriter).
    • Para los destinos de proyectos de Google Cloud, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de escritor de registros (roles/logging.logWriter). Específicamente, una principal necesita el permiso logging.logEntries.route.
    Si no tienes acceso de Propietario al destino del receptor, pídele a un propietario del proyecto que agregue la identidad de escritor como principal.

gcloud

  1. Para obtener información sobre la cuenta de servicio del receptor, ejecuta el siguiente comando:

    gcloud logging sinks describe SINK_NAME

    El campo writerIdentity contiene la identidad de la cuenta de servicio. La string serviceAccount: forma parte de la identidad de la cuenta de servicio. Por ejemplo:

    serviceAccount:service-123456789012@gcp-sa-logging.iam.gserviceaccount.com

  2. En el proyecto de destino, otorga a la identidad de escritor la función necesaria para que la cuenta de servicio escriba en el destino. Para otorgar un rol a una principal, debes tener el rol de propietario (roles/owner):

    • Para los destinos de Cloud Storage, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de Creador de objetos de almacenamiento (roles/storage.objectCreator).
    • Para los destinos de BigQuery, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de editor de datos de BigQuery (roles/bigquery.dataEditor).
    • Para los destinos de Pub/Sub, incluido Splunk, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de Publicador de Pub/Sub (roles/pubsub.publisher).
    • Para los destinos de buckets de Logging en diferentes proyectos de Google Cloud, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de escritor del bucket de registros (roles/logging.bucketWriter).
    • Para los destinos de proyectos de Google Cloud, agrega la identidad de escritor del receptor como una principal mediante IAM y, luego, otórgale el rol de escritor de registros (roles/logging.logWriter). Específicamente, una principal necesita el permiso logging.logEntries.route.
    Si no tienes acceso de Propietario al destino del receptor, pídele a un propietario del proyecto que agregue la identidad de escritor como principal.

¿Qué sigue?