Configurar ámbitos de observabilidad

En este documento se describe cómo puede configurar un Google Cloud proyecto para monitorizar o mostrar datos de telemetría de varios Google Cloud proyectos. Si solo quiere monitorizar o ver los datos almacenados en un proyecto, no tiene que hacer ninguna configuración, ya que las herramientas de visualización y análisis están configuradas para usar los datos almacenados en el proyecto seleccionado en el selector de proyectos.Google Cloud Google Cloud Sin embargo, si los datos de telemetría que quiere ver o analizar proceden de varios proyectos, debe realizar algunas actividades de configuración para obtener una vista agregada de esos datos.

Acerca de los ámbitos de observabilidad

Las herramientas de análisis y visualización de Google Cloud Observability se basan en ámbitos específicos de cada tipo de datos para determinar qué datos se deben mostrar o analizar. Un ámbito define los recursos en los que se busca un tipo de datos concreto. A excepción de los datos de métricas, los roles de gestión de identidades y accesos (IAM) que tengas en los proyectos y las vistas de registro buscados determinan qué datos se muestran.

En el resto de esta sección se describen los ámbitos que puedes ver y configurar.

Ámbito de observabilidad

Este ámbito controla cómo buscan las páginas del explorador y del panel de control los datos que se van a mostrar. Cada Google Cloud proyecto contiene un único ámbito de observabilidad, que incluye el ámbito de registro predeterminado, el ámbito de métricas y el ámbito de traza predeterminado.

Recomendamos configurar los componentes del ámbito de observabilidad en los siguientes casos:

  • Las aplicaciones se registran en App Hub. Pueden ser aplicaciones que hayas registrado tú o que hayas implementado mediante el centro de diseño de aplicaciones.
  • Cuando quieras tener una vista unificada de los datos de telemetría almacenados en diferentes proyectos. Google Cloud

No es necesario que configure los componentes del ámbito de observabilidad de un proyecto. Si utilizas los valores predeterminados del sistema, ocurrirá lo siguiente:

  • La página Explorador de registros muestra los datos de registro que proceden del proyecto.
  • Las páginas Explorador de métricas y Explorador de trazas muestran los datos de métricas y trazas almacenados en el proyecto.
  • Las políticas de alertas monitorizan los datos de métricas almacenados en el proyecto.

Ámbitos de registro

Configura el ámbito de registro predeterminado de un proyecto para que, cuando abras la página Explorador de registros, se muestren los datos que sueles querer ver. Un ámbito de registro puede enumerar proyectos, carpetas, organizaciones y vistas de registro. Por ejemplo, puedes definir el ámbito de registro predeterminado para que muestre una vista de registro que, cuando se consulte, devuelva los datos de registro de una aplicación App Hub.

Puedes crear varios ámbitos de registro. Cuando usas la página Explorador de registros, puedes seleccionar otro ámbito de registro, lo que hace que la página busque los recursos que se incluyen en el ámbito seleccionado y, a continuación, actualice la pantalla.

Te recomendamos que configures el ámbito de registro predeterminado en los siguientes casos:

  • Enruta los datos de registro a un segmento de registro centralizado.
  • Enruta los datos de registro a otros proyectos o a segmentos de registro almacenados en otro proyecto.
  • Usas vistas de registro.

Para obtener más información, consulta Crear y gestionar ámbitos de registro.

Ámbito de las métricas

Configure el ámbito de las métricas para enumerar todos los proyectos que almacenan datos de métricas, de forma que sus gráficos y políticas de alertas puedan mostrar o monitorizar una vista agregada de sus datos de métricas.

Cada proyecto contiene un único ámbito de métricas, que, de forma predeterminada, solo muestra el proyecto. Google Cloud

Te recomendamos que configures el ámbito de las métricas cuando se cumpla alguna de las siguientes condiciones:

  • Quieres representar en un gráfico datos almacenados en diferentes proyectos.
  • Quieres que una política de alertas monitorice los datos almacenados en diferentes proyectos.
  • Las aplicaciones se registran en App Hub. Para obtener información sobre este caso, consulta Ámbitos de las métricas de los proyectos de gestión.

Para obtener más información, consulta el artículo Información general sobre los ámbitos de las métricas.

Permisos de trazas

Configura el ámbito de la traza predeterminado para que se muestren todos los proyectos que almacenan datos de traza. De esta forma, cuando abras la página Explorador de trazas, tendrás una vista agregada de tus datos de traza.

Puedes crear varios ámbitos de rastreo. Cuando usas la página Explorador de trazas, puedes seleccionar otro ámbito de traza, lo que hace que la página busque los proyectos que se incluyen en el ámbito seleccionado y, a continuación, actualice la pantalla.

Te recomendamos que configures los ámbitos de los rastreos cuando quieras tener una vista unificada de los datos de rastreo almacenados en diferentes proyectos.

Para obtener más información, consulta Crear y gestionar ámbitos de traza.

Configurar el ámbito de observabilidad

Esta sección no se aplica a carpetas ni organizaciones.

En el caso de los datos de registro y de traza, los roles de Gestión de Identidades y Accesos (IAM) que tengas en el proyecto que estés viendo, así como en los proyectos y las vistas de registro que hayas buscado, influyen en los datos que devuelve la consulta. Si envías una consulta para ver datos de registro para los que no tienes permiso, la consulta no devuelve ningún dato de registro.

En el caso de los datos de métricas, cuando se configura el ámbito de las métricas de un proyecto, se le concede acceso de lectura a los datos de métricas almacenados por los proyectos que se incluyen en su ámbito de métricas. Cuando se concede a un usuario un rol de gestión de identidades y accesos que le permite ver datos de métricas en un proyecto, puede ver los datos de métricas disponibles en el proyecto.

Antes de empezar

  1. 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.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.

  8. Para obtener los permisos que necesitas para crear y ver ámbitos, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos:

    • Para crear y ver ámbitos de registro, y para obtener el ámbito de registro predeterminado, haz lo siguiente: Escritor de configuración de registros (roles/logging.configWriter) en tu proyecto
    • Para modificar un ámbito de las métricas, haga lo siguiente: Administrador de Monitoring (roles/monitoring.admin) en su proyecto y en cada proyecto que quiera añadir a los ámbitos de las métricas.
    • Para crear y ver ámbitos de rastreo, así como para obtener y definir ámbitos predeterminados, sigue estos pasos: Editor de ámbitos de observabilidad (roles/observability.scopesEditor) en tu proyecto

    Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

    También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

    El rol Editor de ámbitos de observabilidad incluye permisos privados que te permiten crear y ver ámbitos de traza. Estos permisos no se pueden incluir en roles de IAM personalizados.

  9. 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.

    REST

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

      Instala Google Cloud CLI. Después de la instalación, inicializa la CLI de Google Cloud ejecutando el siguiente comando: 

      gcloud init

      Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

    Para obtener más información, consulta el artículo Autenticarse para usar REST de la documentación sobre autenticación de Google Cloud .

    Ver y definir el ámbito predeterminado

    Consola

    Para configurar el ámbito de observabilidad, debe configurar sus componentes, que son el ámbito de registro predeterminado, el ámbito de métricas y el ámbito de seguimiento predeterminado:

    1. En la Google Cloud consola, ve a la página  Configuración:

      Ve a Configuración.

      Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

    2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

    3. Configura el ámbito de registro predeterminado:

      1. Selecciona la pestaña Ámbitos de registro.

        Se muestra una lista de los ámbitos de registro. La entrada con el icono "Predeterminado", , es el ámbito de registro predeterminado. Si quieres crear un ámbito de registro, haz clic en Crear ámbito de registro y completa el cuadro de diálogo. Para obtener más información, consulta Crear y gestionar ámbitos de registro.

      2. Busca la entrada que quieras designar como predeterminada, haz clic en  Más y, a continuación, selecciona Establecer como predeterminado.

    4. Configura el ámbito de las métricas:

      1. Selecciona la pestaña de ámbito de las métricas.
      2. En el panel Proyectos de Google Cloud, haz clic en Añadir proyectos y, a continuación, completa el cuadro de diálogo. Para obtener más información, consulta Configurar ámbitos de métricas.

    5. Configura el ámbito de la traza predeterminado:

      1. Selecciona la pestaña Ámbitos de traza y, a continuación, haz lo siguiente:

        Se muestra una lista de los ámbitos de traza. La entrada con el icono "Predeterminado", , es el ámbito de seguimiento predeterminado. Si quieres crear un ámbito de seguimiento, haz clic en Crear ámbito de registro y, a continuación, completa el cuadro de diálogo. Para obtener más información, consulta Crear y gestionar ámbitos de traza.

      2. Busca la entrada que quieras designar como predeterminada, haz clic en  Más y, a continuación, selecciona Establecer como predeterminado.

    gcloud

    Para ver y definir el ámbito de observabilidad, haga lo siguiente:

    1. Para ver los ajustes del ámbito de observabilidad, ejecuta el comando gcloud observability scopes describe.

      Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:

      • OBSERVABILITY_SCOPE_ID: nombre de un objeto Scope. Este valor debe ser _Default.
      • LOCATION: el campo de ubicación debe tener el valor global.
      • PROJECT_ID: identificador del proyecto.

      Ejecuta el comando gcloud observability scopes describe:

      Linux, macOS o Cloud Shell

      gcloud observability scopes describe OBSERVABILITY_SCOPE_ID \
   --location=LOCATION\
   --project=PROJECT_ID

      Windows (PowerShell)

      gcloud observability scopes describe OBSERVABILITY_SCOPE_ID `
   --location=LOCATION`
   --project=PROJECT_ID

      Windows (cmd.exe)

      gcloud observability scopes describe OBSERVABILITY_SCOPE_ID ^
   --location=LOCATION^
   --project=PROJECT_ID

      La respuesta al comando es similar a la siguiente: 

      logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default
traceScope: projects/my-project/locations/global/traceScopes/_Default
name: projects/my-project/locations/global/scopes/_Default

    2. Para actualizar el ámbito de observabilidad, ejecuta el comando gcloud observability scopes update. En el comando update, puedes incluir la marca --log-scope para actualizar el ámbito de registro predeterminado.

      Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:

      • OBSERVABILITY_SCOPE_ID: nombre de un objeto Scope. Este valor debe ser _Default.
      • LOG_SCOPE_FQN_ID: ID completo del ámbito del registro. Este campo tiene el siguiente formato: 
        logging.googleapis.com/projects/PROJECT_ID/locations/LOCATION/logScopes/LOG_SCOPE_ID

        En la expresión anterior, LOG_SCOPE_ID es el ID del ámbito del registro. Por ejemplo, my-scope.

      • LOCATION: el campo de ubicación debe tener el valor global.
      • PROJECT_ID: identificador del proyecto.

      Ejecuta el comando gcloud observability scopes update:

      Linux, macOS o Cloud Shell

      gcloud observability scopes update OBSERVABILITY_SCOPE_ID \
   --log-scope=LOG_SCOPE_FQN_ID\
   --location=LOCATION\
   --project=PROJECT_ID

      Windows (PowerShell)

      gcloud observability scopes update OBSERVABILITY_SCOPE_ID `
   --log-scope=LOG_SCOPE_FQN_ID`
   --location=LOCATION`
   --project=PROJECT_ID

      Windows (cmd.exe)

      gcloud observability scopes update OBSERVABILITY_SCOPE_ID ^
   --log-scope=LOG_SCOPE_FQN_ID^
   --location=LOCATION^
   --project=PROJECT_ID

      Por ejemplo, si el valor de LOG_SCOPE_ID es my-scope, la respuesta será similar a la siguiente: 

      Updated scope [_Default].
logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/my-scope
name: projects/my-project/locations/global/scopes/_Default

    REST

    Para obtener y definir el ámbito de registro predeterminado o el ámbito de seguimiento predeterminado mediante una llamada a la API, configura el ámbito de observabilidad. En el ámbito de observabilidad se muestran el ámbito de registro predeterminado y el ámbito de traza predeterminado:

    • Para obtener el ámbito de observabilidad predeterminado de un proyecto, envía una solicitud al punto de conexión projects.locations.scopes.get. Debe especificar un parámetro de ruta. La respuesta es un objeto Scope que muestra el ámbito de registro predeterminado y el ámbito de seguimiento predeterminado.

    • Para actualizar el ámbito de observabilidad predeterminado de un proyecto, envía una solicitud al endpoint projects.locations.scopes.patch. Debe especificar un parámetro de ruta, parámetros de consulta y un objeto Scope. Los parámetros de consulta identifican qué campos se han modificado. La respuesta es un objeto Scope.

    El parámetro de ruta de ambos endpoints tiene el siguiente formato:

    projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID

    Los campos de la expresión anterior tienen el siguiente significado:

    • PROJECT_ID: identificador del proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.
    • LOCATION: el campo de ubicación debe tener el valor global.
    • OBSERVABILITY_SCOPE_ID: nombre de un objeto Scope. Este campo debe tener el valor _Default. El objeto Scope con el nombre _Default, que se crea automáticamente, almacena información sobre el ámbito de registro predeterminado y el ámbito de seguimiento predeterminado.

    Para enviar un comando a un endpoint de la API, puedes usar Explorador de APIs, que te permite enviar un comando desde una página de referencia. Por ejemplo, para obtener el ámbito predeterminado actual, puedes hacer lo siguiente:

    1. Haz clic en projects.locations.scopes.get.

    2. En el widget Prueba este método, introduce lo siguiente en el campo name (nombre): 

      projects/PROJECT_ID/locations/global/scopes/_Default

      Antes de copiar el campo anterior, sustituye PROJECT_ID por el nombre de tu proyecto.

    3. Selecciona Ejecutar.

    4. En el cuadro de diálogo de autorización, completa los pasos necesarios.

      La respuesta es similar a la siguiente:

      {
"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"
}