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 las anotaciones de eventos puede ayudarte a correlacionar datos de diferentes fuentes cuando solucionas un problema.

Esta función solo se admite para proyectos de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.

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 . De manera similar, puedes configurar algunas pestañas de Observabilidad específicas del servicio, como las de Compute Engine y Google Kubernetes Engine, para que muestren 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 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 alguna acción para guardar tus selecciones de tipos de eventos, estas se aplicarán solo a tu sesión actual. Cuando usas la consola de Google Cloud , fijar tus selecciones las guarda.

Para obtener una lista de los tipos de eventos, referencias para la 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 de Observabilidad, aunque no hayas seleccionado ningún tipo de evento:

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

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 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 servicio de Google Cloud .

  • Todos los demás tipos de eventos se identifican analizando 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 que se enrutan a él. 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 que se proporcionan en la página Tipos de eventos.

Cómo se muestran los eventos

En el caso de todos los eventos, a medida que ocurren, se agregan anotaciones a los gráficos de tu panel. Los eventos identificados a través del 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 identificados a partir del análisis de las entradas de registro y un 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.
  • En el caso de los eventos de Service Health, se muestran chips que indican la cantidad de productos y ubicaciones afectados. Para ver la lista de 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 abrir la página de detalles de un evento de Service Health.

Los filtros del panel, que limitan los datos que se muestran en un panel, suelen filtrar tanto los datos de series temporales como los eventos.

Antes de comenzar

Completa los siguientes pasos para el proyecto Google Cloud 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 de control y políticas de alertas: Editor de Monitoring (roles/monitoring.editor).
    • Ver y mostrar los eventos identificados a partir de las entradas de registro de acceso no a 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 creadas en tu proyecto Google Cloud : Visualizador de registros privados (roles/logging.privateLogViewer).
    • Consulta los 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:

    Enable the API

Mostrar eventos

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

Configura paneles para mostrar eventos

En esta sección, se describe cómo configurar los paneles que se muestran 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 , accede a la página Paneles :

    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 consola de Google Cloud , selecciona tu proyecto de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
  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 quieres que se muestren en el 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 inhabilitaste 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 en la sesión actual, haz clic en Aplicar.

    Después de que actualices la lista de tipos de eventos que se mostrarán, Cloud Monitoring emitirá consultas, lo que tardará unos momentos, y, luego, agregará las anotaciones a los gráficos del panel.

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

API

Para configurar un panel personalizado 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:

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

  • 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 este campo no se especifica 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 de la 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 búsqueda específica del evento.
    • Un campo resourceNames que te permite definir una lista de proyectos deGoogle Cloud en los que se buscarán eventos. Cuando este campo es un array vacío, se busca el proyecto seleccionado.

A continuación, se muestra un ejemplo de un 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 Cómo crear y administrar paneles con la API y Ejemplo: Habilita eventos en los paneles.

Configura la pestaña Observabilidad para mostrar eventos

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

Console

Para 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. Los eventos no se pueden mostrar en los paneles personalizados.

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

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

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

API

No disponible.

Ver los detalles del evento

Cuando veas un gráfico que muestre anotaciones de eventos, puedes usar los vínculos que se proporcionan en la sugerencia 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 que se abre 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, 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 receptores de Cloud Logging en tu proyecto de Google Cloud , puedes recibir notificaciones 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 devuelve un resultado no 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. En la barra de herramientas de la consola de Google Cloud , selecciona tu proyecto de Google Cloud . Para las configuraciones de App Hub, selecciona el proyecto host de App Hub o el proyecto de administración de la carpeta habilitada para la app.
    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 consola de Google Cloud , accede a la página Explorador de registros:

    Acceder 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 consola de Google Cloud , selecciona tu proyecto de Google Cloud .

  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 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 eventos muestra una consulta adecuada para usar en una política de alertas basada en registros.

  7. 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, 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 incluye 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 ver un ejemplo, consulta Diseña la política de alertas.

  3. Invoca el método de la API alertPolicies.create. Por ejemplo, puedes ejecutar 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 de ese tipo de evento y, luego, selecciona Aplicar.

API

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

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

¿Qué sigue?