Crear y guardar consultas con el lenguaje de consulta de Logging

En este documento, se describe cómo recuperar y analizar registros cuando usas el Explorador de registros mediante la escritura de consultas en el campo del editor de consultas y la selección de los menús de filtro mediante las opciones incluidas en las entradas de registro. Las consultas que compilas están escritas en el lenguaje de consulta de Logging.

También puedes guardar tus consultas en la página del Explorador de registros o con el método savedQueries.create de la API de Logging.

Antes de comenzar

• Para crear consultas, debes tener los permisos de lectura de los datos de registro. Estos permisos están incluidos en la función de visualizador de Logging (roles/logging.viewer). Si deseas obtener detalles sobre los permisos de IAM necesarios, consulta Permisos para la consola de Google Cloud.

• Para crear y usar consultas privadas, tu función de Identity and Access Management debe incluir los permisos logging.queries.{list, create, get, update, delete}.

• Para crear y usar consultas compartidas, tu función de Identity and Access Management debe incluir los permisos logging.queries.{listShared, share, getShared, updateShared, deleteShared}.

Compilar consultas

Para compilar consultas con la consola de Google Cloud, haz lo siguiente:

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

   Ir al Explorador de registros

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

2. Selecciona el proyecto de Google Cloud o algún otro recurso de Google Cloud del que quieras ver los registros.

   Para ver los registros que envías desde una cuenta de Amazon Web Services (AWS) a Logging, selecciona el proyecto de conector de AWS en el selector de recursos de la consola de Google Cloud y, luego, usa el Explorador de registros. El proyecto de conector de AWS almacena el nombre del recurso de Amazon (ARN) de tu cuenta de AWS y vincula tu cuenta de AWS a los servicios de Google Cloud. Para obtener más información, consulta Recopila métricas de cuentas de AWS.

3. Usa el panel Consulta para compilar tu consulta.

   

   En el panel Consulta, se proporcionan varias formas de compilar y ejecutar expresiones de consulta:

   • Busca texto en todos los campos de registro.
   • Selecciona opciones de los menús de filtro.
   • Escribir o modificar consultas con el editor de consultas
   • Visualiza, edita o ejecuta las consultas en las pestañas Recientes, Guardados, Sugerencias y Biblioteca.

Busca texto en los campos de registro

Para buscar texto en todos los campos de registro y encontrar todas las entradas de registro que coincidan, ingresa los términos de búsqueda en el campo de búsqueda:

Puedes buscar palabras, frases y tus términos de búsqueda pueden incluir operadores booleanos y expresiones regulares:

• Para realizar una búsqueda que distinga mayúsculas de minúsculas, debes utilizar una expresión regular.

• Para realizar una búsqueda que no distingue mayúsculas de minúsculas dentro de los límites de los tokens, ingresa los términos de búsqueda sin acentos graves ni comillas dobles.

  Por ejemplo, para buscar entradas de registro que contengan la palabra hello y la palabra world, ingresa hello world. Este comando, que se convierte en SEARCH("hello world"), coincide con las entradas de registro que contienen los tokens hello y world, en cualquier orden. Debido a que la búsqueda no distingue mayúsculas de minúsculas, también coincide con una entrada de registro que contiene los tokens Hello y World. La búsqueda no coincide con el token worlds.

• Para realizar una búsqueda sin distinción entre mayúsculas y minúsculas de una frase junto con los límites del token, coloca la frase entre acentos graves.

  Por ejemplo, para buscar la frase hello world, ingresa `hello world`. Este comando, que se convierte en SEARCH("`hello world`"), coincide con las entradas de registro que contienen el token hello world. La búsqueda no coincide con el token hello worlds.

• Para realizar una búsqueda sin distinción entre mayúsculas y minúsculas de una subcadena, encierra el texto entre comillas dobles. Por ejemplo, "hello world" coincide con Hello World y Hello world. La misma consulta también coincide con hello worlds, ya que la búsqueda no se realiza dentro de los límites de los tokens.

  Nota: Las búsquedas de subcadenas son más lentas que las búsquedas basadas en tokens. Por lo tanto, te recomendamos que uses búsquedas basadas en tokens cuando sea posible.

Para ver tus términos de búsqueda en la expresión de consulta, habilita Mostrar consulta.

Después de ingresar los términos de búsqueda, haz clic en Ejecutar consulta o presiona la tecla Intro. Los resultados de la consulta se muestran en el panel Resultados de la consulta.

Operadores booleanos

Las entradas del campo de búsqueda se convierten en expresiones booleanas que especifican un subconjunto de todas las entradas de registro en el recurso de Google Cloud seleccionado.

El campo de búsqueda admite el uso de los operadores booleanos AND, OR y NOT. Cuando uses operadores booleanos en tus expresiones de búsqueda, ten en cuenta lo siguiente:

• No se pueden usar paréntesis para anidar reglas. Cualquier paréntesis en la expresión de búsqueda se analiza como términos de búsqueda.
• Debes escribir en mayúscula los operadores booleanos. Los and, or y not en minúscula se analizan como términos de búsqueda, no como operadores.

Si no incluyes operadores, AND unirá todos los términos de búsqueda y las frases. Puedes omitir el operador AND entre los términos de búsqueda.

Los operadores AND y OR son operadores de cortocircuito. Puedes combinar las reglas AND y OR en la misma expresión. Por ejemplo, cuando se mezclan los dos operadores, la expresión a AND b OR c AND d se convierte en la siguiente expresión del lenguaje de consulta de Logging:

"a"
"b" OR "c"
"d"

El operador NOT tiene la prioridad más alta, seguido de OR y AND en ese orden.

El operador NOT nega el término siguiente. Por ejemplo, NOT error muestra entradas de registro que no contienen error. También puedes reemplazar el operador NOT por el operador - (menos). Por ejemplo, las dos consultas siguientes son iguales:

"response" AND "successful" AND NOT "error"

"response successful" -"error"

Esta lógica también funciona con una frase si el operador - (menos) está fuera de las comillas. Por ejemplo, las dos consultas siguientes son iguales:

-"response successful"

NOT "response successful"

Crear consultas con menús de filtro

Puedes usar los menús de filtro del panel Consulta (Query) para agregar recursos, nombres de registros y parámetros de gravedad de registro al campo de consulta-editor. Estas opciones corresponden a los campos LogEntry para todos los registros en Logging.

Las opciones de los menús Recurso y Nombre del registro derivan de las entradas de registro que almacena Cloud Logging.

• Resource (Recurso): Te permite especificar el resource.type y el resource.labels asociado. Puedes seleccionar un solo tipo de recurso con este menú de filtro y cero o más etiquetas de recursos para aplicar a tu consulta. Los parámetros de recursos están unidos por el operador lógico AND.
• Nombre del registro (Log name): Te permite especificar logName. Puedes seleccionar varios nombres de registro para aplicarlos a tu consulta. Cuando seleccionas varios nombres de registro, se usa el operador lógico OR.
• Gravedad (Severity): Te permite especificar la gravedad. Puedes seleccionar varios niveles de gravedad al mismo tiempo para agregarlos a tu consulta. Cuando seleccionas varios niveles de gravedad, se usa el operador lógico OR.

Para usar cualquiera de los menús de filtro, haz lo siguiente:

1. Expande el Menú en cualquiera de los menús de filtro del panel Consulta.

2. Define mejor los parámetros del filtro.

3. Haz clic en Aplicar. Verás los parámetros en el campo query-editor.

   Para ver tus términos de búsqueda en la expresión de consulta, habilita Mostrar consulta.

4. Después de revisar la consulta, haz clic en Ejecutar consulta. Los resultados de la consulta se muestran en el panel Resultados de la consulta.

Para ciertos tipos de recursos de Compute Engine, como gce_instance y gce_network, verás el nombre del recurso con el ID del recurso como subtexto. Por ejemplo, para el tipo de recurso gce_instance, verás el nombre de la VM junto al ID de la VM. Los nombres de recursos te ayudan a identificar el ID de recurso correcto, en el que puedes crear consultas.

Visualiza registros por intervalo de tiempo

Existen dos maneras de mostrar los registros que se escribieron en un intervalo de tiempo específico:

1. Usa el selector de intervalo de tiempo.
2. Incluye una expresión de marca de tiempo en el campo de editor de consultas.

Usa el selector de intervalo de tiempo

El intervalo de tiempo predeterminado es de una hora, pero puedes seleccionar entre las opciones de hora predeterminadas, especificar una hora de inicio y finalización personalizada, o centrar el intervalo de tiempo alrededor de una marca de tiempo específica con el selector de intervalo de tiempo. Por ejemplo, si deseas ver los datos de la semana pasada, selecciona Última semana en el selector de intervalo de tiempo.

También puedes configurar las preferencias de tu zona horaria con el selector de intervalo de tiempo.

Incluye una expresión de marca de tiempo en el campo de editor de consultas.

Para agregar una expresión de marca de tiempo directamente al campo del editor de consultas, usa el lenguaje de consulta de Logging.

Si el campo de editor de consultas contiene una expresión con una marca de tiempo, se inhabilita el selector de intervalo de tiempo y la consulta usa la expresión de marca de tiempo como su restricción de intervalo de tiempo. Si una consulta no usa una expresión de marca de tiempo, usará el selector de intervalo de tiempo como su restricción de intervalo de tiempo.

Escribe consultas avanzadas con el lenguaje de consulta de Logging

Puedes usar el lenguaje de consulta de Logging para compilar consultas más avanzadas en el campo del editor de consultas del Explorador de registros:

1. Si no ves el campo de editor de consultas en el panel Consulta, habilita la opción Mostrar consulta.

2. Ingresa las expresiones de tu consulta directamente en el campo query-editor.

   Si agregaste términos de búsqueda en el campo de búsqueda o seleccionaste algún parámetro en los menús de filtro, estos también aparecen en el campo del editor de consultas y se evalúan como parte de la expresión de consulta.

3. Después de revisar tu consulta, haz clic en Ejecutar consulta.

   Los registros que coinciden con tu consulta se enumeran en el panel Resultados de la consulta. Los paneles Histograma y Campos de registro también se ajustan según la expresión de la consulta.

Para ver ejemplos de consultas comunes que puedes usar, revisa Consultas de muestra con el Explorador de registros.

Nota: La longitud de una consulta no puede superar los 20,000 caracteres.

Usar consultas recientes

Cuando ejecutas una consulta, esta se agrega a tu lista de consultas recientes, que contiene las últimas 10,000 consultas únicas en un período de 30 días.

Para ver tus consultas recientes, selecciona la pestaña Recientes en el panel Consulta. En la pestaña Recientes, tienes las siguientes opciones:

• Transmisión: Para ejecutar la consulta y transmitir los resultados, elige esta opción.
• Ejecutar: Para ejecutar la consulta, elige esta opción.

• Más opciones: Te permite ver la expresión de la consulta con las opciones para ejecutarla o guardarla en tu lista de consultas Guardadas. También puedes seleccionar la consulta directamente para obtener estas opciones.

  Para guardar la consulta, haz lo siguiente:

  1. Haz clic en Guardar como. Se abre el diálogo Guardar consulta.

  2. Completa los siguientes campos:

     • Nombre (obligatorio): Proporciona un nombre para tu consulta. Los nombres tienen un límite de 64 caracteres.
     • Descripción (opcional): Proporciona una descripción para ayudar a identificar el propósito de la consulta.
     • Incluye campos de resumen (opcional): Habilita Incluir campos de resumen y, luego, ingresa los campos de resumen que deseas mostrar.
     • Truncar campos de resumen (opcional): Habilita Truncar campos de resumen y selecciona la cantidad de caracteres a los que se truncará y si se producirá un truncamiento al principio o al final de los campos.

  3. Haz clic en Guardar consulta. La consulta ahora está disponible en tu lista de consultas guardadas.

También puedes ordenar y filtrar tus consultas recientes; el filtro coincide con el texto en tu expresión de consulta.

Guardar consultas

Nota: Si tus datos se administran a través de un entorno de Assured Workloads, es posible que esta función se vea afectada o restringida. Para obtener más información, consulta Restricciones y limitaciones de Assured Workloads.

Las consultas guardadas te permiten almacenar expresiones de consulta para ayudarte a explorar los registros de manera más coherente y eficiente. El panel Consulta del Explorador de registros cuenta con una pestaña Guardado, en la que puedes acceder a tus consultas guardadas. También puedes guardar tus consultas con el método savedQueries.create de la API de Logging.

Console

Para guardar una expresión de consulta que compilaste en el campo del editor de consultas, haz lo siguiente:

1. Haz clic en Guardar en el panel Consulta. Se abrirá el diálogo Guardar consulta con tu expresión de consulta en el campo query-editor.

2. Completa los siguientes campos:

   • Nombre (obligatorio): Proporciona un nombre para tu consulta. Los nombres tienen un límite de 64 caracteres.
   • Descripción (opcional): Proporciona una descripción para ayudar a identificar el propósito de la consulta.
   • Incluye campos de resumen personalizados (opcional): Habilita Incluir campos de resumen y, luego, ingresa los campos de resumen que deseas mostrar.
   • Truncar campos de resumen (opcional): Habilita Truncar campos de resumen y selecciona la cantidad de caracteres a los que se truncará y si se producirá un truncamiento al principio o al final de los campos.

3. Haz clic en Guardar consulta. Las consultas guardadas aparecen en una lista en la pestaña Guardados.

Para ejecutar una consulta guardada, haz clic en Ejecutar. Para ejecutar la consulta y transmitir los resultados, haz clic en Transmitir.

También puedes ordenar y filtrar tus consultas guardadas; el filtro coincide con el texto en tu expresión de consulta.

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 del Explorador de registros, debes especificar el campo loggingQuery. En el siguiente ejemplo, se muestra un cuerpo de solicitud de muestra, que contiene una instancia de SavedQuery:

{
"parent": "projects/my-project/locations/global"
"savedQueryId": "compute-query"
{
  "displayName": "compute-admin-activity-query",
  "description": "Queries for Compute Engine Admin Activity logs.",

  "loggingQuery":
    {
      "filter": resource.type="gce_instance" AND log_id("cloudaudit.googleapis.com/activity"),
    },
  "visibility": "PRIVATE"
}
}

Compartir consultas

Las consultas compartidas permiten que los usuarios de un proyecto de Google Cloud compartan entre sí sus consultas guardadas. Puedes ver las consultas compartidas en la pestaña Guardados.

Si quieres conocer los roles y permisos necesarios para ver y editar las consultas compartidas, consulta los permisos de la consola de Google Cloud. Ten en cuenta que los usuarios que tienen el rol de IAM roles/logging.admin o roles/editor pueden editar las consultas compartidas de otros usuarios.

Crear una consulta compartida

Console

Puedes compartir consultas que ya hayas guardado o compartir una nueva.

Para crear y compartir una consulta, haz lo siguiente:

1. Ingresa una consulta en el campo query-editor.

2. Haz clic en Guardar.

3. Completa los campos del diálogo Guardar consulta.

4. Habilita Compartir con el proyecto.

5. Haz clic en Guardar consulta.

Ahora se compartirá tu consulta con otros usuarios del proyecto de Google Cloud.

Para compartir una consulta ya guardada, haz lo siguiente:

1. Selecciona la pestaña Guardadas (Saved).

2. Selecciona Más opciones y, luego, Editar o selecciona directamente la consulta.

3. En el cuadro de diálogo Editar consulta, habilita Compartir con el proyecto y, luego, haz clic en Actualizar consulta.

Ahora se compartirá tu consulta con otros usuarios del proyecto de Google Cloud.

API

Puedes usar la API de Logging para crear una consulta compartida con el método savedQueries.Create y la especificación de un valor de SHARED en el campo visibility.

Ver consultas compartidas

Console

Para ver todas las consultas compartidas con rapidez, ordena la columna Visibilidad para mostrar primero las consultas compartidas:

1. Selecciona la pestaña Guardadas (Saved).

2. Haga clic en Todos.

3. Ordena la columna Visibilidad (Visibility).

En la columna Visibilidad (Visibility), se indica si se comparten las consultas y de qué manera:

• Compartidos por mí: Consultas que guardaste y compartiste con otros usuarios del proyecto de Google Cloud.
• Compartidos: Consultas que compartieron otros usuarios del proyecto de Google Cloud.
• Privadas: Consultas que guardaste y no compartiste con otros usuarios del proyecto de Google Cloud.

Ver solo tus consultas

Para ver las consultas guardadas que creaste o compartiste, haz clic en Mine. Ahora verás una lista de las consultas que creaste y guardaste. En la columna Visibilidad, puedes ver tus consultas Privadas no compartidas. Las consultas que compartiste se identifican con Compartidas por mí (Shared by me).

Usa las consultas sugeridas

Logging genera consultas sugeridas según el contexto de tu proyecto de Google Cloud, como los productos de Google Cloud que usas. Las consultas sugeridas pueden ayudarte a identificar problemas y brindarte estadísticas sobre el estado general de tus sistemas. Por ejemplo, al detectar que usas Google Kubernetes Engine, Logging podría sugerir una consulta que encuentre todos los registros de errores de tus contenedores.

Para ver y ejecutar consultas sugeridas, selecciona la pestaña Suggested (Sugerencias) en el panel Query (Consulta). En la pestaña Suggested, se muestra una lista de consultas, cada una con descripciones y las siguientes opciones:

• Transmisión: Para ejecutar la consulta y transmitir los resultados, elige esta opción.
• Ejecutar: Para ejecutar la consulta, elige esta opción.

• Más opciones: Te permite ver los detalles de la expresión de consulta con las opciones para ejecutar la consulta o guardarla. También puedes seleccionar la consulta directamente para obtener estas opciones.

  Para revisar los detalles de una consulta sugerida, realiza una de las siguientes acciones:

  • Selecciona la fila de la consulta.

  • Haz clic en Más y selecciona Ver. Se abrirá el diálogo Detalles de la consulta.

  En el cuadro de diálogo Detalles de la consulta, verás la consulta y las opciones para Ejecutar, Transmitir o Guardar como:

  • Para guardar la consulta, haz lo siguiente:

    1. Haz clic en Guardar como.
    2. Completa los campos del diálogo Guardar consulta.

    La consulta editada aparecerá en tu lista Guardada, en la que puedes elegir ejecutarla más tarde.

  • Para ejecutar la consulta ahora, haz clic en Ejecutar. La consulta se ejecuta y aparece en el campo de editor de consultas.

  • Para ejecutar la consulta ahora y transmitir los resultados, haz clic en Transmitir.

  • Para cerrar el cuadro de diálogo y volver a la lista de consultas sugeridas, haz clic en Cerrar.

Ten en cuenta los siguientes comportamientos esperados:

• Es posible que las cargas de páginas sucesivas no muestren las mismas consultas en el mismo orden.
• Es posible que no veas ninguna consulta sugerida.
• A veces, ejecutar una consulta sugerida no devuelve ningún registro.

Selecciona consultas de la biblioteca

Logging proporciona una biblioteca de consultas basada en casos de uso comunes y productos de Google Cloud. Estas consultas pueden ayudarte a encontrar registros de manera eficiente durante sesiones de solución de problemas urgentes y a explorar tus registros para comprender mejor qué datos de registro están disponibles.

Para ver y ejecutar las consultas de la biblioteca, haz lo siguiente:

1. Selecciona la pestaña Biblioteca en el panel Consultas.

2. En la columna Todas las consultas, verás categorías amplias de consultas disponibles y subconjuntos de consultas según los productos de Google Cloud. Para limitar la selección de consultas que ves, haz clic en cualquiera de los productos.

   También puedes usar el campo de búsqueda para buscar las consultas disponibles por categoría, descripción o el contenido de la expresión de consulta.

3. Para revisar una expresión de consulta, realiza una de las siguientes acciones:

   a. Haz clic en la fila de la consulta.

   b. Haz clic en Más y selecciona Ver.

4. En el cuadro de diálogo Detalles de la consulta, verás la consulta y las opciones para Ejecutar, Transmitir o Guardar como:

   • Para guardar la consulta, haz lo siguiente:

     1. Haz clic en Guardar como.
     2. Completa los campos del diálogo Guardar consulta.

     La consulta editada aparecerá en tu lista Guardada, en la que puedes elegir ejecutarla más tarde.

   • Para ejecutar la consulta ahora, haz clic en Ejecutar. La consulta se ejecuta y aparece en el campo de editor de consultas.

   • Para ejecutar la consulta ahora y transmitir los resultados, haz clic en Transmitir.

   • Para cerrar el cuadro de diálogo y volver a la lista de consultas sugeridas, haz clic en Cerrar.

¿Qué sigue?

• Consultas de muestra