Muestra registros y errores en un panel personalizado

En este documento, se describen los widgets que puedes agregar a tus paneles personalizados para que puedas ver tus datos de registros y errores en el mismo contexto que tus datos de métricas. El widget del panel de registros muestra las entradas de registro. El widget del panel de informes de errores muestra los grupos de errores más recientes. Ambos widgets proporcionan información que puede ser útil para solucionar problemas. El widget de gráfico de Análisis de registros, que muestra los resultados de una consulta en SQL, te permite identificar tendencias en tus datos de registro.

Explorador de registros y widget del panel de registros

El Explorador de registros es la forma estándar de investigar los registros. Agregar un widget del panel de registros a un panel no cambiará la forma en que usas el Explorador de registros. Debido a que los widgets del panel de registros se pueden agregar a paneles personalizados, proporcionan una forma de ver tus entradas de registro en el mismo contexto que tus métricas.

El explorador de registros y el widget del panel de registros admiten el mismo lenguaje de consulta y ambos muestran solo las entradas de registro que tienes permiso para ver. Tus funciones de Identity and Access Management (IAM) en los recursos que almacenan las entradas de registro que se recuperan se usan para determinar si puedes ver esas entradas de registro.

El Explorador de registros y el widget del panel de registros están preconfigurados para recuperar de los buckets de registros las entradas de registro que se originan en tu proyecto actual de Google Cloud o que se enrutan a tu proyecto actual. Puedes configurar qué entradas de registro se recuperan. Por ejemplo, puedes especificar que las entradas de registro de una vista de registro se recuperen para mostrarse.

Los widgets del panel de registros muestran una entrada de registro por fila, con columnas de gravedad, la marca de tiempo y un resumen de la entrada de registro. Para ver la representación con formato JSON de una entrada de registro, haz clic en el botón Ver detalles del registro. La estructura del resumen de cada entrada varía según el tipo de registro. Por ejemplo, en la siguiente imagen, se muestran dos entradas de registro:

Imagen de dos entradas de registro en el widget del panel de registros.

En la foto anterior, la primera entrada de registroo muestra información sobre una solicitud de servicio. En el resumen, se muestra información sobre el servicio, una dirección de correo electrónico y una versión con formato de string de la estructura JSON para la entrada. La segunda entrada muestra los resultados de una solicitud y solo una oración que resume la acción que se produjo.

Para obtener información general sobre Cloud Logging, consulta los siguientes recursos:

Antes de comenzar

Si quieres obtener los permisos que necesitas para agregar un widget del panel de registros a un panel personalizado con la consola de Google Cloud y configurarlo para que muestre entradas de registro en proyectos o vistas de registro, pídele a tu administrador que te otorgue los siguientes roles de IAM:

Si quieres obtener más información para otorgar roles, consulta Administra el acceso.

Es posible que también puedas obtener los permisos necesarios a través de funciones personalizadas o, también, otras funciones predefinidas.

Muestra entradas de registro en un panel

En esta sección, se describe cómo agregar y configurar un widget del panel de registros con la consola de Google Cloud. Para obtener información sobre el uso de la API de Cloud Monitoring, consulta Panel con un widget LogsPanel.

Un widget del panel de registros está preconfigurado para recuperar entradas de registro que se originan en tu proyecto de Google Cloud y las que se enrutan a tu proyecto de Google Cloud. Sin embargo, puedes configurar qué entradas de registro recupera el widget del panel de registros de los buckets de registros. Por ejemplo, puedes configurar el widget para que solo muestre entradas de registro que indiquen algún tipo de condición de error o solo esas entradas de registro en una vista de registro.

Puedes colocar hasta 40 gráficos en un panel.

Para agregar un widget del panel de registros al panel mediante la consola, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Paneles.

    Ir a Paneles

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

  2. Selecciona un panel o haz clic en Crear panel.
  3. En la barra de herramientas, haz clic en  Agregar widget.
  4. En el diálogo Agregar widget, selecciona  Registros.
  5. Opcional: Para actualizar el título, ingresa el título nuevo en el campo Título del widget.

  6. Opcional: Para modificar qué entradas de registro se recuperan, realiza una de las siguientes acciones:

    • Para recuperar entradas de registro de un proyecto diferente o de varios proyectos, en la entrada Proyecto, expande Proyecto actual y completa el diálogo. El menú enumera todos los proyectos de Google Cloudd en el permiso de las métricas actuales.

      Si una entrada del menú incluye el texto “No tienes el permiso a nivel de proyecto para ver los registros de este proyecto”, no tienes los permisos necesarios para ver las entradas de registro del proyecto de Google Cloud.

    • Para recuperar las entradas de registro incluidas en las vistas de registro de los buckets de registros, haz lo siguiente:

      1. En la entrada Limitar alcance por, expande Proyecto y, luego, selecciona Almacenamiento.
      2. En la entrada Vistas de almacenamiento (Storage views), expande Proyecto actual (Current project) y completa el cuadro de diálogo. El menú muestra las vistas de registros en los buckets de registros de tu proyecto de Google Cloud. Para seleccionar vistas de registro en los buckets de registros en otros proyectos de Google Cloud, en el menú, haz clic en Importar proyecto, selecciona un proyecto y, luego, una o más vistas de registro. Solo puedes importar proyectos que se incluyan en el permiso de métricas actual.

  7. Opcional: Para restringir los registros que muestra el widget del panel de registros, ingresa una consulta en el campo Editor de consultas y, si inhabilitaste la ejecución automática de consultas, haz clic en Ejecutar consulta. Para obtener una breve introducción a las consultas, ve a Ejemplos de consultas.

  8. Opcional: Aplica variables de plantilla al widget del panel de registros. Para obtener más información, consulta Agrega filtros permanentes a un panel personalizado.

  9. Para aplicar los cambios en el panel, haz clic en Apply en la barra de herramientas. Para descartar los cambios, haz clic en Cancelar.

  10. Para guardar el panel modificado, haz clic en Guardar en la barra de herramientas.

    El widget del panel de registros muestra una tabla de las entradas de registro recuperadas que también coinciden con tu consulta. También puedes usar la barra de filtros del widget para cambiar de forma temporal las entradas de registro que muestra el widget. Para obtener más información, consulta la sección Filtra las entradas de registro.

Ejemplos de consultas

Para propagar el campo Editor de consultas, puedes ingresar texto en el campo o puedes realizar selecciones desde los menús. En el campo Editor de consultas, se usa el mismo lenguaje de consulta que el Explorador de registros. Para obtener información sobre la solución de problemas, consulta Problemas de sintaxis.

Los menús Gravedad y Nombre del registro te permiten seleccionar varias opciones. El siguiente es un ejemplo de una declaración de consulta que coincide con varios niveles de gravedad:

severity=(WARNING OR ERROR OR CRITICAL OR ALERT OR EMERGENCY)

El menú Recurso te permite filtrar por recurso. Puedes seleccionar un tipo de recurso, como Recurso auditado, o puedes navegar por las ventanas para seleccionar un método específico.

Por ejemplo, para agregar una consulta para Audited Resource, haz lo siguiente:

  1. Expande el menú Recurso.
  2. Busca y selecciona Recurso auditado.

  3. Haz clic en Aplicar.

    Con estos pasos, se agrega la siguiente cláusula al campo Editor de consultas:

    resource.type="audited_resource"

De manera similar, si quieres agregar una consulta para los registros de auditoría de Cloud Functions, haz lo siguiente:

  1. Expande el menú Recurso.
  2. Busca y selecciona Recurso auditado.
  3. En el menú de servicios, selecciona Cloud Functions.

  4. Haz clic en Aplicar.

    Con estos pasos, se agrega la siguiente cláusula al campo Editor de consultas:

    resource.type="audited_resource" resource.labels.service="cloudfunctions.googleapis.com"

Filtra las entradas de registro

Puedes modificar qué entradas de registro muestra un widget del panel de registros si modificas los valores de los siguientes campos o menús:

  • Selector de hora del panel: el widget del panel de registros solo recupera las entradas de registro que se escriben en el intervalo que especifica este campo.

  • Campo Filter en el widget del panel de registros: el filtro que especifiques se aplica una vez que se completa la consulta. El valor de este campo se conserva solo durante la sesión actual.

  • Menú Gravedad en el widget del panel de registros: el filtro por nivel de gravedad se aplica una vez que se completa la consulta. El valor de este campo se conserva solo durante la sesión actual.

  • Consulta en el widget del panel de registros: el widget del panel de registros muestra solo las entradas de registro que coinciden con la consulta. Si no especificas una consulta, se mostrarán todos los registros en el intervalo de tiempo seleccionado. Si especificas una consulta, el widget del panel de registros mostrará el ícono Mostrar consulta, que muestra la consulta actual como información sobre la herramienta.

    Para modificar la consulta, edita el widget del panel de registros.

  • Proyecto de Google Cloud en el widget del panel de registros: para modificar este parámetro de configuración, edita el widget del panel de registros.

  • Filtros del panel: cuando existen filtros de panel, la configuración del filtro se aplica a la consulta del widget del panel de registros. Por ejemplo, si agregas el filtro del panel cluster_name: mycluster, la consulta se actualizará para incluir resource.labels."cluster_name"="mycluster". Para obtener más información sobre los filtros del panel, consulta Agrega filtros temporales y Agrega filtros permanentes.

En el resto de esta sección, se proporciona información adicional sobre cómo filtrar tus entradas de registro.

Ejemplo: filtra entradas de registro por fecha

Para mostrar los registros más recientes en un widget del panel de registros, usa los campos de tiempo en la barra de herramientas del panel. Por ejemplo, selecciona 1 H. Siempre que no selecciones un intervalo de tiempo personalizado, el widget siempre mostrará los registros más recientes, incluso cuando sean más antiguos que el período seleccionado.

Cuando investigas un incidente, es posible que desees restringir las entradas de registro a aquellas entradas que se encuentran en un intervalo de tiempo específico. Si deseas configurar las entradas de registro para que muestren registros en un intervalo de tiempo fijo, realiza una de las siguientes acciones o ambas:

  • Selecciona un intervalo de tiempo con el selector de intervalo de tiempo.
  • Ingresa una cláusula timestamp en el campo Editor de consultas del panel de configuración y, luego, selecciona Aplicar filtro.

Cuando especificas un intervalo de tiempo, el widget del panel de registros no se actualiza automáticamente.

Ejemplo: Filtra entradas de registro por gravedad

Cuando supervises la depuración de una situación de falla, es posible que solo quieras ver los mensajes de error y ocultar de la pantalla todas las demás entradas de registro. Si deseas configurar un widget del panel de registros para que muestre solo las entradas de registro que cumplen con los niveles de gravedad específicos, realiza una de las siguientes acciones o ambas:

  • A fin de aplicar un filtro temporal, selecciona un valor para el menú Gravedad en el widget del panel de registros. En este menú, se especifica un nivel de gravedad mínimo. Por ejemplo, un valor de “Advertencia” hará que se recuperen las entradas de registro con la gravedad de “Error”, pero no se recuperarán esas entradas de registro con la gravedad “Aviso”. De forma predeterminada, el valor de este campo se establece en Default, que incluye todas las entradas de registro.

    La configuración del menú Gravedad se descarta cuando sales del panel.

  • Para aplicar un filtro permanente, ingresa una cláusula severity en el campo Editor de consultas del panel de configuración y, luego, selecciona Aplicar filtro.

Ejemplo: filtra entradas de registro por una string o frase

Filtrar entradas de registro por una string o frase específica te permite eliminarlas de la vista de entradas de registro que no son de interés. Por ejemplo, para ver las entradas de registro que incluyen una dirección de correo electrónico específica,

  • Si deseas aplicar un filtro temporal para ver solo las entradas de registro que contienen una palabra o frase específica, usa el campo Filtro. El elemento contiene-prueba no distingue mayúsculas de minúsculas.

    Si agregas varios filtros, solo se muestran los registros que coinciden con todos los filtros porque se inserta un AND implícito entre los filtros adyacentes. Sin embargo, puedes insertar de forma explícita un operador OR:

    • Por ejemplo, cuando agregas los filtros Get y Compute, se muestran entradas de registro que contienen ambas palabras.

    • Por ejemplo, cuando agregas los filtros Get, OR y Compute, se muestran las entradas de registro que contienen Get o Compute.

    El valor del campo de Filtro no es persistente.

  • Para aplicar un filtro permanente, modifica la consulta almacenada en el campo Editor de consultas y, luego, selecciona Aplicar filtro. Para obtener información sobre la sintaxis de consulta, visita Lenguaje de consulta de Logging.

    Por ejemplo, para mostrar solo esas entradas de registro con un campo MESSAGE cuyo valor contiene la string “lamp”, agrega la cláusula jsonPayload.MESSAGE:"lamp" al campo Editor de consultas.

Visualiza entradas de registro en el Explorador de registros

Los widgets del panel de registros muestran campos clave de entradas de registro, no la entrada de registro completa. Para examinar todos los campos de una entrada de registro, haz lo siguiente:

  1. En el widget del panel de registros, selecciona Ver en el Explorador de registros.

  2. En el cuadro de diálogo, selecciona el proyecto de Google Cloud en el que deseas abrir el Explorador de registros.

    El Explorador de registros se abre en una pestaña nueva del navegador, y los filtros que seleccionaste en el widget del panel de registros se aplican automáticamente.

  3. Selecciona la entrada de registro que quieres ver.

Mostrar gráficos generados a partir de una consulta de Análisis de registros

En esta sección, se describe cómo configurar y guardar un gráfico generado a partir de una consulta de Análisis de registros en un panel personalizado. El Análisis de registros te permite buscar y agregar registros para generar estadísticas útiles mediante consultas en SQL.

Además de usar la página de Análisis de registros para configurar y guardar gráficos en un panel, puedes guardar un gráfico de Análisis de registros directamente en Monitoring si haces lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Paneles.

    Ir a Paneles

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

  2. Selecciona un panel o haz clic en Crear panel.
  3. En la barra de herramientas, haz clic en  Agregar widget.
  4. En el diálogo Agregar widget, ve a la sección Datos y luego selecciona Análisis de registros.
  5. En el panel Configure widget, configura los datos que se mostrarán en el gráfico. Para ello, compila una consulta con SQL y, luego, haz clic en Ejecutar consulta.

  6. Opcional: En la pestaña Resultados, personaliza la configuración del gráfico con el panel Mostrar.

    En el panel Display, puedes cambiar el tipo de gráfico y personalizar las filas y columnas que se representan. Para ello, cambia la dimensión, la medida y el desglose:

    • Dimensión: La dimensión debe ser una columna de marca de tiempo, numérica o de cadenas. De forma predeterminada, la dimensión se establece en la primera columna basada en marca de tiempo del esquema. Si no hay una marca de tiempo presente en la consulta, entonces, la primera columna de cadena se selecciona como la dimensión. También puedes personalizar cuál es la dimensión en el panel Visualización del gráfico. Cuando se selecciona una columna de marca de tiempo como la dimensión, el gráfico muestra cómo cambian los datos con el tiempo.

    • Medir: Puedes seleccionar varias mediciones en el panel Gráfico de visualización. Cuando seleccionas una medición, también debes seleccionar la función de agregación para realizar en sus valores agrupados, como count, sum, average y percentile-99. Por ejemplo, count-distinct muestra la cantidad de valores únicos en una columna determinada.

    • Desglose: Para dividir una sola serie de datos en varias series de datos en función de otra columna, agrega un desglose.

    Para obtener más información sobre cómo personalizar la configuración del gráfico, consulta Personaliza la configuración del gráfico.

  7. Para guardar el panel modificado, haz clic en Guardar en la barra de herramientas.

Los gráficos del Análisis de registros también se pueden editar después de guardarlos en un panel. Para obtener más información, consulta Modifica la configuración de un widget.

Muestra errores en un panel

En esta sección, se describe cómo agregar y configurar un panel de informes de errores con la consola de Google Cloud. Para obtener información sobre cómo agregar un panel de informes de errores a un panel mediante la API de Cloud Monitoring, consulta Panel con un widget ErrorReportingPanel.

Para agregar un panel de informes de errores al panel con la consola, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Paneles.

    Ir a Paneles

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

  2. Selecciona un panel o haz clic en Crear panel.
  3. En la barra de herramientas, haz clic en  Agregar widget.
  4. En el diálogo Agregar widget, ve a la sección Visualización y, luego, selecciona el panel Error Reporting.
  5. Selecciona el proyecto cuyos grupos de errores se muestran, expande Projects y, luego, realiza una selección.
  6. Opcional: Actualiza el título.

  7. Opcional: Si deseas restringir los recursos para los que se muestran errores, haz lo siguiente:

    1. Expande Todos los recursos y selecciona un recurso.

    2. Después de seleccionar un recurso, puedes seleccionar Apply o usar los menús adicionales para definir mejor los criterios del filtro:

      • Para mostrar errores de los recursos de App Engine, selecciona Servicios de GAE y, luego, haz clic en Aplicar.

      • Para mostrar errores de un servicio específico de App Engine, selecciona Servicios de GAE, elige el servicio y, luego, haz clic en Aplicar.

  8. Para aplicar los cambios en el panel, haz clic en Apply en la barra de herramientas. Para descartar los cambios, haz clic en Cancelar.

    En el siguiente ejemplo, se muestra un panel de Error Reporting:

    Ejemplo de un panel de configuración de un panel de informes de errores.

  9. Para guardar el panel modificado, haz clic en Guardar en la barra de herramientas.

Solucionar problemas

¿Qué sigue?