Cómo mostrar eventos en un panel

En este documento, se describe cómo configurar un panel para mostrar anotaciones de eventos. Un evento es una actividad, como una implementación o una falla, que afecta el funcionamiento de un sistema. Mostrar anotaciones de eventos puede ayudarte a correlacionar datos de diferentes fuentes cuando solucionas un problema.

Esta función solo es compatible con Google Cloud proyectos. Para las configuraciones de App Hub, selecciona el proyecto host o el proyecto de administración de App Hub.

Acerca de las anotaciones de eventos

Puedes mostrar eventos en la mayoría de los paneles que se enumeran en la página Paneles de la Google Cloud consola de. Del mismo modo, puedes configurar algunas pestañas Observabilidad específicas del servicio, como las de Compute Engine y Google Kubernetes Engine, para mostrar eventos. Para configurar los tipos de eventos que muestra un panel o una pestaña Observabilidad , puedes usar la Google Cloud consola. En el caso de los paneles que creas, que se clasifican como paneles personalizados, también puedes usar la API de Cloud Monitoring.

A menos que uses la API de Cloud Monitoring o realices una acción para guardar tus selecciones de tipo de evento, estas solo se aplicarán a tu sesión actual. Cuando usas la Google Cloud consola de, fijar tus selecciones las guarda.

Para obtener una lista de los tipos de eventos, las referencias de solución de problemas y otra información, consulta la página Tipos de eventos.

Tipos de eventos recomendados

Es posible que veas los siguientes tipos de eventos habilitados en un panel o una pestaña Observabilidad, incluso si no seleccionaste ningún tipo de evento:

• Alerta abierta.
• Incidente de Personalized Service Health, cuando la API de Service Health está habilitada.
• Para cada tipo de recurso con datos que se muestran en el panel, un tipo de evento.

Cuando un tipo de evento se agrega automáticamente, es un tipo de evento recomendado. Puedes dejar estos tipos de eventos en el estado recomendado, guardarlos en el JSON del panel o descartarlos, lo que quita la recomendación. Para determinar qué tipos de eventos se guardan, expande el menú Anotaciones y, luego, consulta la sección Fijado.

Cómo se identifican los eventos

Los paneles consultan diferentes fuentes de datos para identificar los eventos que se mostrarán en tu panel:

• Monitoring identifica los eventos de alertas. Los eventos de alertas proporcionan información sobre cuándo se abrieron los incidentes.

• Los eventos de Personalized Service Health se identifican mediante consultas que Monitoring envía a la API de Service Health. Estos eventos indican cuándo hay una interrupción en un Google Cloud servicio.

• Todos los demás tipos de eventos se identifican mediante el análisis de las entradas de registro que pasan por los receptores de Cloud Logging en tu Google Cloud proyecto. Estas entradas de registro incluyen las que genera tu proyecto y las que se enrutan a él. Para recibir una notificación cuando se produzca uno de estos eventos, puedes crear una política de alertas basada en registros. En la política de alertas, usa las consultas que se proporcionan en la página Tipos de eventos.

Cómo se muestran los eventos

Nota: Por motivos de rendimiento, los paneles limitan la cantidad de eventos que muestran. Cuando se alcanzan estos límites, los paneles solo muestran los eventos más recientes. Para ver eventos más antiguos, usa un período más corto o agrega filtros.

Para todos los eventos, a medida que ocurren, se anotan los gráficos de tu panel. Los eventos identificados mediante el análisis de las entradas de registro se muestran con una sola referencia de tiempo. Por el contrario, los eventos de Service Health se muestran con una hora de inicio y, luego, se cambia el fondo del gráfico durante la duración del evento. Estos eventos también muestran un ícono de corazón.

En la siguiente captura de pantalla, se ilustra un gráfico que muestra varios eventos que se identificaron mediante el análisis de entradas de registro y un evento de Service Health:

Como se muestra en la captura de pantalla anterior, la información sobre la herramienta de un evento incluye información como la siguiente:

• Nombre del evento
• Fecha y hora de inicio del evento
• Para los eventos de Service Health, chips que muestran la cantidad de productos y ubicaciones afectados Para enumerar los productos o las ubicaciones afectados, coloca el puntero sobre el chip correspondiente.
• Un botón Ver que, cuando se selecciona, abre una página que muestra más información sobre el evento. Por ejemplo, puede abrir el Explorador de registros para que puedas ver las entradas de registro o la página de detalles de un evento de Service Health.

Los filtros del panel, que limitan los datos que muestra un panel, suelen filtrar los datos y los eventos de series temporales.

Antes de comenzar

Completa lo siguiente para el Google Cloud proyecto en el que deseas ver eventos en los paneles:

• Para obtener los permisos que necesitas para ver y mostrar eventos en los paneles, y para crear políticas de alertas, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

  • Ver y crear paneles y políticas de alertas: Editor de Monitoring (roles/monitoring.editor).
  • Ver y mostrar eventos identificados a partir de entradas de registro que no son de acceso a datos que se crean en tu Google Cloud proyecto: Visualizador de registros (roles/logging.viewer)
  • Ver y mostrar eventos identificados a partir de cualquier entrada de registro que se cree en tu Google Cloud proyecto: Visualizador de registros privados (roles/logging.privateLogViewer).
  • Ver eventos de Service Health: Visualizador de Personalized Service Health (roles/servicehealth.viewer)

  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 a través de roles personalizados o cualquier otro rol predefinido.

• Si deseas mostrar eventos de Service Health en tu panel, habilita la API de Service Health:

  Roles necesarios para habilitar las APIs

  Para habilitar las APIs, necesitas el rol de IAM de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin), que contiene el permiso serviceusage.services.enable. Obtén más información para otorgar roles.

  Habilitar la API

Mostrar eventos

En esta sección, se describe cómo configurar un panel o una pestaña Observabilidad para mostrar eventos.

Configura paneles para mostrar eventos

En esta sección, se describe cómo configurar los paneles que se enumeran en la página Paneles de la Google Cloud consola para mostrar eventos.

Para obtener una lista de los tipos de eventos, las referencias de solución de problemas y las consultas que se pueden usar con el Explorador de registros o con las políticas de alertas basadas en registros, consulta la página Tipos de eventos.

Console

Para mostrar eventos en un panel, haz lo siguiente:

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

   Acceder a Paneles

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

2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. Para las configuraciones de App Hub, selecciona el proyecto host o el proyecto de administración de App Hub.
3. Selecciona el panel que deseas ver.
4. En la barra de herramientas del panel, haz clic en Anotaciones y selecciona los tipos de eventos que deseas que muestre tu panel.

5. Realiza una de las siguientes acciones:

   • Para guardar tus selecciones de modo que se muestren los eventos cuando vuelvas a cargar el panel, haz clic en Fijar seleccionados. Si tienes inhabilitado el guardado automático en tu panel, ve a la barra de herramientas del panel y haz clic en Guardar.

     Cuando fijas tus selecciones, modificas la definición JSON del panel. Por lo tanto, cuando se vuelve a abrir el panel, se cargan tus selecciones y el panel muestra anotaciones para los tipos de eventos correspondientes.

   • Para mostrar tus tipos de eventos solo para tu sesión actual, haz clic en Aplicar.

   Después de actualizar la lista de tipos de eventos que se mostrarán, Cloud Monitoring emite consultas, lo que tarda unos instantes y, luego, agrega las anotaciones a los gráficos del panel.

6. Para ver un resumen de un evento o acceder a vínculos a información adicional, usa el puntero para activar la información sobre la herramienta.

API

Para configurar un panel personalizado para mostrar eventos, incluye un campo annotations en el objeto Dashboard. El campo annotations contiene una instancia de un objeto DashboardAnnotations, que contiene dos campos:

• El campo defaultResourceName muestra los valores predeterminados a nivel del panel para los Google Cloud proyectos en los que se buscarán eventos. Si no especificas este campo, se buscará en el proyecto seleccionado.

• Un array de EventAnnotation objetos. Cada objeto contiene lo siguiente:

  • Un campo displayName, que te permite definir la etiqueta en el botón de activación específico del evento. Cuando no se especifica este campo o cuando el valor de este campo es una cadena vacía, se muestra el nombre predeterminado del evento.
  • Un campo enabled, que controla el valor del botón de activación del evento. Cuando es true, el botón de activación está en la posición on y los eventos se muestran en el panel. Cuando es false, el botón de activación está en la posición off.
  • Un campo eventType, que contiene un valor de la enumeración EventType.
  • Un campo filter, que te permite especificar una consulta para agregar a la consulta específica del evento. Cuando el valor de este campo es una cadena vacía, se usa la consulta específica del evento.
  • Un campo resourceNames, que te permite definir una lista de Google Cloud proyectos en los que se buscarán eventos. Cuando este campo es un array vacío, se busca en el proyecto seleccionado.

A continuación, se muestra un ejemplo de un objeto annotations para un evento de actualización de clúster. El campo filter de este ejemplo restringe los eventos a un clúster específico:

"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}

Para obtener información detallada sobre cómo usar la API de Cloud Monitoring para crear paneles, consulta Crea y administra paneles con la API y Ejemplo: Habilita eventos en paneles.

Configura la pestaña Observabilidad para mostrar eventos

En esta sección, se describe cómo configurar la pestaña Observabilidad para mostrar eventos. Algunos servicios, como Compute Engine y Google Kubernetes Engine, proporcionan una pestaña Observabilidad que muestra datos de métricas y registros.

Nota: No todas las pestañas Observabilidad se pueden configurar para mostrar eventos.

Console

Para configurar la pestaña Observabilidad para mostrar eventos, haz lo siguiente:

1. Ve a la pestaña Observabilidad de un servicio o producto.

   Por ejemplo, puedes ir a la página Clústeres de Kubernetes y, luego, seleccionar la pestaña Observabilidad. Del mismo modo, puedes ir a la página Cargas de trabajo de Kubernetes o a la página de detalles de una instancia de máquina virtual (VM) y, luego, seleccionar la pestaña Observabilidad.

2. Asegúrate de que el menú Panel esté configurado como Predefinido. Los eventos no se pueden mostrar en paneles personalizados.

3. En la barra de herramientas, haz clic en Anotaciones, y completa el diálogo.

   Después de actualizar la lista de eventos que se mostrarán, se emiten consultas para recuperar los datos del evento y, luego, se actualiza el panel.

   Cuando no se muestra el menú Anotaciones, no se puede configurar la pestaña para mostrar eventos.

API

No disponible.

Ver detalles del evento

Cuando ves un gráfico que muestra anotaciones de eventos, puedes usar los vínculos que se proporcionan en la información sobre la herramienta para acceder a información adicional.

Para acceder a los detalles sobre un evento específico, haz clic en Ver.

La Google Cloud página de la consola de que abre el botón Ver está determinada por el tipo de evento. Por ejemplo, para un evento de verificación de tiempo de actividad, este botón abre el panel de la verificación de tiempo de actividad. Para un tipo de evento diferente, es posible que se abra el Explorador de registros.

Crea políticas de alertas

Cuando los eventos se identifican mediante el análisis de las entradas de registro que pasan por los receptores de Cloud Logging en tu Google Cloud proyecto, puedes recibir una notificación cuando se produzcan estos eventos si configuras una alerta basada en registros. Las políticas de alertas basadas en registros consultan tus entradas de registro a medida que se reciben. Cuando la consulta muestra un resultado no vacío, se crea un incidente y se envían notificaciones.

Console

Nota: Para crear una política de alertas para un evento que estás viendo, activa la información sobre la herramienta del evento, haz clic en Ver registros y, luego, continúa con el paso de creación de alertas en el siguiente procedimiento.

Para crear una alerta basada en registros, haz lo siguiente:

1. Si no configuraste un canal de notificaciones, haz lo siguiente:

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

      Ir a las Alertas

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

   2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. Para las configuraciones de App Hub, selecciona el proyecto host o el proyecto de administración de App Hub.
   3. Haz clic en Editar canal de notificaciones.
   4. Ve al tipo de canal de notificaciones que deseas configurar, haz clic en Agregar nuevo y, luego, completa el diálogo.

2. En la Google Cloud consola de, ve a la página Explorador de registros del segmento:

   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.

3. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto.

4. En la barra de herramientas, selecciona Crear alerta.

5. Ingresa un nombre para la política de alertas y, luego, haz clic en Siguiente.

6. En la sección Define las entradas de registro para las que se generará una alerta , ingresa una consulta o actualiza la consulta que se copió del panel Consulta cuando seleccionaste Crear alerta.

   Para cada tipo de evento, la página Tipos de eventos muestra una consulta adecuada para usar en una política de alertas basada en registros.

7. Completa el diálogo y haz clic en Guardar.

API

Para crear una política de alertas basada en registros con la API de Cloud Monitoring, haz lo siguiente:

1. Identifica la consulta que se incluirá en la condición de la política de alertas. Para cada tipo de evento, la página Tipos de eventos muestra una consulta adecuada para usar en una política de alertas basada en registros.

2. Crea el archivo JSON que contiene la representación de la política de alertas. Para obtener más información sobre este paso y un ejemplo, consulta Diseña la política de alertas.

3. Invoca el método alertPolicies.create de la API. Por ejemplo, puedes emitir el gcloud monitoring policies create comando.

Ocultar eventos

Console

Para ocultar todos los eventos, en la barra de herramientas del panel, haz clic en Anotaciones, selecciona Borrar y, luego, selecciona Aplicar.

Para ocultar un tipo de evento, haz clic en Anotaciones, borra la selección para ese tipo de evento y, luego, selecciona Aplicar.

API

Para ocultar un tipo de evento en un panel personalizado, busca el EventAnnotation objeto para el tipo de evento, y, luego, configura el enabled campo como false.

Para obtener información detallada sobre cómo usar la API de Cloud Monitoring, consulta Crea y administra paneles con la API.

¿Qué sigue?

• Comparte un panel personalizado
• Explora los datos representados
• Accede a paneles específicos de recursos
• Agrega filtros temporales a paneles personalizados
• Agrega filtros permanentes a paneles personalizados