Cómo guardar y compartir consultas de SQL

En este documento, se describe cómo guardar y compartir las consultas que creas en Observability Analytics.

En este documento, se supone que conoces Análisis de observabilidad y cómo usar la página Análisis de observabilidad para consultar tus datos de registro. Si no conoces estos temas, consulta Cómo consultar y analizar registros.

Para obtener información sobre cómo graficar los resultados de tus consultas y cómo guardar esos gráficos en un panel personalizado, consulta Cómo graficar 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 Análisis de observabilidad y, luego, guardas como consulta. La acción de guardar te permite volver a ejecutar esta búsqueda cuando te resulte conveniente. Cuando guardes la consulta, tendrás la opción de que sea privada o de que sea visible para otras personas que tengan los permisos necesarios para usar Observability Analytics. No puedes escribir una consulta en SQL en la que la cláusula FROM especifique una consulta guardada.

Una vista de Analytics contiene una consulta que puedes volver a ejecutar cuando lo desees. 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 Analytics sea privada para ti. Puedes consultar una vista de Analytics. Esta capacidad te permite transformar tus datos de registro del formato LogEntry a otro formato que te resulte más adecuado. Luego, en lugar de escribir tus consultas en una vista de registro, las escribes en la vista de análisis.

Puedes guardar las consultas que consultan 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 Observability Analytics.

Configura buckets de registros

Asegúrate de que tus buckets de registros se hayan actualizado para usar Análisis 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 registros en la que quieras ejecutar consultas, asegúrate de que la columna Análisis 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 Observability Analytics:

  • Para obtener los permisos que necesitas para usar Observability Analytics y consultar vistas de registros de consultas, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

    Puedes restringir un principal a una vista de registros específica agregando una condición de IAM al otorgamiento del rol de Acceso a la vista de registros que se realiza a nivel del proyecto o agregando una vinculación de IAM al archivo de política de la vista de registros. 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 Analytics, pídele a tu administrador que te otorgue el rol de IAM de Usuario de Observability Analytics (roles/observability.analyticsUser) en tu proyecto.

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.

Si quieres que una consulta esté disponible para usarla en el futuro, anótala con información que te sea útil o permite que tus compañeros de equipo la vean y ejecuten. Luego, 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. Completa 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 la opció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.

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 enviar 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 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, muestre 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 Observability Analytics, 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 de Observability Analytics.

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 consulta, usa las opciones del menú Más opciones.

¿Qué sigue?