Muestra eventos en un panel

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

Puedes mostrar eventos en la mayoría de los paneles enumerados en la página Paneles de la consola de Google Cloud. De manera similar, puedes configurar algunas pestañas de Observabilidad específicas del servicio, como las de Compute Engine y Google Kubernetes Engine, para mostrar eventos. Para configurar los tipos de eventos que se muestran en un panel o en una pestaña Observabilidad, puedes usar la consola de Google Cloud. Para los paneles personalizados, también puedes usar la API de Cloud Monitoring.

Cómo se identifican los eventos

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

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

  • Los eventos de Custom Service Health se identifican por las consultas que Monitoring envía a la API de Service Health. Estos eventos indican cuando se produce una interrupción en un servicio de Google Cloud.

  • 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 proyecto de Google Cloud. Estas entradas de registro incluyen las que genera tu proyecto y las enrutadas a tu proyecto. Para recibir notificaciones cuando ocurra uno de estos eventos, puedes crear una política de alertas basada en registros. En la política de alertas, usa las consultas proporcionadas en la página Tipos de eventos.

Cómo se muestran los eventos

En todos los eventos, a medida que ocurren, se anotan los gráficos del panel. Los eventos identificados mediante el análisis de entradas de registro se muestran con una única 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 mientras dure el evento. Estos eventos también muestran un ícono de corazón.

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

Gráfico que muestra anotaciones de advertencias y eventos informativos.

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.
  • En el caso de los eventos de Service Health, son chips que muestran la cantidad de productos y ubicaciones afectados. Para enumerar los productos o las ubicaciones afectados, coloca tu puntero en 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 puede abrir 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 de series temporales y los eventos.

Antes de comenzar

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

    • Visualiza y crea paneles y políticas de alertas: Editor de Monitoring (roles/monitoring.editor).
    • Visualiza y muestra los eventos identificados a partir de las entradas de registro de acceso a los datos que se crearon en tu proyecto de Google Cloud: Visor de registros (roles/logging.viewer).
    • Visualiza y muestra los eventos identificados a partir de las entradas de registro creadas en tu proyecto de Google Cloud: Visor de registros privados (roles/logging.privateLogViewer).
    • Ver eventos de Service Health: Visualizador de Personalized Service Health (roles/servicehealth.viewer)

    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.

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

    Habilita 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 consola de Google Cloud para mostrar eventos.

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

Consola

Para mostrar eventos en un panel, 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 el panel que deseas ver.

  3. En la barra de herramientas del panel, asegúrate de que el botón de activación Eventos esté activado.

    Si el botón de activación Eventos no se muestra, el panel no puede mostrar eventos.

  4. Haz clic en Seleccionar tipos de eventos, selecciona los tipos de eventos que deseas que muestre el panel y, luego, realiza una de las siguientes acciones:

    • Si estás viendo un panel personalizado y deseas guardar las selecciones de tipo de evento, haz clic en Fijar elementos 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.

    • De lo contrario, haz clic en Ok.

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

  5. Si quieres ver el 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

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

  • En el campo defaultResourceName, se enumeran los valores predeterminados a nivel del panel para que los proyectos de Google Cloud busquen eventos. Si no especificas este campo, se buscará el proyecto seleccionado.

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

    • Un campo displayName, que te permite definir la etiqueta del botón de activación específico del evento. Si no se especifica este campo o su valor es una cadena vacía, se mostrará 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 adjuntar 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 proyectos de Google Cloud para buscar eventos. Cuando este campo es un array vacío, se busca el proyecto seleccionado.

A continuación, se muestra un objeto annotations de ejemplo para un evento de actualización del 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": []
    }
  ]
}

Si deseas obtener información detallada sobre cómo usar la API de Cloud Monitoring para crear paneles, consulta Crea y administra paneles por 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.

Consola

Si deseas configurar la pestaña Observabilidad para que muestre 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. No se pueden mostrar eventos en paneles personalizados.

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

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

    Cuando no se muestra el botón Seleccionar eventos, no se puede configurar la pestaña para que muestre eventos.

API

No disponible.

Ver detalles del evento

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

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

La página de la consola de Google Cloud abierta con 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, podría abrirse 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 a través de los receptores de Cloud Logging en tu proyecto de Google Cloud, puedes recibir notificaciones cuando ocurran estos eventos si configuras una alerta basada en registros. Estas políticas consultan tus entradas de registro a medida que se reciben. Cuando la consulta muestra un resultado que no está vacío, se crea un incidente y se envían notificaciones.

Consola

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

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

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

      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. Haz clic en Editar canal de notificaciones.
    3. Ve al tipo de canal de notificaciones que deseas configurar, haz clic en Agregar nuevo y, luego, completa el diálogo.

  2. 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.

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

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

  5. En la sección Define registros de entradas para alertar sobre, ingresa una consulta o actualiza la consulta que se copió del panel Consulta cuando seleccionaste Crear alerta.

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

  6. Completa el cuadro de diálogo y haz clic en Guardar.

API

Para crear una política de alertas basada en registros mediante 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, en la página Tipos de eventos, se enumera una consulta que es 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 de la API alertPolicies.create. Por ejemplo, puedes emitir el comando gcloud alpha monitoring policies create.

Ocultar eventos

Consola

Para ocultar todos los eventos, en la barra de herramientas del panel, asegúrate de que el botón de activación Eventos esté desactivado.

Para ocultar un tipo de evento, desactiva el botón de activación correspondiente.

API

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

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

¿Qué sigue?