Compila y guarda 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 escribiendo consultas en el campo del editor de consultas y realizando selecciones en los menús de filtros con las opciones incluidas en las entradas de registro. Las consultas que compilas se escriben en el lenguaje de consulta de Logging.

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

Antes de comenzar

• Para obtener los permisos que necesitas para leer datos de registro y crear consultas, usar consultas privadas guardadas o enumerar y obtener consultas compartidas, pídele a tu administrador que te otorgue el rol de IAM Visualizador de registros (roles/logging.viewer) en tu proyecto.

  Este rol predefinido contiene los permisos necesarios para leer datos de registro y crear consultas, usar consultas privadas guardadas o enumerar y obtener consultas compartidas. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

  Permisos necesarios

  Se requieren los siguientes permisos para leer datos de registro y crear consultas, usar consultas privadas guardadas o enumerar y obtener consultas compartidas:

  • Usar consultas guardadas privadas: logging.queries.usePrivate
  • Genera una lista de las consultas compartidas y obtén información sobre ellas:
    • logging.queries.listShared
    • logging.queries.getShared

• Para obtener los permisos que necesitas para crear, actualizar y borrar consultas compartidas, pídele a tu administrador que te otorgue el rol de IAM Administrador de registros (roles/logging.admin) en tu proyecto.

  Este rol predefinido contiene los permisos necesarios para crear, actualizar y borrar consultas compartidas. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

  Permisos necesarios

  Se requieren los siguientes permisos para crear, actualizar y borrar consultas compartidas:

  • logging.queries.share
  • logging.queries.updateShared
  • logging.queries.deleteShared

Para obtener más información sobre los permisos de IAM necesarios, consulta Permisos de la consola de Google Cloud.

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 cualquier otro recurso de Google Cloud cuyos registros deseas ver.

3. Usa el panel Consulta para crear tu consulta.

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

   • Busca texto en todos los campos de registro.
   • Selecciona opciones de los menús de filtros.
   • Escribe o modifica consultas con el editor de consultas.
   • Consulta y ejecuta consultas guardadas, recientes y sugeridas desde la menu_book Biblioteca de consultas.

Busca texto en todos los campos de registro

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

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 distingue mayúsculas de minúsculas, debes usar una expresión regular.

• Para realizar una búsqueda que no distingue mayúsculas de minúsculas en 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 de una frase sin distinción de mayúsculas o minúsculas a lo largo de los límites de los tokens, colócala 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 de una subcadena sin distinción entre mayúsculas y minúsculas, une el texto con 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 a lo largo de los límites de los tokens.

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

Después de ingresar los términos de búsqueda, haz clic en Run query 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 del 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 escribir los operadores booleanos en mayúscula. Los operadores 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 y las frases de búsqueda se unen con AND. Puedes omitir el operador AND entre los términos de búsqueda.

Los operadores AND y OR son operadores de cortocircuito. Puedes combinar 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 realiza una negación del término subsiguiente. 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 equivalentes:

-"response successful"

NOT "response successful"

Cómo crear consultas con menús de filtros

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

Las opciones de los menús Recurso y Nombre del registro se derivan de las entradas de registro que almacena 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 aplicar 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.
• Correlacionar por: Te permite agrupar y ver las entradas de registro en un formato “principal-secundario”. Para obtener más información, consulta Cómo correlacionar entradas de registro.

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

1. Expande el menú arrow_drop_down en cualquiera de los menús de filtros del panel Consulta.

2. Define 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 tus términos de búsqueda dentro de 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.

En el caso de 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 texto secundario. Por ejemplo, en 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.

Cómo ver registros por período

Existen dos maneras 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 del editor de consultas.

Usa 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 personalizadas, 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 anterior, selecciona Última semana en el selector de período.

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

Incluye una expresión de marca de tiempo en el campo del 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 del editor de consultas 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 su restricción de intervalo de tiempo. Si una consulta no usa una expresión de marca de tiempo, usará el selector de intervalos de tiempo como su restricción de intervalo de tiempo.

Escribe búsquedas avanzadas con el lenguaje de consulta de Logging

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

1. Si no ves el campo del editor de consultas en el panel Consulta, habilita Mostrar consulta.

2. Ingresa tus expresiones de consulta directamente en el campo del editor de consultas.

   Si agregaste términos de búsqueda en el campo de búsqueda o seleccionaste parámetros en los menús de filtros, estos también aparecerán en el campo del editor de consultas y se evaluarán como parte de la expresión de consulta.

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

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

Para ver ejemplos de consultas comunes que te pueden interesar, consulta Consultas de muestra con el Explorador de registros.

Usa consultas recientes

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

Para ver tus consultas recientes, selecciona el botón menu_book Biblioteca de consultas en la barra de herramientas principal. Para las consultas recientes, tienes las siguientes opciones:

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

• more_vert Más opciones: Te permite ver la expresión de 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. Se abrirá 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.
     • Incluir campos de resumen (opcional): Habilita Incluir campos de resumen e ingresa los campos de resumen que deseas mostrar.
     • Truncar los campos de resumen (opcional): Habilita Truncar los campos de resumen y selecciona la cantidad de caracteres que deseas truncar y si el truncamiento debe ser 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 en el texto de la expresión de tu consulta.

Guarda y comparte consultas

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

Puedes guardar tu consulta para que sea privada y solo tú puedas verla, o bien compartirla con otros miembros del proyecto de Google Cloud. Una vez que compartes una consulta, ya no te pertenece y cualquier miembro del proyecto con los permisos necesarios puede acceder a ella.

{
  "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"
  }
}

Ver las búsquedas guardadas

Para ver las consultas privadas y las que se comparten con otros miembros del proyecto de Google Cloud, haz clic en el botón menu_book Biblioteca de consultas:

{
  "parent": "name": projects/PROJECT_ID/locations/-
  "visibility": "SHARED"
  "filter": "explorer"
}

Usa consultas sugeridas

Logging genera consultas sugeridas en función del 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 busque todos los registros de errores para tus contenedores.

Para ver y ejecutar consultas sugeridas, haz clic en el botón menu_book Biblioteca de consultas y, luego, en Sugeridas. En la pestaña Sugerencias, tienes las siguientes opciones:

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

• more_vert 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 more_vert Más y selecciona Ver. Se abrirá el diálogo Detalles de la consulta.

  En el 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 consulta.
    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 del 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 muestra ningún registro.

Cómo seleccionar consultas de la biblioteca

El registro proporciona una biblioteca de consultas basadas 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. 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 cualquier otro recurso de Google Cloud cuyos registros deseas ver.

3. Haz clic en el botón menu_book Biblioteca de consultas. Verás categorías 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.

4. 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 more_vert Más y selecciona Ver.

5. En el diálogo Detalles de la consulta, verás la consulta y las opciones para ejecutarla, transmitirla o guardarla como:

   • Para guardar la consulta, haz lo siguiente:

     1. Haz clic en Guardar consulta.
     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 del 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