Guarda y comparte consultas

Las estadísticas de observabilidad te permiten guardar y compartir consultas en SQL para que puedas volver a ejecutar investigaciones frecuentes de Cloud Trace y colaborar con los miembros del equipo en todo tu proyecto. Las consultas guardadas pueden mantenerse privadas para tu uso personal o compartirse con otros miembros del proyecto. Si no escribiste consultas en Observability Analytics, primero consulta Cómo consultar y analizar seguimientos.

Antes de comenzar

Configura tu proyecto y tus roles de IAM, y selecciona la interfaz que planeas usar.

Configura tu proyecto y tus roles

  1. Accede a tu cuenta de Google Cloud . Si es la primera vez que usas Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

  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 role (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, if it is not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). 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 role (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, if it is not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

    8.

  8. Para obtener los permisos que necesitas para cargar la página Observability Analytics, escribir, ejecutar y guardar consultas privadas en tus datos de seguimiento, pídele a tu administrador que te otorgue los siguientes roles de IAM:

    • Usuario con acceso a vistas de observabilidad (roles/observability.viewAccessor) en las vistas de observabilidad que deseas consultar. Este rol admite condiciones de IAM, que te permiten restringir el otorgamiento a una vista específica. Si no adjuntas una condición al otorgamiento del rol, la principal podrá acceder a todas las vistas de observabilidad.
    • Usuario de Observability Analytics (roles/observability.analyticsUser) en tu proyecto Este rol contiene los permisos necesarios para guardar y ejecutar consultas privadas, y para ejecutar consultas compartidas.

    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.

Selecciona la interfaz que planeas usar

Console

Cuando usas la consola de Google Cloud para acceder a los servicios y las APIs de Google Cloud , no necesitas configurar la autenticación.

gcloud

En la consola de Google Cloud , activa Cloud Shell.

Activa Cloud Shell

En la parte inferior de la consola de Google Cloud , se inicia una sesión de Cloud Shell en la que se muestra una ventana de línea de comandos. Cloud Shell es un entorno de shell con Google Cloud CLI ya instalada y con valores ya establecidos para el proyecto actual. La sesión puede tardar unos segundos en inicializarse.

REST

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

    Instala Google Cloud CLI.

    Si usas un proveedor de identidad externo (IdP), primero debes acceder a la 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 .

Guarda una consulta

Todas las consultas que ejecutas se guardan automáticamente durante 30 días y puedes acceder a ellas seleccionando la pestaña Recientes en la página Observability Analytics. Puedes buscar, ver, ejecutar y compartir las consultas que se enumeran en la pestaña Recientes.

Para volver a usar una consulta, agregar descripciones personalizadas o compartirla con tus compañeros de equipo, guárdala. Puedes buscar y ordenar tus consultas guardadas por nombre, descripción y etiqueta de visibilidad. También puedes editar y borrar estas búsquedas. Las búsquedas que guardes se conservarán hasta que las borres.

Puedes guardar 10,000 consultas por proyecto de Google Cloud .

Console

Para guardar una consulta, haz lo siguiente:

  1. En la Google Cloud consola, ve a la página Estadísticas de observabilidad:

    Ir a Estadísticas de observabilidad

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Logging.

  2. Propaga el panel Consulta con una consulta.

    Puedes completar el panel Consulta ingresando una consulta nueva, seleccionando una consulta en la pestaña Recientes o seleccionando una consulta en la pestaña Guardadas.

    Tu consulta puede incluir cualquier vista válida, varias vistas y vistas de Analytics.

    Cuando la consulta en el panel Consulta es válida, se habilita el botón Guardar.

  3. Haz clic en Guardar, selecciona Guardar consulta y completa los campos Nombre y Descripción. Los valores que establezcas para estos campos se mostrarán en la pestaña Guardado.

  4. Opcional: Para permitir que todos los usuarios con acceso a la página Observability Analytics de la vista del proyecto Google Cloud ejecuten tu consulta guardada, habilita el botón de activación Compartir con el proyecto.

    De forma predeterminada, este botón de activación está inhabilitado y la visibilidad está restringida a ti.

  5. Haz clic en Guardar consulta.

  6. Opcional: Para ver, ordenar y ejecutar las consultas guardadas que son visibles para ti, selecciona la pestaña Guardadas.

    Puedes ordenar y filtrar tus consultas guardadas por nombre, descripción y etiqueta de visibilidad. También puedes filtrar por el contenido de la búsqueda.

Puedes editar y borrar las consultas que creaste con las opciones de la pestaña Guardadas:

  • Para editar una búsqueda, haz clic en Más opciones y selecciona Editar. Puedes modificar los valores de los campos Nombre y Descripción. Sin embargo, la consulta en sí no se puede modificar.

  • Para borrar una consulta guardada, haz clic en Más opciones y selecciona Borrar.

gcloud

Para crear y guardar una consulta, haz lo siguiente:

  1. Antes de usar cualquiera de los datos de comando a continuación, haz los siguientes reemplazos:

    • DISPLAY_NAME: Es el nombre visible de la consulta guardada.
    • LOCATION: Es la ubicación de la consulta guardada.
    • VISIBILITY: Se establece en private o en shared.
    • SQL_QUERY: Una consulta de SQL. Si las comillas inversas simples (`) encierran la ruta o los campos dentro de la ruta, debes incluir un carácter de escape para esas comillas inversas: 
          "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"

      o

          "SELECT * FROM \`PROJECT_ID.LOCATION._Trace.Spans._AllSpans\`"

      Se requieren comillas inversas (`) cuando un elemento de ruta de acceso contiene un carácter de punto (.).

    • ID: Es el ID de la consulta guardada. Este ID es una entrada obligatoria para los comandos que describen, actualizan o borran una consulta guardada. Si no proporcionas el ID cuando creas una consulta guardada, el sistema generará un ID numérico.
    • DESCRIPTION: Es una descripción textual de la búsqueda. Es opcional.
    • PROJECT_ID: Es el identificador del proyecto.

    Ejecuta el comando gcloud logging saved-queries create:

    Linux, macOS o Cloud Shell

    gcloud logging saved-queries create --display-name=DISPLAY_NAME \
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY \
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (PowerShell)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME `
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY `
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (cmd.exe)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME ^
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY ^
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    A continuación, se muestra un ejemplo de respuesta cuando el ID proporcionado en el comando era my-saved-query:

    Created saved query [projects/PROJECT_ID/locations/LOCATION/savedQueries/my-saved-query].

    La respuesta al comando create enumera el nombre completo de la búsqueda, que incluye su ID. El ID de la consulta, que en este ejemplo es my-saved-query, es una entrada obligatoria para los comandos de Google Cloud CLI que describen, borran o actualizan una consulta guardada.

  2. Para inspeccionar la consulta guardada, ejecuta el siguiente comando:

     gcloud logging saved-queries list --location=- --project=PROJECT_ID

    En la expresión anterior, el valor de la ubicación es un guion (-), que actúa como comodín. También puedes proporcionar una ubicación específica.

Existen comandos de Google Cloud CLI para borrar, enumerar, describir y actualizar las consultas guardadas. Para obtener más información, consulta la descripción general de gcloud logging saved-queries.

REST

Puedes guardar una consulta con la API de Cloud Logging. Para guardar una búsqueda, usa el método savedQueries.create.

Para ejecutar este método, haz lo siguiente:

  1. Selecciona savedQueries.create.
  2. En la página de referencia, usa el Explorador de APIs para emitir un comando. Debes especificar el campo opsAnalyticsQuery.

En el siguiente ejemplo, se ilustra un cuerpo de solicitud de muestra que contiene una instancia de SavedQuery:

{
   "parent": "projects/my-project/locations/global"
   "saved_query":
   {
      "ops_analytics_query":
      {
         "sql_query_text" :
            "SELECT
            timestamp, log_name, severity, json_payload, resource, labels
            FROM
            `VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
   "visibility": "PRIVATE"
   }
}

Cómo compartir una búsqueda

Puedes compartir una consulta guardada con todas las personas que tengan acceso a tu proyecto deGoogle Cloud . Sin embargo, los roles de IAM de la principal determinan si se puede ejecutar la consulta y los datos que devuelve.

Console

Cuando solucionas un problema o ves resultados anómalos, es posible que desees compartir una búsqueda y sus resultados con un compañero de equipo. Cuando veas los resultados de la consulta en la página Observability Analytics, podrás copiar una URL que, cuando se abra, mostrará la consulta que ejecutaste y sus resultados.

Para compartir una consulta y sus resultados con un compañero de equipo, haz lo siguiente:

  1. En la Google Cloud consola, ve a la página Estadísticas de observabilidad:

    Ir a Estadísticas de observabilidad

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Logging.

  2. Propaga el panel Consulta con una consulta y, luego, haz clic en Ejecutar consulta.

    Puedes completar el panel Consulta ingresando una consulta nueva, seleccionando una consulta en la pestaña Recientes o seleccionando una consulta en la pestaña Guardadas.

  3. Haz clic en Compartir vínculo.

  4. Envía el vínculo a tu compañero de equipo.

    Cuando tu compañero de equipo abra el vínculo, se abrirá y mostrará la página Estadísticas de observabilidad, pero no se ejecutará la consulta. Tu compañero de equipo debe ejecutar la consulta de forma manual.

    La página Observability Analytics muestra un diálogo de advertencia cuando la consulta se ejecuta en el motor de BigQuery y los recursos consultados no se encuentran en el mismo límite de propiedad. Los límites de propiedad se determinan según varios factores, uno de los cuales es la jerarquía de los recursos que usa la búsqueda.

    Para abrir la URL correctamente, el rol de IAM de tu compañero de equipo en el proyecto Google Cloud debe incluir los permisos necesarios para ver la página Observability Analytics.

gcloud

Cuando quieras crear una consulta guardada que puedan ejecutar otras personas, establece el valor del campo visibility en shared:

--visibility=shared

Para cambiar la visibilidad de una consulta guardada existente, usa el comando update. Para obtener más información sobre los comandos disponibles, consulta la descripción general de gcloud logging saved-queries.

REST

Puedes usar la API de Logging para crear una consulta compartida con el método savedQueries.create y especificar un valor de SHARED en el campo visibility. Para obtener más información, consulta la página de referencia de savedQueries.create.

Cómo ver y ejecutar consultas recientes o guardadas

Para ver o volver a ejecutar una consulta, selecciona la pestaña Recientes en la página Observability Analytics y busca la consulta:

  • Para ejecutar la consulta, haz clic en Ejecutar.
  • Para ver la consulta, usa las opciones del menú Más opciones.

Para ver, editar o ejecutar una consulta guardada, selecciona la pestaña Guardadas en la página Observability Analytics y busca la consulta:

  • Para ejecutar la consulta, haz clic en Ejecutar.
  • Para editar, ver o borrar la búsqueda, usa las opciones del menú Más opciones.

¿Qué sigue?