Crear consultas con el lenguaje de consultas de Logging

En este documento, se describe cómo recuperar y analizar registros cuando se usa el Explorador de registros. Para recuperar registros, escribe y ejecuta consultas. Puedes compilar consultas si seleccionas el menú de filtros, si usas opciones incluidas en las entradas de registro y si usas el campo de consulta de editor. Las consultas que compilas se escriben en el lenguaje de consulta de Logging.

Antes de comenzar

• A fin de crear consultas, debes tener los permisos para leer los datos de registro. Estos permisos se incluyen 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 compartir consultas, tu función de Identity and Access Management debe incluir el permiso logging.queries.share. Este permiso se incluye en las funciones de propietario (roles/owner) y administrador de Logging (roles/logging.admin).

  Para obtener una lista de los permisos asociados con cada función de Logging, consulta Funciones de Logging.

Compilar consultas

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

1. En la consola de Google Cloud, selecciona Logging y, luego, Explorador de registros o haz clic en el siguiente botón:

   Ir al Explorador de registros.

2. Selecciona el proyecto de Google Cloud o algún otro recurso de Google Cloud del que desees ver 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 Query para compilar tu consulta.

   

   El panel Query proporciona varias formas de compilar y ejecutar expresiones de consulta:

   • Busca texto en todos los campos de registro.
   • Selecciona las opciones de los menús de filtros.
   • Escribe o modifica consultas con el editor de consultas.
   • Puedes ver, editar o ejecutar las consultas en las pestañas Recientes, Guardados, Sugeridas y Biblioteca.

Buscar 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 y frases, y tus términos de búsqueda pueden incluir operadores booleanos y expresiones regulares:

• Para realizar una búsqueda que no distingue entre mayúsculas y minúsculas junto con los límites del token, 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. Como 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 que no distinga mayúsculas de minúsculas para una frase junto con los límites de token, encierra 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 que no distingue entre mayúsculas y minúsculas para una substring, 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 junto a los límites de tokens.

  Nota: Las búsquedas de substring 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 sus términos de búsqueda en la expresión de consulta, habilite la opción 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 puedes usar paréntesis para anidar reglas. Los paréntesis de la expresión de búsqueda se analizan como términos de búsqueda.
• Debes usar mayúsculas en los operadores booleanos. and, or y not en minúscula se analizan como términos de búsqueda, no como operadores.

Si no incluyes ningún operador, todos los términos de búsqueda y frases estarán unidos por AND. 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 los dos operadores se mezclan, la expresión a AND b OR c AND d se convierte en la siguiente expresión de 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 realiza una negación del término posterior. 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 siguientes dos consultas 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 siguientes dos consultas son iguales:

-"response successful"

NOT "response successful"

Crea consultas con menús de filtros

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

Las opciones de los menús Recurso y Nombre del registro solo muestran los registros que están almacenados en Cloud Logging.

• Resource: Te permite especificar el resource.type y el resource.labels asociado. Puedes seleccionar un solo tipo de recurso mediante este menú de filtros y cero o más etiquetas de recursos para aplicarlas a tu consulta. El operador lógico AND une los parámetros de recursos.
• 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. Defina mejor los parámetros del filtro.

3. Haz clic en Aplicar. Verás los parámetros en el campo del editor de consultas.

   Para ver sus términos de búsqueda en la expresión de consulta, habilite la opción 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 con el ID de la VM. Los nombres de los recursos te ayudan a identificar el ID de recurso correcto, en el que puedes crear consultas.

Ver registros por intervalo de tiempo

Hay dos formas de mostrar los registros que se escribieron en un período específico:

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

Usar el selector de intervalo de tiempo

El intervalo de tiempo predeterminado es de una hora, pero puedes seleccionar entre opciones de tiempo 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 quieres ver los datos de la semana pasada, selecciona Última semana en el selector de intervalo de tiempo.

También puedes configurar tus preferencias de zona horaria con el selector de intervalos de tiempo.

Incluir una expresión de marca de tiempo en el campo de búsqueda-editor

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

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

Escribir consultas avanzadas con el lenguaje de consultas 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 query-editor en el panel Query, habilita Show query.

2. Ingresa tus expresiones de consulta directamente en el campo de búsqueda-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, esos también aparecerán en el campo de búsqueda-editor y se evaluarán como parte de tu expresión de consulta.

3. Después de revisar su consulta, haga 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 te pueden interesar, visita 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, la consulta 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 las consultas recientes, selecciona la pestaña Recientes en el panel Consulta. En la pestaña Recientes, encontrarás las siguientes opciones:

• Transmisión: Para ejecutar la consulta y transmitir los resultados, elige esta opción.
• Ejecutar: 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 abrirá el diálogo Guardar consulta.

  2. Completa los siguientes campos:

     • Nombre (obligatorio): Brinda 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.
     • Incluir 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 resúmenes de campos y selecciona la cantidad de caracteres que se truncarán al comienzo 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 coincidirá con el texto en tu expresión de consulta.

Guardar búsquedas

Nota: Si los datos se administran mediante 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 en Assured Workloads.

El panel de consulta cuenta con una pestaña Guardado, en la que puedes acceder a las consultas guardadas. Las consultas guardadas te permiten almacenar expresiones de consulta para ayudarte a explorar los registros de manera más coherente y eficiente.

Para guardar una expresión de consulta que compilaste en el campo de búsqueda-editor, haz lo siguiente:

1. Haz clic en Guardar en el panel Consulta. Se abrirá el cuadro de diálogo Guardar consulta con tu expresión de consulta en el campo de edición de consultas.

2. Completa los siguientes campos:

   • Nombre (obligatorio): Brinda 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.
   • Incluir 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 resúmenes de campos y selecciona la cantidad de caracteres que se truncarán al comienzo o al final de los campos.
   1. Haz clic en Guardar consulta. Las consultas guardadas aparecerán en una lista en la pestaña Guardados.

Para ejecutar una consulta guardada, haga 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.

Compartir consultas

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

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

Crear una consulta compartida

Puede compartir las consultas que ya guardó o compartir una nueva.

Para crear y compartir una consulta, haz lo siguiente:

1. Ingrese una consulta en el campo de consulta-editor.

2. Haz clic en Guardar.

3. Completa los campos en el diálogo Guardar consulta.

4. Habilita Compartir con el proyecto.

5. Haz clic en Guardar consulta.

Tu consulta ahora se comparte 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, elige Editar o selecciona la consulta directamente.

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

Tu consulta ahora se comparte con otros usuarios del proyecto de Google Cloud.

Ver consultas compartidas

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, se indica si las consultas se comparten y de qué forma:

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

Ver solo tus búsquedas

Para ver las búsquedas guardadas que creaste o compartiste, haz clic en Minería. 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 sugerencias de consultas

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, si detectas que usas Google Kubernetes Engine, Logging podría sugerir una consulta que encuentre todos los registros de errores de los contenedores.

Para ver y ejecutar consultas sugeridas, selecciona la pestaña Suggested en el panel Query. 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: elige esta opción.

• Más opciones: Te permite ver los detalles de la expresión de consulta con las opciones para ejecutarla 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 cuadro de diálogo Detalles de la consulta.

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

  • Para guardar la consulta, haz lo siguiente:

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

    La consulta editada aparece en tu lista Guardado, donde puedes elegir ejecutar la consulta más tarde.

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

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

  • Para cerrar el 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 sucesivas cargas de página no muestren las mismas búsquedas en el mismo orden.
• Es posible que no veas ninguna sugerencia.
• A veces, ejecutar una consulta sugerida no muestra ningún registro.

Seleccionar consultas de la biblioteca

Logging proporciona una biblioteca de consultas basadas en casos de uso comunes y en productos de Google Cloud. Estas consultas pueden ayudarte a encontrar los registros de manera eficiente durante las sesiones de solución de problemas críticos y 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 Consulta.

2. En la columna Todas las consultas, verás categorías amplias de consultas disponibles y subconjuntos de consultas basadas en 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 Ejecutar, Transmitir o Guardar como:

   • Para guardar la consulta, haz lo siguiente:

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

     La consulta editada aparece en tu lista Guardado, donde puedes elegir ejecutar la consulta más tarde.

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

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

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

¿Qué sigue?

• Consultas de muestra