Mostrar eventos en un panel

En este documento, se describe cómo 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.

Cómo se identifican los eventos

Los paneles consultan eventos 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. Estas entradas de registro incluyen las que genera tu proyecto y las enrutadas al 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

Los gráficos de tu panel se anotan a medida que ocurren los eventos. Los eventos identificados mediante el análisis de entradas de registro se muestran con una sola referencia de tiempo.

En la siguiente captura de pantalla, se ilustra un gráfico en el que se muestra un evento que se identificó mediante el análisis de las entradas de registro:

Gráfico en el que se muestran anotaciones de eventos.

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

  • Nombre del evento
  • El servicio de Google Cloud o el recurso que causó el evento.
  • Fecha y hora de inicio del evento
  • 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 ver entradas.

Los filtros de panel, que limitan los datos que muestra un panel, por lo general, filtran datos de series temporales y eventos.

En el caso de los paneles personalizados, también puedes configurar si los eventos se muestran mediante la API de Cloud Monitoring.

Antes de comenzar

  • Si quieres obtener los permisos que necesitas para ver gráficos y entradas de registro, y crear políticas de alertas, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

    • Consultar los gráficos y ver y crear políticas de alertas: Editor de Monitoring (roles/monitoring.editor).
    • Ve todas las entradas de registro, excepto las que se crean en tu proyecto de Google Cloud: Visor de registros (roles/logging.viewer).
    • Consulta las entradas de registro de acceso a los datos que se crean en tu proyecto de Google Cloud: Visor de registros privados (roles/logging.privateLogViewer).

    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 los roles personalizados o de otros roles predefinidos.

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.

Console

Para mostrar los eventos de la sesión actual, 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 sea 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 Events esté activado.

    Si el botón de activación Events no se muestra, el panel no admite la visualización de eventos.

  4. Por cada tipo de evento que desees mostrar, en la barra de herramientas del panel, haz clic en Agregar evento y, luego, selecciona el tipo de evento en el menú.

    Por ejemplo, puedes configurar el panel para mostrar eventos de “Implementación de cargas de trabajo de GKE”.

    Después de agregar un tipo de evento, Cloud Monitoring consulta tus datos de registro, lo que tarda unos minutos y, luego, agrega las anotaciones a los gráficos del panel:

    • Info: Es un mensaje informativo.
    • Advertencia: Indica una falla, como un reinicio o una falla.
    • Alerta: Indica que se abrió un incidente.

  5. Si deseas ver un resumen de un evento o acceder a los vínculos a las entradas de registro, usa el puntero para activar la información sobre la herramienta.

  6. Opcional: Tu configuración solo se aplica a la sesión actual. Para guardar la configuración, haz lo siguiente:

    1. En la barra de herramientas del panel, haz clic en Configuración, selecciona JSON y, luego, Editor de JSON.

    2. En el editor de JSON, agrega un objeto annotations. Este objeto contiene un array de objetos EventAnnotation que especifican los tipos de eventos que se mostrarán.

      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": []
    }
  ]
}

      Para obtener más información sobre el objeto annotations, selecciona la pestaña API de esta tabla.

    3. Haz clic en Aplicar cambios y, luego, en Guardar.

API

Si quieres 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 tiene dos campos:

  • En el campo defaultResourceName, se enumeran los valores predeterminados a nivel de panel para los proyectos de Google Cloud en los que se buscan 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 no se especifica este campo o si el valor de este campo es una string vacía, se muestra el nombre predeterminado del evento.
    • Un campo enabled, que controla el valor de activar o desactivar el 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 string vacía, se utiliza la consulta específica del evento.
    • Un campo resourceNames, que te permite definir una lista de proyectos de Google Cloud para buscar eventos. Si este campo es un array vacío, se busca en 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 mediante la API y Ejemplo: habilita eventos en paneles.

Ver detalles del evento

Cuando ves 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 que se abre con el botón Ver se determina en función del 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.

  • Si quieres ver las entradas de registro que tienen marcas de tiempo que coinciden con una anotación, usa el puntero para activar la información sobre la herramienta de la anotación, ve a la línea de resumen de la información y, luego, haz clic en Ver registros.

Crea políticas de alertas

Para recibir notificaciones cuando aparezca un evento en tus registros, 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 no vacío, se crea un incidente y se envían las notificaciones.

Console

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 sea 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 sea 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 log entries to alert on, 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 enumera una consulta que es adecuada para su uso 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, la página Tipos de eventos enumera una consulta que es adecuada para su uso 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, asegúrate de que el botón de activación de Eventos esté desactivado.

Para ocultar un tipo de evento, desactiva la opción correspondiente.

API

Para ocultar un tipo de evento en un panel personalizado, busca el objeto EventAnnotation correspondiente al 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 según la API.

¿Qué sigue?