Cómo mostrar 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 registro y error en el mismo contexto que tus datos de métricas. El widget del panel de registros muestra las entradas de registro. En el widget del panel de informes de errores, se muestran 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 el 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. Dado que los widgets del panel de registros se pueden agregar a paneles personalizados, proporcionan una forma de ver las 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 roles de Identity and Access Management (IAM) en los recursos que almacenan las entradas de registro determinan si puedes ver las entradas de registro almacenadas.

El Explorador de registros y el widget del panel de registros están preconfigurados para buscar entradas de registro en los recursos que se enumeran en el ámbito de registros predeterminado. Si no se puede acceder a ese alcance, se buscan las entradas de registro que se originan en el proyecto seleccionado. Cuando se selecciona un proyecto, los resultados de la búsqueda incluyen las entradas de registro que un receptor en otro proyecto enruta al proyecto y, luego, se almacenan en un bucket de registros. Puedes configurar los recursos en los que se buscan entradas de registro. Por ejemplo, puedes buscar entradas de registro por vista de registro.

Los widgets del panel de registros muestran una entrada de registro por fila, con columnas para la gravedad, la marca de tiempo y un resumen de la entrada de registro. Para ver la representación en 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:

En la imagen anterior, la primera entrada de registro muestra información sobre una solicitud de servicio. El resumen muestra información sobre el servicio, una dirección de correo electrónico y una versión con formato de cadena de la estructura JSON de 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:

• Conceptos básicos
• Lenguaje de consulta de Logging
• Explorador de registros

Antes de comenzar

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

• Editor de Monitoring (roles/monitoring.editor) en tu proyecto
• Visualizador de registros (roles/logging.viewer) en cada proyecto cuyas entradas de registro deseas ver Este rol no te otorga acceso a todas las entrada de registro. Para obtener más información sobre los roles, consulta Control de acceso de Cloud Logging con IAM.
• Descriptor de acceso de vista de registros (roles/logging.viewAccessor) en cada proyecto que almacena el bucket de registros de una vista de registros a la que deseas acceder El rol de Acceso a la vista de registros otorga acceso a todas las vistas de registros que almacena el proyecto. Para obtener información sobre cómo obtener acceso a vistas de registros específicas, consulta Controla el acceso a una vista de registros.

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Cómo mostrar entradas de registro en un panel

En esta sección, se describe cómo agregar y configurar un widget de 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.

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.

   Dirígete a Paneles de control

   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 cuadro de diálogo Agregar widget, selecciona  Registros.
5. Opcional: Para actualizar el título, ingresa el nuevo en el campo Título del widget.

6. Configura en qué recursos se buscan entradas de registro:

   • Para buscar por proyecto, establece la entrada Alcance por en Proyecto, luego expande la entrada Proyectos y completa el diálogo.

     Nota: Debes expandir el menú Projects y seleccionar al menos un proyecto. No se seleccionan proyectos automáticamente.

     En el menú Proyectos, se enumeran todos los proyectos de Google Cloud en el permiso de las métricas actual. Si una entrada del menú incluye el texto "No tienes permiso a nivel del proyecto para ver los registros de este proyecto", es decir, no tienes los permisos necesarios para ver las entradas de registro disponibles en ese proyecto de Google Cloud.

     Las entradas de registro que se muestran incluyen aquellas que se originan en tu proyecto de Google Cloud y aquellas que un receptor de otro proyecto enruta a tu proyecto de Google Cloud.

   • Para buscar entradas de registro por vistas de registro en buckets de registros, establece la entrada Alcance por en Almacenamiento y, luego, expande la entrada Vistas de almacenamiento y completa el diálogo.

     Nota: Debes expandir el menú Vistas de almacenamiento y seleccionar al menos una vista de registro. No se seleccionan vistas de registro automáticamente.

     En el menú Vistas de almacenamiento, se enumeran las vistas de registro en los buckets de registro de tu proyecto de Google Cloud seleccionado.

     Para seleccionar vistas de registro en buckets de registro en otros proyectos de Google Cloud, en el menú, haz clic en Import project, selecciona un proyecto y, luego, selecciona una o más vistas de registro. Solo puedes importar proyectos que se incluyan en el permiso de métricas actual.

     Nota: Cuando el usuario actual no tiene permiso para acceder a todas las vistas de registro que un widget del panel de registros busca entradas de registro, el widget muestra un error. Para obtener más información, consulta El panel de registros muestra un mensaje de permiso denegado.

   • Para buscar los recursos incluidos en un ámbito de registro, que puede incluir proyectos y vistas de registro, configura la entrada Ámbito por en Ámbito de registro y, luego, expande la entrada Ámbitos de registro y selecciona un ámbito de registro.

     Los permisos de registro están en versión preliminar pública.

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 que las consultas se ejecuten automáticamente, haz clic en Ejecutar consulta. Para obtener una breve introducción a las consultas, consulta Ejemplos de consultas.

8. Opcional: Aplica variables al widget del panel de registros. Las variables son filtros a nivel del panel que se aplican solo a widgets específicos. Para obtener más información, consulta Cómo aplicar una variable a un widget.

9. Para aplicar los cambios en el panel, en la barra de herramientas, haz clic en Aplicar. 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 entradas de registro. También puedes usar la barra de filtros del widget para cambiar temporalmente las entradas de registro que muestra. Para obtener más información, consulta la sección Cómo filtrar las entradas de registro.

Ejemplos de consultas

Para propagar el campo Editor de consultas, puedes ingresar texto en el campo o hacer selecciones en los menús. El campo Editor de consultas 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 sentencia 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 bien navegar por las ventanas para seleccionar un método específico.

Por ejemplo, para agregar una consulta de Recurso auditado, haz lo siguiente:

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

3. Haz clic en Aplicar.

   Estos pasos agregan la siguiente cláusula al campo Query Editor:

   resource.type="audited_resource"
   

Del mismo modo, para agregar una consulta para los registros de auditoría de las funciones de Cloud Run, 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.

   Estos pasos agregan la siguiente cláusula al campo Query Editor:

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

Filtra las entradas de registro

Para modificar las entradas de registro que muestra un widget del panel de registros, modifica 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 especificado por este campo.

• Campo Filtro en el widget del panel de registros: El filtro que especifiques se aplicará después de que se complete la consulta. El valor de este campo se conserva solo para la sesión actual.

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

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

  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 del panel, la configuración del filtro se aplica a la consulta del widget del panel de registros. Por ejemplo, si agregas el filtro de panel cluster_name: mycluster, la consulta se actualiza 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 para filtrar tus entradas de registro.

Ejemplo: Filtra las 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 1H. Siempre que no selecciones un intervalo de tiempo personalizado, el widget siempre mostrará los registros más recientes, incluso si son anteriores al período seleccionado.

Cuando investigues un incidente, te recomendamos que restrinjas las entradas de registro a aquellas que se encuentran en un intervalo de tiempo específico. Para configurar las entradas de registro en los registros de visualización que se encuentran en un intervalo de tiempo fijo, haz una de las siguientes acciones o ambas:

• Selecciona un intervalo de tiempo con el selector correspondiente.
• 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 las 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. Para configurar un widget de panel de registros para que muestre solo las entradas de registro que satisfagan niveles de gravedad específicos, haz una de las siguientes opciones o ambas:

• Para aplicar un filtro temporal, selecciona un valor para el menú Gravedad en el widget del panel de registros. Este menú especifica un nivel de gravedad mínimo. Por ejemplo, un valor de "Advertencia" hace que se recuperen las entradas de registro con una gravedad de "Error", pero no se recuperan las entradas de registro con una gravedad de "Aviso". De forma predeterminada, el valor de este campo se establece en Default, que incluye todas las entradas de registro.

  El parámetro de 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 las entradas de registro por una cadena o frase

Filtrar las entradas de registro por una cadena o frase específica te permite eliminar de la vista las entradas de registro que no te interesan. 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 Filtrar . La prueba contains no distingue mayúsculas de minúsculas.

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

  • 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 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 las consultas, consulta Lenguaje de consulta de Logging.

  Por ejemplo, para mostrar solo aquellas entradas de registro con un campo MESSAGE cuyo valor contiene la cadena "lámpara", 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 las 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 diálogo, selecciona el proyecto de Google Cloud en el que deseas abrir el Explorador de registros.

   Se abrirá el Explorador de registros en una pestaña nueva del navegador, y los filtros que seleccionaste en el widget del panel de registros se aplicarán automáticamente.

3. Selecciona la entrada de registro que deseas ver.

Cómo mostrar gráficos generados a partir de una consulta de Log Analytics

Vista previa

Esta función está sujeta a las "Condiciones de las Ofertas de Fase Previa a la DG" de la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Las funciones de fase previa a la DG están disponibles “tal cual” y podrían tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

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

Además de usar la página de Log Analytics para configurar y guardar gráficos en un panel, puedes guardar un gráfico de Log Analytics directamente en Supervisión. Para ello, sigue estos pasos:

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

   Dirígete a Paneles de control

   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 cuadro de diálogo Agregar widget, ve a la sección Datos y, luego, selecciona Log Analytics.

5. En el panel Configurar widget, configura los datos que se mostrarán y, luego, haz clic en Ejecutar consulta.

   Para seleccionar los datos que se mostrarán, puedes compilar una consulta en SQL o seleccionar una consulta guardada o reciente.

6. Opcional: En la pestaña Resultados, usa el panel Visualización para personalizar la configuración del gráfico.

   En el panel Visualización, puedes cambiar el tipo de gráfico y personalizar las filas y columnas que se grafican cambiando 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 cadena. De forma predeterminada, la dimensión se establece en la primera columna basada en la marca de tiempo del esquema. Si no hay ninguna marca de tiempo en la consulta, se selecciona la primera columna de cadena como la 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 la dimensión, el gráfico muestra cómo cambian los datos con el tiempo.

   • Métrica: Puedes seleccionar varias métricas en el panel Visualización del gráfico. Cuando seleccionas una medida, también debes seleccionar la función de agregación que se 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 de los gráficos, consulta Cómo personalizar la configuración de los gráficos.

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

Los gráficos de Log Analytics también se pueden editar después de guardarlos en un panel. Para obtener más información, consulta Cómo modificar la configuración de un widget.

Cómo mostrar 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 con 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.

   Dirígete a Paneles de control

   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 Panel de informes de errores.
5. Selecciona el proyecto cuyos grupos de errores se muestran, extiende Projects y, luego, haz una selección.
6. Opcional: Actualiza el título.

7. Opcional: Para 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 Aplicar o usar los menús adicionales para definir mejor los criterios de filtro:

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

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

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

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

   

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

Solucionar problemas

• El panel de registros indica que muestra datos parciales
• El panel de registros informa una consulta no válida
• El panel de registros muestra el mensaje "No se encontraron entradas".

¿Qué sigue?

• Si deseas obtener información sobre cómo Cloud Monitoring proporciona visibilidad a las métricas y los registros almacenados en varios proyectos de Google Cloud, consulta la descripción general del permiso de métricas.

• Si deseas obtener información para configurar un panel que muestre registros o errores con la API, consulta lo siguiente:

  • Panel con un widget LogsPanel.
  • Panel con un widget ErrorReportingPanel.

• Para obtener más información sobre los grupos de errores, consulta la descripción general de Error Reporting.