En este documento, se describe cómo puedes crear y administrar un alcance de seguimiento, lo que permite que la página del Explorador de seguimiento encuentre los intervalos de seguimiento que deseas ver o analizar. Si solo deseas ver y analizar los intervalos que se originan en tu proyecto Google Cloud , no necesitas configurar ningún permiso de seguimiento. Sin embargo, si tus datos de seguimiento se almacenan en varios proyectos, como podría ocurrir cuando usas una arquitectura de microservicios, debes realizar algunas actividades de configuración para ver todos los tramos de un solo proyecto Google Cloud .
En este documento, no se describe cómo ver tus registros y períodos. Para obtener más información sobre ese tema, consulta Busca y explora seguimientos.
Esta función solo se admite para proyectos de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
Acerca de los permisos de seguimiento
Los permisos de seguimiento son recursos persistentes a nivel del proyecto que enumeran un conjunto de Google Cloud proyectos. Puedes configurar la página del Explorador de seguimiento para que realice búsquedas por permiso de seguimiento, lo que significa que la página buscará los proyectos que se enumeran en el permiso seleccionado. Tus roles de Identity and Access Management (IAM) en los proyectos buscados y la configuración del período determinan qué datos se recuperan del almacenamiento y, luego, se muestran.
Cuando creas un proyecto Google Cloud , se crea un permiso de seguimiento llamado _Default
. Este permiso solo incluye el proyecto Google Cloud . No puedes agregar proyectos a este permiso ni borrarlo.
Puedes crear ámbitos de seguimiento, así como modificar y borrar los que crees. Quieres crear un alcance de seguimiento cuando tienes un servicio que escribe datos de intervalos en varios proyectos de Google Cloud .
A menos que abras la página del Explorador de seguimiento con una URL que incluya un permiso de seguimiento o un ID de seguimiento y de intervalo, la página del Explorador de seguimiento buscará datos de seguimiento en los proyectos deGoogle Cloud que se indican en el permiso de seguimiento predeterminado.
Cuando creas tu proyecto, el permiso de seguimiento llamado _Default
se establece como el permiso de seguimiento predeterminado. Sin embargo, puedes seleccionar un alcance de registro diferente para usarlo como el alcance de registro predeterminado.
Aplicaciones de App Hub y permisos de seguimiento
Tus aplicaciones de App Hub pueden escribir datos de seguimiento en varios proyectos. Para obtener una vista agregada de estos datos, crea un permiso de seguimiento, configúralo para que muestre todos los proyectos que almacenan tus datos de seguimiento y, luego, configúralo como el permiso de seguimiento predeterminado. Cuando completes esos pasos, la página Trace Explorer mostrará automáticamente los datos que escribió tu aplicación, incluso cuando esos datos se almacenen en diferentes proyectos.
Crea el alcance de seguimiento personalizado en el proyecto desde el que verás tus datos de registro. Este proyecto es tu proyecto host de App Hub o el proyecto de administración de tu carpeta habilitada para apps.
Por ejemplo, si el nombre visible de la carpeta es My Folder
, el nombre visible del proyecto de administración es My Folder-mp
.
Antes de comenzar
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the Observability API.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the Observability API.
-
Para obtener los permisos que necesitas para crear y ver ámbitos de seguimiento, pídele a tu administrador que te otorgue el rol de IAM de Editor de ámbitos de observabilidad (
roles/observability.scopesEditor
) en tu proyecto. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
El rol de editor de Observability Scopes incluye permisos privados que te permiten crear y ver ámbitos de seguimiento. Estos permisos no están disponibles para su inclusión en roles de IAM personalizados.
-
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.
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 proporciones a gcloud CLI.
Instala Google Cloud CLI. Después de la instalación, inicializa Google Cloud CLI ejecutando el siguiente comando:
gcloud init
Si usas un proveedor de identidad externo (IdP), primero debes acceder a gcloud CLI con tu identidad federada.
Para obtener más información, consulta Autentícate para usar REST en la documentación de autenticación de Google Cloud .
Enumera los permisos de seguimiento
Console
Para enumerar los permisos de seguimiento, haz lo siguiente:
-
En la consola de Google Cloud , ve a la página settings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
- En la barra de herramientas de la consola de Google Cloud , selecciona tu proyecto de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
Selecciona la pestaña Trace Scopes.
En la tabla, se enumeran tus ámbitos de seguimiento. Cuando seleccionas un Google Cloud proyecto, se muestra una entrada con un ícono de "Predeterminado",
, que indica que es el alcance de seguimiento predeterminado. Cuando se abre la página del Explorador de Trace, se buscan datos de seguimiento en los proyectos que se indican en el permiso de seguimiento predeterminado.
gcloud
No compatible.
REST
Para enumerar todos los ámbitos de seguimiento en un proyecto de Google Cloud , usa el comando
projects.locations.traceScopes.list
. Debes especificar un parámetro de ruta de acceso.El parámetro de ruta de acceso para este extremo tiene la siguiente sintaxis:
projects/PROJECT_ID/locations/LOCATION_ID/traceScopes
Los campos de la expresión anterior tienen el siguiente significado:
- PROJECT_ID: Es el identificador del proyecto. Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
- LOCATION_ID debe establecerse en
global
.
La respuesta es un array de objetos
TraceScope
. Cada objeto incluye un nombre y una lista de recursos.Para obtener información sobre un alcance de registro específico, usa el comando
projects.locations.traceScopes.get
.Crea un permiso de Trace
Los intervalos que se muestran en la página del Explorador de seguimientos dependen de los proyectos en los que se realizó la búsqueda, tus roles de IAM en esos proyectos, el parámetro de configuración del período y los filtros que apliques.
Puedes crear 100 permisos de seguimiento por proyecto. Un alcance de seguimiento puede incluir un total de 20 proyectos.
Console
Para crear un alcance de seguimiento, haz lo siguiente:
-
En la consola de Google Cloud , ve a la página settings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
- En la barra de herramientas de la consola de Google Cloud , selecciona tu proyecto de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
- Selecciona la pestaña Trace Scopes y, luego, haz clic en Create trace scope.
Haz clic en Agregar proyectos y completa el diálogo.
Si no sabes qué proyectos incluir en un permiso, puedes usar la página heredada del Explorador de registros para ayudarte a identificarlos. Para obtener más información, consulta la sección Migra a los ámbitos de seguimiento de este documento.
En la sección Name trace scope, ingresa el nombre y la descripción que deseas que se muestren en la pestaña Trace Scopes.
El nombre de un alcance de seguimiento no se puede modificar y debe ser único dentro del proyecto.
Haz clic en Create trace scope.
gcloud
No compatible.
REST
Para crear un alcance de seguimiento, usa el comando
projects.locations.traceScopes.create
. Debes especificar un parámetro de ruta de acceso y proporcionar un objetoTraceScope
. La respuesta es un objetoTraceScope
.El parámetro de ruta de acceso para este extremo tiene la siguiente sintaxis:
projects/PROJECT_ID/locations/LOCATION_ID/traceScopes
Los campos de la expresión anterior tienen el siguiente significado:
- PROJECT_ID: Es el identificador del proyecto. Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
- LOCATION_ID debe establecerse en
global
.
Migra a permisos de seguimiento
La página Explorador de Trace requiere que especifiques los proyectosGoogle Cloud en los que se buscarán datos de seguimiento, lo que representa un cambio en el comportamiento de la página heredada Explorador de Trace. La página heredada del Explorador de registros busca en todos los proyectos de una organización. Debido a estas diferencias, es posible que la página del Explorador de seguimiento no muestre los intervalos que sí muestra la página heredada del Explorador de seguimiento.
Puedes usar la sección del panel Detalles del seguimiento de la página heredada del Explorador de seguimientos para ayudarte a compilar una lista deGoogle Cloud proyectos que almacenan tus datos de seguimiento:
Ve a la página heredada del Explorador de seguimiento:
En la barra de herramientas de la consola de Google Cloud , selecciona tu proyecto de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
Selecciona un registro.
Puedes probar lo siguiente:
- Ver un registro ingresando su ID en el campo ID de registro
- Agrega filtros.
En el panel Detalles de seguimiento, selecciona el seguimiento y, luego, ve a la pestaña Proyectos.
En esta pestaña, se enumeran los proyectos que almacenan intervalos para el registro.
Para crear un alcance de seguimiento que contenga los proyectos enumerados, ve a la barra de herramientas de la pestaña Proyectos, selecciona Crear alcance con estos proyectos y, luego, completa el diálogo.
Repite los pasos anteriores hasta que compiles una lista de proyectos.
Después de compilar una lista de proyectos, crea un permiso de seguimiento. También puedes establecerlo como el alcance de seguimiento predeterminado.
Cómo modificar o borrar un alcance de seguimiento
No puedes borrar ni modificar el permiso de registro llamado
_Default
. Puedes modificar o borrar todos los demás ámbitos de seguimiento.Console
Para modificar o borrar un alcance de la función de registro, haz lo siguiente:
-
En la consola de Google Cloud , ve a la página settings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
- En la barra de herramientas de la consola de Google Cloud , selecciona tu proyecto de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
- Selecciona la pestaña Trace Scopes.
Busca el alcance del 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 diálogo.
gcloud
No compatible.
REST
Cómo modificar un permiso
Para modificar un alcance de seguimiento, usa el comando
projects.locations.traceScopes.patch
. Debes especificar un parámetro de ruta y parámetros de búsqueda, y proporcionar un objetoTraceScope
. Los parámetros de consulta identifican qué campos se modificaron. La respuesta es un objetoTraceScope
.El parámetro de ruta de acceso para este extremo tiene la siguiente sintaxis:
projects/PROJECT_ID/locations/LOCATION_ID/traceScopes/TRACE_SCOPE_NAME
Los campos de la expresión anterior tienen el siguiente significado:
- PROJECT_ID: Es el identificador del proyecto. Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
- LOCATION_ID debe establecerse en
global
. - TRACE_SCOPE_NAME: Es el nombre de un permiso de seguimiento. Por ejemplo,
my-trace-scope
Borra un permiso
Para borrar un alcance de seguimiento, usa el comando
projects.locations.traceScopes.delete
. Debes especificar un parámetro de ruta de acceso.El parámetro de ruta de acceso para este extremo tiene la siguiente sintaxis:
projects/PROJECT_ID/locations/LOCATION_ID/traceScopes/TRACE_SCOPE_NAME
Los campos de la expresión anterior tienen el siguiente significado:
- PROJECT_ID: Es el identificador del proyecto. Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
- LOCATION_ID debe establecerse en
global
. - TRACE_SCOPE_NAME: Es el nombre de un permiso de seguimiento. Por ejemplo,
my-trace-scope
Configura el alcance de seguimiento predeterminado
Cuando se abre la página del Explorador de Trace, se buscan datos de seguimiento en los proyectos que se indican en el permiso de seguimiento predeterminado. Si no se puede acceder a ese alcance de la traza, se buscarán datos de la traza en tu proyecto.
Cuando se crean proyectos, se crea el permiso de seguimiento llamado
_Default
y se designa como el permiso de seguimiento predeterminado. Sin embargo, puedes crear tu propio alcance de seguimiento y designarlo como el alcance de seguimiento predeterminado.Console
Para establecer el alcance del registro predeterminado, haz lo siguiente:
-
En la consola de Google Cloud , ve a la página settings Configuración:
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.
- En la barra de herramientas de la consola de Google Cloud , selecciona tu proyecto de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
Selecciona la pestaña Trace Scopes.
En la pestaña, se muestran tus ámbitos de seguimiento y se incluye un botón para crear un ámbito de seguimiento personalizado. El alcance de seguimiento que se muestra con un ícono "Predeterminado",
, es el alcance de seguimiento predeterminado actual.
Para cambiar el alcance de seguimiento predeterminado, busca el alcance de seguimiento que quieras designar como predeterminado, haz clic en su more_vert Más y, luego, selecciona Establecer como predeterminado.
El alcance de la ruta que seleccionaste se muestra con un ícono "Predeterminado",
.
gcloud
No compatible.
REST
Para obtener y establecer el permiso de registro predeterminado o el permiso de seguimiento predeterminado con una llamada a la API, debes configurar el permiso de observabilidad. El alcance de observabilidad enumera el alcance de registros predeterminado y el alcance de seguimiento predeterminado:
Para obtener el permiso de observabilidad predeterminado de un proyecto, envía una solicitud al extremo
projects.locations.scopes.get
. Debes especificar un parámetro de ruta de acceso. La respuesta es un objetoScope
, que enumera el alcance del registro predeterminado y el alcance del registro de seguimiento predeterminado.Para actualizar el permiso de observabilidad predeterminado de un proyecto, envía una solicitud al extremo
projects.locations.scopes.patch
. Debes especificar un parámetro de ruta, parámetros de búsqueda y proporcionar un objetoScope
. Los parámetros de consulta identifican qué campos se cambiaron. La respuesta es un objetoScope
.
El parámetro de ruta de acceso para ambos extremos tiene la siguiente forma:
projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID
Los campos de la expresión anterior tienen el siguiente significado:
- PROJECT_ID: Es el identificador del proyecto. Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
- LOCATION: El campo de ubicación debe establecerse en
global
. - OBSERVABILITY_SCOPE_ID: Es el nombre de un objeto
Scope
. Este campo debe establecerse en_Default
. El objetoScope
con el nombre_Default
, que se crea automáticamente, almacena información sobre el alcance del registro predeterminado y el alcance del registro de seguimiento predeterminado.
Para enviar un comando a un extremo de API, puedes usar el Explorador de APIs, que te permite emitir un comando desde una página de referencia. Por ejemplo, para obtener el alcance predeterminado actual, puedes hacer lo siguiente:
- Haz clic en
projects.locations.scopes.get
. En el widget Try this method, ingresa lo siguiente en el campo name:
projects/PROJECT_ID/locations/global/scopes/_Default
Antes de copiar el campo anterior, reemplaza PROJECT_ID por el nombre de tu proyecto.
Selecciona Ejecutar.
En el cuadro de diálogo de autorización, completa los pasos necesarios.
La respuesta es similar al ejemplo a continuación:
{ "name": "projects/my-project/locations/global/scopes/_Default", "logScope": "logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default" "traceScope": "projects/my-project/locations/global/traceScopes/_Default" }
Límites de los permisos de seguimiento
Límites de los permisos de seguimiento Valor Cantidad máxima de ámbitos de seguimiento por proyecto 100 Cantidad máxima de proyectos por permiso de seguimiento 20 ¿Qué sigue?
Cloud Logging y Cloud Monitoring contienen construcciones similares que te permiten controlar los datos de registro o los datos de métricas que puedes ver o supervisar. Para obtener información sobre esos permisos, consulta los siguientes documentos:
-