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:
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.
Decides crear un alcance de registro porque esperas tener una tarea de solución de problemas similar en el futuro.
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.
Revisas las entradas de registro y encuentras la información que necesitas para resolver el problema que estabas investigando.
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.
-
Para crear y ver ámbitos de registros o obtener el ámbito de registros predeterminado, obtén el rol Escritor de configuración de registros (
-
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.
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.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init -
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 ADC 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 initSi 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
Console
Para enumerar los permisos de registro, haz lo siguiente:
-
En la consola de Google Cloud, ve a la páginasettings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
Selecciona la pestaña Log Scopes.
En la tabla, se enumeran tus alcances de registro. Cuando seleccionas un proyecto de Google Cloud, se muestra una entrada en la tabla con el ícono "Predeterminado",
, que indica que este
ámbito de registro enumera los recursos que busca el Explorador de registros
cuando se abre esa página.
gcloud
Para enumerar los alcances de registro en un proyecto, usa el comando
gcloud logging scopes list:gcloud logging scopes list --project=PROJECT_IDAntes de ejecutar el comando, actualiza los siguientes campos:
- PROJECT_ID: Es el identificador del proyecto.
Para obtener los detalles de un alcance de registro en un proyecto, usa el comando
gcloud logging scopes describe:gcloud logging scopes describe LOG_SCOPE --project=PROJECT_IDAntes de ejecutar el comando, actualiza los siguientes campos:
- PROJECT_ID: Es el identificador del proyecto.
- LOG_SCOPE: Es el nombre del alcance del registro.
Por ejemplo,
my-scope
Terraform
Puedes usar Terraform para crear y modificar un alcance de registro. Sin embargo, no puedes usar Terraform para enumerar los permisos de registro.
REST
La API de Cloud Logging contiene comandos que enumeran los permisos de registro en un recurso o que informan los detalles de un permiso de registro específico. Para obtener una lista completa de los comandos, consulta la documentación de referencia de la API.
Para proyectos de Google Cloud, usa los siguientes comandos:
En el comando de la API, establece el campo
locationsenglobal.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
_Defaulty se designa como el ámbito de registro predeterminado. Sin embargo, puedes crear tu propio ámbito de registro y designarlo como el predeterminado.Console
Para establecer el alcance de registro predeterminado, haz lo siguiente:
-
En la consola de Google Cloud, ve a la páginasettings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
- Selecciona la pestaña Log Scopes.
Busca el alcance de registro que deseas designar como el alcance de registro predeterminado, haz clic en more_vert Más y, luego, selecciona Establecer como predeterminado.
El ámbito de registro que seleccionaste se muestra con el ícono "Predeterminado",
.
gcloud
No compatible.
Terraform
Puedes usar Terraform para crear y modificar un alcance de registro. Sin embargo, no puedes usar Terraform para establecer el ámbito de registro predeterminado.
REST
No compatible.
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.
Console
Para crear un alcance de registro, haz lo siguiente:
-
En la consola de Google Cloud, ve a la páginasettings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
- Selecciona la pestaña Log Scopes y, luego, haz clic en Create log scope.
Para agregar uno o más proyectos, haz clic en Agregar proyectos y completa el diálogo.
Después de agregar un proyecto, tus roles de IAM en ese proyecto determinan qué entradas de registro puedes ver. Por ejemplo, tu rol de IAM podría permitirte ver solo aquellas entradas de registro a las que se puede acceder desde una vista de registro específica en un bucket de registros. Para obtener más información sobre los roles, consulta Roles de registro.
Para agregar una o más vistas de registro, haz clic en Agregar vistas de registro y completa el diálogo.
En el diálogo, se enumeran todas las vistas de registro que tienen entradas de registro que se originan en el proyecto actual o que un sink de otro proyecto enrutó al proyecto actual. Por ejemplo, si no configuraste ningún receptor, este diálogo enumera las vistas de registro de tu proyecto actual.
Para ver una lista de las vistas de registro almacenadas en otro proyecto de Google Cloud, haz clic en add_circle Importar proyecto y, luego, selecciona el proyecto de Google Cloud.
Después de agregar una vista de registro, tus roles de IAM en la vista de registro o en el proyecto que la almacena determinan a qué entradas de registro puedes acceder. Para obtener más información, consulta Controla el acceso a una vista de registros.
En la sección Nombre del alcance de registro, ingresa el nombre y la descripción que deseas que aparezcan en la pestaña Alcances de registro.
El nombre de un ámbito de registro no se puede modificar y debe ser único dentro del proyecto.
Haz clic en Crear alcance de registro.
gcloud
Para crear un alcance de registro en un proyecto, usa el comando
gcloud logging scopes create:gcloud logging scopes create LOG_SCOPE --project=PROJECT_ID \ --description=DESCRIPTION \ --resource-names=RESOURCE_NAMESAntes de ejecutar el comando, actualiza los siguientes campos:
- PROJECT_ID: Es el identificador del proyecto.
LOG_SCOPE: Es el nombre del alcance del registro. Por ejemplo,
my-scopeDESCRIPTION: Opcional Es la descripción del ámbito de registro. Da formato a la descripción como una cadena.
RESOURCE_NAMES: Es una lista separada por comas de los nombres completamente calificados de los proyectos o las vistas de registro. Por ejemplo, para incluir
my-projecten el alcance del registro, especificaprojects/my-project.
Terraform
Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform. Para obtener más información, consulta la documentación de referencia del proveedor de Terraform.
Para crear un alcance de registro en un proyecto, una carpeta o una organización con Terraform, usa el recurso de Terraform
google_logging_log_scope.En el comando, establece los siguientes campos:
parent: Es el nombre completamente calificado de tu proyecto, carpeta o organización. Por ejemplo, puedes establecer este campo en"projects/PROJECT_ID", en el que PROJECT_ID es el ID de tu proyecto de Google Cloud.locations: Configurado como"global".name: Se establece en el nombre completamente calificado del alcance del registro. Para proyectos, el formato de este campo es el siguiente:"projects/PROJECT_ID/locations/global/logScopes/LOG_SCOPE"En la expresión anterior, LOG_SCOPE es el nombre de un alcance de registro, como “producción”.
resource_names: Es un array de proyectos y vistas de registro, en el que cada proyecto y vista de registro se especifica con su nombre completamente calificado.description: Es una descripción breve. Por ejemplo, "Alcance de los recursos de producción".
REST
La API de Cloud Logging también admite la creación de permisos de registro en una carpeta o organización. Para obtener más información, consulta la documentación de referencia de la API.
Para proyectos de Google Cloud, usa el siguiente comando:
En el comando de la API, establece el campo
locationsenglobal.Modifica o borra un permiso de registro
Console
Para modificar o borrar un alcance de registro que tú o un colega crearon, haz lo siguiente:
-
En la consola de Google Cloud, ve a la páginasettings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
- Selecciona la pestaña Log Scopes.
Busca los alcances de registro que deseas modificar o borrar, haz clic en more_vert Más y, luego, realiza una de las siguientes acciones:
- Para modificarlo, selecciona Editar alcance y, luego, completa el diálogo.
- Para borrarlo, selecciona Borrar alcance y, luego, completa el cuadro de diálogo.
gcloud
Para modificar la descripción de la lista de recursos en un alcance de registro en un proyecto, usa el comando
gcloud logging scopes update:gcloud logging scopes update LOG_SCOPE --project=PROJECT_ID \ --description=DESCRIPTION \ --resource-names=RESOURCE_NAMESAntes de ejecutar el comando, actualiza los siguientes campos:
- PROJECT_ID: Es el identificador del proyecto.
LOG_SCOPE: Es el nombre del alcance del registro. Por ejemplo,
my-scopeDESCRIPTION: Es la descripción del permiso de registro. Da formato a la descripción como una cadena. Omite este campo cuando no quieras cambiar la descripción del alcance del registro.
RESOURCE_NAMES: Es una lista separada por comas de los nombres completamente calificados de los proyectos o las vistas de registro. Omite este campo cuando no quieras cambiar la lista de recursos.
Para borrar el alcance de un registro en un proyecto, usa el comando
gcloud logging scopes delete:gcloud logging scopes delete LOG_SCOPE --project=PROJECT_IDAntes de ejecutar el comando, actualiza los siguientes campos:
- PROJECT_ID: Es el identificador del proyecto.
- LOG_SCOPE: Es el nombre del alcance del registro.
Por ejemplo,
my-scope
Terraform
Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform. Para obtener más información, consulta la documentación de referencia del proveedor de Terraform.
Para modificar el alcance de un registro en un proyecto, una carpeta o una organización con Terraform, usa el recurso de Terraform
google_logging_log_scope.REST
La API de Cloud Logging contiene comandos que pueden modificar o borrar un alcance de registro. Para obtener una lista completa de los comandos, consulta la documentación de referencia de la API.
Para proyectos de Google Cloud, usa los siguientes comandos:
En el comando de la API, establece el campo
locationsenglobal.¿Qué sigue?
- Visualiza registros con el explorador de registros
- Cómo configurar vistas de registro en un bucket de registro
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-12-22 (UTC)