Guardar y compartir consultas de SQL

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

En este documento se da por hecho que conoce Log Analytics y sabe cómo usar la página Log Analytics para consultar sus datos de registro. Si no conoces estos temas, consulta Consultar y analizar registros.

Para saber cómo representar gráficamente los resultados de una consulta y cómo guardar esos gráficos en un panel de control personalizado, consulta el artículo Representar gráficamente los resultados de una consulta de SQL.

Diferencias entre las consultas guardadas y las vistas de analíticas

Una consulta guardada es una consulta que se ejecuta en la página Analíticas de registros y que se guarda como consulta. La acción de guardar te permite volver a ejecutar esta consulta cuando te venga bien. Cuando guarde la consulta, podrá hacerla privada o visible para otros usuarios que tengan los permisos necesarios para usar Log Analytics. No puedes escribir una consulta SQL en la que la cláusula FROM especifique una consulta guardada.

Una vista de analíticas contiene una consulta que puedes volver a ejecutar cuando quieras. Para crear una vista analítica, escribe una consulta de SQL en una vista de registro y guarda el resultado como vista. A diferencia de las consultas guardadas, no puede hacer que una vista de analíticas sea privada. Puedes consultar una vista de analíticas. Esta función le permite transformar sus datos de registro del formato LogEntry a otro que se adapte mejor a sus necesidades. Después, en lugar de escribir tus consultas en una vista de registro, las escribes en la vista de analíticas.

Puedes guardar consultas que consulten una vista de registro o una vista de analíticas.

Antes de empezar

En esta sección se describen los pasos que debe completar para poder usar Log Analytics.

Configurar segmentos de registros

Comprueba que tus contenedores de registros se hayan actualizado para usar Analíticas de registros:

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

    Ve a Almacenamiento de registros.

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

  2. En cada contenedor de registros que tenga una vista de registro que quieras consultar, comprueba que en la columna Analíticas de registros disponibles se muestre Abrir. Si se muestra Cambiar a plan superior, haz clic en Cambiar a plan superior y completa el cuadro de diálogo.

Configurar roles y permisos de gestión de identidades y accesos

En esta sección se describen los roles o permisos de gestión de identidades y accesos que se necesitan para usar Log Analytics:

  • Para obtener los permisos que necesitas para usar Log Analytics y consultar vistas de registro, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos en tu proyecto:

    Puede restringir un principal a una vista de registro específica añadiendo una condición de IAM a la concesión del rol de acceso a la vista de registros que se haya hecho a nivel de proyecto o añadiendo un enlace de IAM al archivo de política de la vista de registro. Para obtener más información, consulta Controlar 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 segmentos definidos por el usuario o para consultar la vista _AllLogs del segmento de registro _Default, consulta Roles de Cloud Logging.

  • Para obtener los permisos que necesitas para consultar vistas de analíticas, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Usuario de Observabilidad Analytics (roles/observability.analyticsUser) en tu proyecto.

Guardar 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 Reciente de la página Analíticas de registros. Puedes buscar, ver, ejecutar y compartir las consultas que aparecen en la pestaña Recientes.

Si quieres que una consulta esté disponible para usarla más adelante, anótala con información que te resulte útil o permite que tus compañeros vean y ejecuten la consulta. Después, guarda la consulta. Puedes buscar y ordenar tus consultas guardadas por nombre, descripción y etiqueta de visibilidad. También puedes editar y eliminar estas consultas. Las consultas que guardes se conservarán hasta que las elimines.

Puedes guardar 10.000 consultas por Google Cloud proyecto.

Consola

Para guardar una consulta, sigue estos pasos:

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

    Vaya a Analíticas de registros.

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

  2. Rellena el panel Consulta con una consulta.

    Para rellenar el panel Consulta, introduce una consulta nueva, selecciona una de la pestaña Recientes o elige una de la pestaña Guardadas.

    Tu consulta puede incluir cualquier vista válida, varias vistas y vistas de analíticas.

    Si la consulta del panel Consulta es válida, se habilita la opción Guardar.

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

  4. Opcional: Para permitir que todos los usuarios con acceso a la página Log Analytics de la vista de proyecto Google Cloud puedan ejecutar tu consulta guardada, activa el interruptor Compartir con el proyecto.

    De forma predeterminada, este interruptor está inhabilitado y solo tú puedes ver el contenido.

  5. Haz clic en Guardar consulta.

  6. Opcional: Para ver, ordenar y ejecutar las consultas guardadas que tienes visibles, 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 consulta.

Puedes editar y eliminar las consultas que hayas creado mediante las opciones de la pestaña Guardadas:

  • Para editar una consulta, haz clic en Más opciones y selecciona Editar. Puede modificar los valores de los campos Nombre y Descripción, pero no la consulta en sí.

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

API

Para guardar una consulta mediante la API 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 mediante el widget Explorador de APIs en la página de referencia del método. En el caso de las consultas de Log Analytics, debe especificar el campo opsAnalyticsQuery. En el siguiente ejemplo se muestra 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"
   }
}

Compartir una consulta

Puedes compartir una consulta guardada con todos los usuarios que tengan acceso a tuGoogle Cloud proyecto. Sin embargo, los roles de gestión de identidades y accesos de la entidad principal determinan si se puede ejecutar la consulta y los datos que devuelve.

Consola

Cuando solucionas un problema o ves resultados anómalos, puede que quieras compartir una consulta y sus resultados con un compañero. Cuando ve los resultados de una consulta en la página Log Analytics, puede copiar una URL que, al abrirse, muestra la consulta que ha ejecutado y sus resultados.

Para compartir una consulta y sus resultados con un compañero, sigue estos pasos:

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

    Vaya a Analíticas de registros.

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

  2. Rellena el panel Consulta con una consulta y, a continuación, haz clic en Ejecutar consulta.

    Para rellenar el panel Consulta, introduce una consulta nueva, selecciona una de la pestaña Recientes o elige una de la pestaña Guardadas.

  3. Haz clic en Compartir enlace .

  4. Envía el enlace a tu compañero.

    Cuando tu compañero abra el enlace, se abrirá la página Log Analytics. En esta página se muestra la consulta que has ejecutado y los resultados de la consulta.

    Para que tu compañero pueda abrir la URL, su rol de gestión de identidades y accesos (IAM) en el Google Cloud proyecto debe incluir los permisos necesarios para ver la página Analíticas de registros.

API

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

Ver y ejecutar consultas recientes o guardadas

Para ver o volver a ejecutar una consulta, selecciona la pestaña Reciente 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.

Para ver, editar o ejecutar una consulta guardada, seleccione la pestaña Guardado en la página Analíticas de registros y busque la consulta:

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

Siguientes pasos