Cómo guardar y compartir consultas de SQL

Las Estadísticas de observabilidad te permiten guardar y compartir consultas en SQL para que puedas volver a ejecutar investigaciones frecuentes de Cloud Logging y colaborar con los miembros del equipo en todo tu proyecto. Puedes mantener las consultas guardadas privadas para tu propio uso o compartirlas con otros miembros del proyecto.

Si no escribiste consultas en Estadísticas de observabilidad, primero consulta Consulta y analiza registros. Para aprender a graficar los resultados de tus consultas y guardar esos gráficos en un panel personalizado, consulta Grafica los consulta en SQL SQL.

Diferencias entre las consultas guardadas y las vistas de análisis

Una consulta guardada es una consulta que ejecutas con la página Estadísticas de observabilidad y, luego, guardas como una consulta. La acción de guardar te permite volver a ejecutar esta consulta cuando lo desees. Cuando guardas la consulta, tienes la opción de hacerla privada o visible para otras personas que tengan los permisos necesarios para usar Estadísticas de observabilidad. No puedes escribir una consulta en SQL en la que la cláusula FROM especifique una consulta guardada.

Una vista de análisis contiene una consulta que puedes volver a ejecutar cuando quieras. Para crear una vista de análisis, escribe una consulta en SQL en una vista de registro y, luego, guarda el resultado como una vista. A diferencia de las consultas guardadas, no puedes hacer que una vista de estadísticas sea privada para ti. Puedes consultar una vista de análisis. Esta capacidad te permite transformar tus datos de registro del formato LogEntry en otro formato que sea más adecuado para ti. Luego, en lugar de escribir tus consultas en una vista de registro, consultas la vista de análisis.

Puedes guardar consultas que consulten una vista de registro o una vista de análisis.

Antes de comenzar

En esta sección, se describen los pasos que debes completar antes de poder usar las Estadísticas de observabilidad.

Configura buckets de registros

Asegúrate de que tus buckets de registros se hayan actualizado para usar Estadísticas de observabilidad:

  1. En la consola de Google Cloud , ve a la página Explorador de registros:

    Ir al Almacenamiento de registros

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

  2. Para cada bucket de registros que tenga una vista de registro que quieras consultar, asegúrate de que la columna Estadísticas de observabilidad disponibles muestre Abrir. Si se muestra Actualizar, haz clic en Actualizar y completa el diálogo.

Configura roles y permisos de IAM

En esta sección, se describen los roles o permisos de IAM que se requieren para usar las Estadísticas de observabilidad:

  • Para obtener los permisos que necesitas para usar las Estadísticas de observabilidad y consultar las vistas de registro, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

    Puedes restringir una principal a una vista de registro específica agregando una condición de IAM al otorgamiento del rol de descriptor de acceso a la vista de registros realizado a nivel del proyecto o agregando una vinculación de IAM al archivo de política de la vista de registro. Para obtener más información, consulta Controla el acceso a una vista de registros.

    Estos son los mismos permisos que necesitas para ver las entradas de registro en la página del Explorador de registros. Para obtener información sobre los roles adicionales que necesitas para consultar vistas en buckets definidos por el usuario o para consultar la vista _AllLogs del bucket de registros _Default, consulta Roles de Cloud Logging.

  • Para obtener los permisos que necesitas para consultar vistas de análisis, pídele a tu administrador que te otorgue el rol de IAM de Usuario de Estadísticas de observabilidad (roles/observability.analyticsUser) en tu proyecto.

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 se puede acceder a ellas seleccionando la pestaña Recientes en la página Estadísticas de observabilidad. Puedes buscar, ver, ejecutar y compartir las consultas que se muestran en la pestaña Recientes.

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

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 propagar el panel Consulta ingresando una consulta nueva, seleccionando una consulta de la pestaña Recientes o seleccionando una consulta de la pestaña Guardadas.

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

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

  4. Opcional: Para permitir que todas las personas que tengan acceso a la página Estadísticas de observabilidad del proyecto de Google Cloud vean y 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 para ti.

  5. Haz clic en Guardar consulta.

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

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

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

  • Para editar una consulta, 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: Es una consulta en SQL. Si las comillas simples (`) unen la ruta de acceso o los campos dentro de la ruta de acceso, debes usar caracteres de escape para esas comillas simples: 
          "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"

      o

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

      Las comillas simples (`) son obligatorias 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 de texto de la consulta. 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 una respuesta de ejemplo 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 consulta, 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 un comodín. También puedes proporcionar una ubicación específica.

Existen comandos de Google Cloud CLI para borrar, enumerar, describir y actualizar 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 consulta, 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 consulta

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 esta devuelve.

Console

Cuando solucionas un problema o ves resultados anómalos, es posible que quieras compartir una consulta y sus resultados con un compañero de equipo. Cuando veas los resultados de la consulta en la página Estadísticas de observabilidad, puedes copiar una URL que, cuando se abra, muestre la consulta que ejecutaste y sus resultados.

Para compartir una consulta y los 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. Completa el panel Consulta con una consulta y, luego, haz clic en Ejecutar consulta.

    Puedes propagar el panel Consulta ingresando una consulta nueva, seleccionando una consulta de la pestaña Recientes o seleccionando una consulta de 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.

    En la página Estadísticas de observabilidad, se muestra un diálogo de advertencia cuando la consulta se ejecuta en el motor de BigQuery y los recursos consultados no están 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 consulta.

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

gcloud

Cuando quieras crear una consulta guardada que otros puedan ejecutar, 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.

Visualiza y ejecuta consultas recientes o guardadas

Para ver o volver a ejecutar una consulta, selecciona la pestaña Recientes en la página Estadísticas de observabilidad 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 Estadísticas de observabilidad y busca la consulta:

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

¿Qué sigue?