Guarda y comparte consultas de SQL

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

En este documento, se supone que conoces Log Analytics y cómo usar la página Log Analytics para consultar tus datos de registro. Si no estás familiarizado con estos temas, consulta Cómo consultar y analizar registros.

Para obtener información sobre cómo crear gráficos con los resultados de tus consultas y guardarlos en un panel personalizado, consulta Cómo crear gráficos con los resultados de las consulta en SQL SQL.

Antes de comenzar

En esta sección, se describen los pasos que debes completar antes de poder usar Log Analytics.

Configura buckets de registros

Asegúrate de que tus buckets de registros se hayan actualizado para usar el Análisis de registros:

  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 que deseas consultar, asegúrate de que la columna Log Analytics disponible muestre Abierto. Si aparece Upgrade, haz clic en Upgrade y completa el diálogo.

Configura roles y permisos de IAM

En esta sección, se describen los roles o los permisos de IAM necesarios para usar Log Analytics:

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

    Puedes restringir un principal a una vista de registro específica agregando una condición de IAM a la concesión de 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 registro. Para obtener más información, consulta Controla el acceso a una vista de registro.

    Estos son los mismos permisos que necesitas para ver las entradas de registro en la página 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.

Guarda una consulta

Todas las consultas que ejecutes se guardarán automáticamente durante 30 días y podrás acceder a ellas seleccionando la pestaña Recientes en la página Log Analytics. Puedes buscar, ver, ejecutar y compartir las búsquedas que aparecen en la pestaña Recientes.

Si quieres mantener una consulta disponible para usarla en el futuro, hazle anotaciones con información que te resulte útil o permite que tus compañeros de equipo la vean y la ejecuten, y, luego, guárdala. Puedes buscar y ordenar tus búsquedas guardadas por nombre, descripción y etiqueta de visibilidad. También puedes editar y borrar estas consultas. Las consultas 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 consola de Google Cloud, ve a la página Análisis de registros:

    Ir a Análisis de registros

    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.

    Para propagar el panel Consulta, ingresa una consulta nueva, selecciona una de la pestaña Recientes o selecciona una de la pestaña Guardadas.

    Cuando la consulta del panel Consulta es válida, se habilita Guardar.

  3. Haz clic en Guardar 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 todas las personas que tengan acceso a la página Log Analytics 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 se restringe a 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 búsquedas guardadas por 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, no se puede modificar la consulta en sí.

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

API

Para guardar una consulta con la API de Logging, usa el método savedQueries.create. Para obtener más información sobre este método, sus parámetros y los datos de respuesta, consulta la página de referencia de savedQueries.create.

Puedes ejecutar el método savedQueries.create con el widget del Explorador de APIs en la página de referencia del método. Para las consultas de Log Analytics, 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
           `TABLE_NAME_OF_LOG_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 de Google Cloud. Sin embargo, los roles de IAM del principal determinan si se puede ejecutar la consulta y los datos que devuelve.

Console

Cuando soluciones un problema o veas resultados anómalos, te recomendamos que compartas una consulta y sus resultados con un compañero de equipo. Cuando veas los resultados de las consultas en la página Análisis de registros, 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 consola de Google Cloud, ve a la página Análisis de registros:

    Ir a Análisis de registros

    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.

    Para propagar el panel Consulta, ingresa una consulta nueva, selecciona una de la pestaña Recientes o selecciona una 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á la página Log Analytics. En esta página, se muestra la consulta que ejecutaste y los resultados de la consulta.

    Para abrir la URL correctamente, el rol de Identity and Access Management de tu compañero de equipo en el proyecto de Google Cloud debe incluir los permisos necesarios para ver las páginas de Logging.

API

Puedes usar la API de Logging para crear una búsqueda 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 Log 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 de .

Para ver, editar o ejecutar una consulta guardada, selecciona la pestaña Guardadas en la página Log 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?