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.

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 consola de Google Cloud. Del mismo modo, 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 muestra un panel o una pestaña Observabilidad, puedes usar la consola de Google Cloud. Para 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 selecciónes de tipo de evento, estas se aplicarán solo a tu sesión actual. Cuando usas la consola de Google Cloud, fijas tus selecciones para guardarlas.

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

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

Cuando se agrega un tipo de evento automáticamente, es un tipo de evento recomendado. Puedes dejar estos tipos de eventos en el estado recomendado y guardarlos en el panel JSON 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 Fijados.

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 alerta. Los eventos de alerta proporcionan información sobre cuándo incidentes.

  • Las consultas que Monitoring envía a la API de Service Health identifican los eventos de Personalized Service Health. Estos eventos indican cuando hay una interrupción en un servicio de Google Cloud.

  • Todos los demás tipos de eventos se identifican analizando las entradas de registro que pasar a través de los receptores de Cloud Logging en tu proyecto de Google Cloud. Estas entradas de registro incluyen las que genera tu proyecto y aquellos enrutados a tu proyecto. Para recibir una notificación 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

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

En la siguiente captura de pantalla, se muestra un gráfico que muestra varias eventos que se identificaron a través del análisis de entradas de registro, y una Evento de Service Health:

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

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, los chips que muestran la cantidad de las ubicaciones y los productos 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 adicional sobre el evento. Por ejemplo, podría abrir el Explorador de registros para que puedas ver las entradas de registro, o bien podría abrir la página de detalles de un evento de estado del servicio.

Los filtros de 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 para crear políticas de alertas solicita a tu administrador que te otorgue el 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 que no son de acceso a los datos que se crean 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 que se crearon en tu proyecto de Google Cloud: Visualizador de registros privados (roles/logging.privateLogViewer).
    • Visualiza los eventos de Service Health: Visualizador de Custom 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 mediante roles personalizados o cualquier otro rol predefinido.

  • Si quieres mostrar eventos de Service Health en tu y habilita la API de Service Health:

    Enable the 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 aparecen en la página Paneles de la consola de Google Cloud 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 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 el panel que deseas ver.
  3. En la barra de herramientas del panel, haz clic en Anotaciones. selecciona los tipos de eventos que quieres que muestre tu panel.

  4. Realiza una de las siguientes acciones:

    • Para guardar tus selecciones de modo que los eventos se muestren cuando vuelvas a cargar el panel, haz clic en Fijar seleccionados. Si tienes inhabilitado el guardado automático, haz lo siguiente: 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 de la o un panel dinámico más robusto. Por lo tanto, cuando se vuelva a abrir el panel, tus selecciones se cargan y en el panel se muestran anotaciones de los tipos de eventos.

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

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

  5. Para ver el resumen de un evento o acceder a vínculos a información adicional, haz lo siguiente: usa el puntero para activar la información.

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 contiene dos campos:

  • El campo defaultResourceName enumera los valores predeterminados a nivel del panel para Proyectos de Google Cloud para buscar eventos. Si no especificas este campo, se buscará el proyecto que seleccionaste.

  • Un array de objetos EventAnnotation. 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 false, el botón de activación está en la posición off.
    • Un campo eventType, que contiene un valor de EventType enumeración.
    • 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, y, luego, 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 ejemplo de objeto annotations para un evento de actualización del clúster. En este ejemplo, el campo filter 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 Crear y administrar paneles por API y Ejemplo: Habilita los eventos en los paneles.

Configura la pestaña Observabilidad para mostrar eventos

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

Console

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. De manera similar, 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 Anotaciones y completa el diálogo.

    Después de actualizar la lista de eventos para mostrar, se envían las búsquedas a recuperar los datos del evento y, luego, se actualiza el panel.

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

API

No disponible.

Ver detalles del evento

Cuando veas un gráfico que muestre anotaciones de eventos, puedes usar los vínculos que se proporcionan en la información sobre herramientas 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. Si se trata de un tipo de evento diferente, es posible que se abra el Explorador de registros.

Crea políticas de alertas

Cuando se identifican eventos a través del análisis de las entradas de registro que pasan por los destinos de Cloud Logging en tu proyecto de Google Cloud, puedes recibir notificaciones cuando se produzcan estos eventos. Para ello, configura 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 que no está vacío, se crea un incidente y se envían notificaciones.

Console

Para crear una alerta basada en registros, sigue estos pasos:

  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 quieres configurar. Haz clic en Agregar nuevo y, luego, completa el cuadro de 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 entradas de registro para alertar, ingresa una consulta o actualiza la que se copió del panel Consulta cuando seleccionaste Crear alerta.

    Para cada tipo de evento, la página Tipos de evento enumera un que sea adecuada para usarse 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 con la API de Cloud Monitoring, sigue estos pasos: haz lo siguiente:

  1. Identifica la consulta que se incluirá en la condición del política de alertas. Para cada tipo de evento, el En la página Tipos de eventos, se muestra una lista con que sea adecuada para usarse 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

Console

Para ocultar todos los eventos, en la barra de herramientas del panel, haz clic en Anotaciones, selecciona Borrar y, luego, 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 objeto EventAnnotation del 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?