Mostrar registros y errores en un panel personalizado

En este documento, se describe cómo mostrar datos de registro y datos de errores en tus paneles personalizados.

Para mostrar datos de registro, puedes agregar los siguientes widgets a tu panel:

  • Para mostrar las entradas de registro más recientes en tu proyecto actual de Google Cloud, agrega un widget de panel de registros. También puedes configurar el panel de registros para mostrar entradas de registro almacenadas en proyectos de Google Cloud a los que se puede acceder a través del permiso de métricas actual.

  • Para identificar patrones y tendencias en tus datos de registro, agrega un widget de gráfico de análisis de registros que muestre los resultados de una consulta en SQL.

Para mostrar grupos de errores, puedes agregar un panel de informes de errores. En el panel Error Reporting, se muestran los grupos de errores más recientes para un solo proyecto de Google Cloud.

Cuando agregas un panel de registros y un panel de informes de errores a un panel personalizado, puedes ver tus registros y errores en el mismo contexto que tus métricas. Debido a que el panel de registros te permite filtrar las entradas de registro, puedes configurarlo para que muestre solo las entradas de registro que te interesen. De manera similar, el panel Error Reporting te permite identificar errores y solucionar la causa de la falla.

Explorador de registros y paneles de registros

El Explorador de registros es la forma estándar de investigar los registros. Los paneles de registros no reemplazan al Explorador de registros, sino que proporcionan una manera de ver las entradas de registro en el mismo contexto que tus métricas.

Los paneles de registros muestran entradas de registro en filas con columnas para la 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 de cada resumen de entrada varía según el tipo de registro. Por ejemplo, en la siguiente imagen, se muestran dos entradas de registro:

Una imagen de dos entradas de registro en el panel de registros.

En la imagen anterior, la primera entrada de registro 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 muestra una oración que resume la acción que se produjo.

Los paneles de registros están preconfigurados para mostrar las entradas de registro almacenadas en tu proyecto actual de Google Cloud. Sin embargo, puedes configurar un panel de registros para mostrar las entradas de registro almacenadas en cualquier proyecto en el permiso de métricas actual.

Los paneles de registros admiten el mismo lenguaje de consulta que el Explorador de registros.

Los paneles de registros no admiten vistas de almacenamiento. Cuando tus registros solo estén disponibles a través de una vista de almacenamiento, usa el Explorador de registros. Para obtener más información sobre las vistas de almacenamiento, consulta Define mejor el permiso.

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 de registros a un panel personalizado con la consola de Google Cloud, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

    • Editor de Monitoring (roles/monitoring.editor)
    • Visualizador de registros (roles/logging.viewer) en cada proyecto cuyas entradas de registro deseas ver. En los paneles, no se muestran las entradas de registro de los proyectos en los que no tienes los permisos para ver los registros. Si deseas obtener más información sobre los roles que necesitas para ver las entradas de registro, consulta Control de acceso de Cloud Logging con 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 los roles personalizados o de otros roles predefinidos.

  • Puedes colocar hasta 40 gráficos en un panel.

Panel Agregar y configurar registros

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

Agrega un panel de registros

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

  1. En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego,  Paneles:

    Ir a Paneles

  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: Actualiza la configuración predeterminada:

    1. Agrega un título.

    2. Para mostrar los registros de varios proyectos de Google Cloud en lugar del proyecto actual, haz clic en Proyectos y, luego, realiza tus selecciones.

    3. Para restringir los registros que muestra el panel de registros, ingresa una consulta en el campo Editor de consultas.

    Para obtener más información sobre los pasos anteriores, consulta Configura un panel de registros:

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

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

De forma predeterminada, en el panel de registros se muestra una tabla de entradas de registro. Puedes usar el menú Gravedad y la configuración de la barra de filtros para cambiar temporalmente los registros que se muestran. También puedes modificar el tamaño y la posición del panel de registros con el puntero.

Configura un panel de registros

Los paneles de registros están preconfigurados para mostrar todas las entradas de registro almacenadas en el proyecto actual de Google Cloud. Sin embargo, es posible que solo te interesen las entradas de registro que indiquen algún tipo de condición de error o que desees ver los registros de varios proyectos. En esta sección, se describe cómo modificar la configuración predeterminada de un panel de registros.

Para configurar el título, la lista de proyectos cuyos registros se muestran o para ingresar una consulta, haz lo siguiente:

  1. Coloca el puntero en el panel de registros para activar la barra de herramientas y, luego, selecciona  Editar widget.

    La siguiente captura de pantalla es un ejemplo del panel de configuración:

    Ejemplo de un panel de configuración del panel de registros.

  2. Opcional: Agrega un título, que se muestra en el panel de registros.

  3. Opcional: Para mostrar registros de varios proyectos de Google Cloud, haz clic en Proyectos y, luego, realiza tus selecciones.

    De forma predeterminada, solo se muestran las entradas de registro del proyecto actual de Google Cloud. Sin embargo, un panel de registros puede mostrar registros para cualquier proyecto de Google Cloud al que se puede acceder a través del permiso de métricas actuales.

    Cuando no tienes permiso para ver los registros de un proyecto de Google Cloud, en el menú Proyectos se muestra el mensaje “No tienes permiso para ver los registros de este proyecto”. Para resolver el error de permiso, comunícate con el administrador del sistema y pídele que te otorgue la función de Visor de registros (roles/logging.viewer) en el proyecto.

  4. Opcional: Para restringir los registros que muestra el panel de registros, ingresa una consulta en el campo Editor de consultas.

    Si inhabilitaste las consultas para que no se ejecuten de forma automática, haz clic en Ejecutar consulta después de ingresar tu consulta.

    Para propagar el Editor de consultas, puedes ingresar texto en el campo o puedes hacer selecciones desde los menús. El campo Editor de consultas usa el mismo lenguaje de consulta que el Explorador de registros. Para obtener información sobre cómo solucionar 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 activa menús adicionales y un botón Agregar después de seleccionar un recurso individual. Este menú te permite seleccionar un tipo de recurso, un servicio para un tipo de recurso específico o un método para un servicio para un tipo de recurso. Por ejemplo, para agregar una cláusula para el tipo de recurso auditado, selecciona Recurso auditado y, luego, Agregar. Con estos pasos, se agrega la siguiente cláusula al campo Editor de consultas:

     resource.type="audited_resource"
    

    De manera similar, si deseas agregar una cláusula para un servicio específico auditado, selecciona Recurso auditado, elige el servicio en el menú Todos los servicios y luego selecciona Agregar. El siguiente es un ejemplo de una cláusula que se crea mediante este enfoque:

     resource.type="audited_resource" resource.labels.service="bigquery.googleapis.com"
    
  5. Aplica variables de plantilla al panel de registros (opcional). Para obtener más información, consulta Cómo agregar filtros temporales a un panel personalizado y Cómo aplicar un filtro permanente a un widget.

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

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

Filtra las entradas de registro

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

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

  • Campo de filtro en el panel de registros: el filtro que especifiques se aplicará una vez que se complete la consulta. El valor de este campo se retiene solo para la sesión actual.

  • Menú Gravedad en el 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 para la sesión actual.

  • Consulta especificada por el panel de registros: El campo de consulta determina qué registros se recuperan. Si no especificas una consulta, se recuperan todos los registros del intervalo de tiempo seleccionado. Si especificas una consulta, el panel de registros mostrará el ícono Mostrar consulta, que muestra la consulta actual como información sobre la herramienta.

    Para modificar la consulta, realiza una de las siguientes acciones:

    • Para cambiar la consulta de forma permanente, edita el panel de registros.
    • Para cambiar temporalmente la consulta, usa la barra de herramientas del panel para agregar un filtro en una etiqueta de recurso. Por ejemplo, si agregas el filtro de todo el panel cluster_name: mycluster, entonces la consulta se actualiza para incluir resource.labels."cluster_name"="mycluster". Para obtener más información, consulta Cómo agregar filtros temporales y Cómo agregar filtros permanentes.
  • Proyecto de Google Cloud especificado en el panel de registros: Para modificar este parámetro de configuración, edita el panel de registros.

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

Filtrar entradas de registro por fecha

Para mostrar los registros más recientes en un panel de registros, usa los campos de tiempo en la barra de herramientas del panel. Por ejemplo, selecciona 1H. Siempre que no selecciones un intervalo de tiempo personalizado, el panel de registros 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 están en un intervalo de tiempo específico. Si deseas configurar las entradas de registro para que se muestren los registros que se encuentran 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 panel de registros no se actualiza automáticamente.

Filtra las entradas de registro por gravedad

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

  • Si deseas aplicar un filtro temporal, selecciona un valor para el menú Gravedad en el panel de registros. En este menú, se especifica un nivel de gravedad mínimo. Por ejemplo, un valor de “Warning” da como resultado entradas de registro con una gravedad de “Error” que se recuperan, pero esas entradas de registro con una gravedad de “Aviso” no se recuperan. De forma predeterminada, el valor de este campo se establece en Default, lo 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.

Filtrar entradas de registro por una cadena o frase

Filtrar las entradas de registro por una string o frase específica te permite eliminar de la vista las 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, puedes filtrar por esa dirección.

  • Para aplicar un filtro temporal de modo que solo veas las entradas de registro que contengan una palabra o frase específica, usa el campo Filtro. La prueba contiene no distingue mayúsculas de minúsculas.

    Si agregas varios filtros, solo se mostrarán los registros que coincidan 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 las 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 Filter 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 las consultas, consulta Lenguaje de consulta de Logging.

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

Configuración de ejemplo

Estos son algunos parámetros de configuración de muestra:

  • Para ver los registros más recientes, establece la barra de herramientas del panel en 1H, deja el campo Editor de consultas vacío y deja los campos del panel de registros con sus valores predeterminados.

  • Para mostrar de forma temporal solo los registros con un nivel de gravedad de al menos “Advertencia”, selecciona Advertencia en el menú Gravedad del panel de registros.

    El valor del menú Gravedad del panel de registros se restablece a Predeterminado cuando actualizas la página o sales del panel.

  • Si deseas configurar el panel de registros para que solo muestre los registros que tienen un nivel de gravedad de “Advertencia”, en el campo Editor de consultas, agrega la cláusula severity=WARNING.

    Se guardará la consulta almacenada en el campo del Editor de consultas. Incluso cuando actualizas la página o vuelves a cargar el panel, el panel de registros solo muestra los registros que coinciden con el nivel de advertencia especificado.

  • Si deseas configurar el panel de registros para mostrar solo los registros de instancias de Compute Engine, en el campo Editor de consultas, agrega la cláusula resource.type="gce_instance".

El mensaje “No se encontraron entradas que coincidan con el filtro actual” se muestra cuando ninguna entrada de registro cumple con la configuración actual. Cuando configuras una consulta en el campo Editor de consultas y también configuras los filtros del panel de registros, es posible que la configuración entre en conflicto. Para obtener más información, consulta El panel de registros muestra el mensaje “No se encontraron entradas”.

Visualiza entradas de registro en el Explorador de registros

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

  1. Selecciona Ver en el Explorador de registros en el panel 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 panel de registros se aplican automáticamente.

  3. Selecciona la entrada de registro que deseas ver.

Agrega 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 de la siguiente manera:

  1. En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego,  Paneles:

    Ir a Paneles

  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 Configurar widget, compila una consulta con SQL para configurar los datos que se mostrarán en el gráfico y, luego, haz clic en Ejecutar consulta.
  6. Opcional: En la pestaña Resultados, personaliza la configuración del gráfico con el panel Pantalla.

    En el panel Display, puedes cambiar el tipo de gráfico y personalizar qué filas y columnas se muestran si cambias 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 string. De forma predeterminada, la dimensión se establece en la primera columna basada en la marca de tiempo del esquema. Si no hay una marca de tiempo presente en la consulta, se selecciona la primera columna de string como dimensión. También puedes personalizar la dimensión en el panel Visualización del gráfico. Cuando se selecciona una columna de marca de tiempo como dimensión, el gráfico muestra cómo cambian los datos a lo largo del tiempo.

    • Medición: Puedes seleccionar varias mediciones en el panel Visualización del gráfico. 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 basadas en 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, en la barra de herramientas, haz clic en Guardar.

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.

Agrega un panel de informes de errores

En esta sección, se describe cómo agregar y configurar un panel de Error Reporting mediante 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 mediante la consola, haz lo siguiente:

  1. En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego,  Paneles:

    Ir a Paneles

  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 Panel de Error Reporting.
  5. Selecciona el proyecto cuyos grupos de errores se muestran, haz clic en Projects y, luego, elige una opción.
  6. Opcional: Actualiza el título.
  7. Opcional: Para restringir los recursos en los que se muestran errores, haz lo siguiente:

    1. Haz clic en Todos los recursos y selecciona un recurso.
    2. Después de seleccionar un recurso, puedes elegir Aplicar o usar los menús adicionales para definir mejor los criterios del filtro:

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

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

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

    En el siguiente ejemplo, se muestra un panel de informes de errores:

    Ejemplo de un panel de configuración del panel de Error Reporting.

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

Solución de problemas

¿Qué sigue?