Crea y administra alcances de registro

En este documento, se describe cómo puedes crear y administrar los alcances de registro, que puedes usar para ayudarte a encontrar de forma eficiente las entradas de registro que deseas ver o analizar. Si solo deseas ver y analizar las entradas de registro que se originan en un proyecto, una carpeta o una organización, este documento no es para ti. Sin embargo, si dependes de receptores de registros para enrutar registros a otros proyectos o a buckets de registros definidos por el usuario, o si usas vistas de registro, la información de este documento podría ayudarte a encontrar entradas de registro específicas de manera eficiente.

En este documento, no se describe cómo ver tus registros. Para obtener información sobre ese tema, consulta Visualiza registros con el Explorador de registros.

Acerca de los ámbitos de registros

Los permisos de registro son recursos persistentes a nivel del proyecto que enumeran un conjunto de recursos. Estos recursos pueden ser proyectos, carpetas, organizaciones y vistas de registro. Por ejemplo, puedes definir un ámbito de registro que enumere los proyectos que contienen recursos que se usan para la producción o uno que enumere las vistas de registro que incluyen entradas de registro para un tipo de recurso específico.

Cuando creas un proyecto, una carpeta o un recurso de organización de Google Cloud, Logging crea un ámbito de registro llamado _Default. Este ámbito incluye el proyecto, la carpeta o la organización que se creó. Cuando un recurso buscado es un proyecto, una carpeta o una organización de Google Cloud, los resultados incluyen las entradas de registro que se originan en el recurso y luego se almacenan en un bucket de registros. Cuando se busca un proyecto, los resultados también incluyen entradas de registro que un receptor en otro proyecto dirige al proyecto y luego se almacenan en un bucket de registros.

Puedes crear permisos de registro. También puedes editar y borrar los alcances de registro que crees. Sin embargo, no puedes editar ni borrar el alcance de registro llamado _Default.

Usas un ámbito de registro para controlar en qué recursos la página Explorador de registros busca datos de registro. Cuando abres esa página y seleccionas un alcance de registro, la página busca los recursos que se enumeran en ese alcance y, luego, actualiza la pantalla.

También puedes usar un alcance de registro para controlar en qué recursos un panel de registros busca datos de registro. Un panel de registros es un widget de panel personalizado que muestra datos de registro. Cada panel de registros tiene su propia configuración, que te permite crear un panel que contenga varios paneles de registros en los que cada panel muestre datos de registro diferentes. Para obtener más información, consulta Cómo mostrar registros y errores en un panel personalizado.

En el caso de los proyectos, el ámbito de registros predeterminado determina el conjunto de recursos que busca la página Explorador de registros cuando se abre. Sin embargo, los roles de Identity and Access Management (IAM) en los recursos buscados y la configuración del período determinan qué entradas de registro se recuperan del almacenamiento. Cuando se crean proyectos, el ámbito de registro llamado _Default se designa como el ámbito de registro predeterminado. Puedes establecer cuál de tus ámbitos de registros es el predeterminado.

Prácticas recomendadas

Dado que los alcances de registro te permiten definir y guardar una configuración para usarla en el futuro, te recomendamos que crees alcances de registro para configuraciones de búsqueda complejas.

Por ejemplo, supongamos que estás solucionando un problema y deseas ver las entradas de registro de todas las instancias de máquina virtual (VM) que pertenecen a tu equipo. Para completar esta tarea, puedes hacer lo siguiente:

1. Determinas que las entradas de registro que deseas ver se almacenan en varios buckets de registros y en varios proyectos. Para la mayoría de los buckets de registro, existe una vista de registro que incluye las entradas de registro que deseas analizar. Si no existe una vista de registro, puedes crear una.

2. Decides crear un alcance de registro porque esperas tener una tarea de solución de problemas similar en el futuro.

3. Abre la página Explorador de registros en la consola de Google Cloud y, luego, usa el menú Definir mejor el alcance para seleccionar tu nuevo alcance de registro.

4. Revisas las entradas de registro y encuentras la información que necesitas para resolver el problema que estabas investigando.

5. Después de resolver el problema, compartes la causa de la falla con tus colegas. También compartes que esperas ver fallas similares en el futuro, por lo que creaste un alcance de registro que te permitirá a ti o a quien investigue la falla encontrar rápidamente las entradas de registro relevantes.

Limitaciones

• No puedes borrar ni modificar el ámbito de registro llamado _Default.
• Solo los proyectos de Google Cloud admiten un permiso de registro predeterminado.
• No puedes agregar carpetas ni organizaciones a un alcance de registro definido por el usuario.
• Los alcances de registro se crean en la ubicación global.

Antes de comenzar

• Para obtener los permisos que necesitas para crear y ver ámbitos de registro, y establecer el ámbito de registro predeterminado, pídele a tu administrador que te otorgue los siguientes roles de IAM:

  • Para crear y ver ámbitos de registros o obtener el ámbito de registros predeterminado, obtén el rol Escritor de configuración de registros (roles/logging.configWriter) en tu proyecto, carpeta o organización.
  • Para establecer el ámbito de registro predeterminado, usa el rol de editor de observabilidad (roles/observability.editor) en tu proyecto, carpeta o organización.

  Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

  Estos roles predefinidos contienen los permisos necesarios para crear y ver ámbitos de registro, y para establecer el ámbito de registro predeterminado. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

  Permisos necesarios

  Se requieren los siguientes permisos para crear y ver ámbitos de registro, y para establecer el ámbito de registro predeterminado:

  • Para obtener y configurar el ámbito de registro predeterminado, haz lo siguiente: observability.scopes.{get, update}

  También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.

• Select the tab for how you plan to use the samples on this page:

  Console

  When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

  gcloud

  In the Google Cloud console, activate Cloud Shell.

  Activate Cloud Shell

  At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  Terraform

  Para usar las muestras de Terraform de esta página en un entorno de desarrollo local, instala e inicializa gcloud CLI y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.

  1. Install the Google Cloud CLI.

  2. To initialize the gcloud CLI, run the following command:

     gcloud init

  3. If you're using a local shell, then create local authentication credentials for your user account:

     gcloud auth application-default login

     You don't need to do this if you're using Cloud Shell.

  Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local en la documentación de autenticación de Google Cloud.

  REST

  Para usar las muestras de la API de REST en esta página en un entorno de desarrollo local, debes usar las credenciales que proporcionas a la CLI de gcloud.

  Install the Google Cloud CLI, then initialize it by running the following command:

  gcloud init

  Si deseas obtener más información, consulta Autentica para usar REST en la documentación de autenticación de Google Cloud.

Cómo enumerar los ámbitos de registros

 gcloud logging scopes list --project=PROJECT_ID

 gcloud logging scopes describe LOG_SCOPE --project=PROJECT_ID

Establece el ámbito de registro predeterminado

El ámbito de registros predeterminado enumera los recursos que busca la página Explorador de registros cuando se abre. Si no existe un ámbito de registro predeterminado o no se puede acceder a él, esa página busca automáticamente entradas de registro que se originan en el proyecto, la carpeta o la organización seleccionados. Las entradas de registro que muestra la página Explorador de registros dependen de los recursos que se buscaron, la configuración del intervalo de tiempo y tus roles de IAM en los recursos que se buscaron.

Cuando se crean proyectos, se crea el ámbito de registro llamado _Default y se designa como el ámbito de registro predeterminado. Sin embargo, puedes crear tu propio ámbito de registro y designarlo como el predeterminado.

Crea un permiso de registro

Puedes crear 100 alcances de registro por proyecto. Un ámbito de registro puede incluir un total de 100 vistas de registro y proyectos. Sin embargo, solo puede incluir 5 proyectos. No puedes agregar carpetas ni organizaciones a un alcance de registro.

 gcloud logging scopes create LOG_SCOPE --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

Modifica o borra un permiso de registro

 gcloud logging scopes update LOG_SCOPE --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

 gcloud logging scopes delete LOG_SCOPE --project=PROJECT_ID

¿Qué sigue?

• Visualiza registros con el explorador de registros
• Cómo configurar vistas de registro en un bucket de registro