Cómo crear y administrar canales de notificaciones

En este documento, se describe cómo configurar canales de notificaciones mediante la consola de Google Cloud. Cloud Monitoring usa estos canales para notificarte, o tu equipo de guardia, cuando se activa una política de alertas. Cuando creas una política de alertas, puedes elegir a quién se notifica mediante una selección en la lista de canales de notificaciones configurados. Por ejemplo, puedes configurar alertas que supervisen las instancias de Compute Engine para publicar un tema de Pub/Sub y notificar al canal de Slack del equipo de guardia.

Si tu canal de notificaciones preferido no es compatible, considera crear una canalización que se base en enviar tus notificaciones a Pub/Sub. Para ver un ejemplo de Python que usa Flask, consulta Crea notificaciones personalizadas con Cloud Monitoring y Cloud Run. Para obtener otros ejemplos, consulta el repositorio de Git de cloud-alerting-notification-dispatch.

Para configurar canales de notificación con la API de Cloud Monitoring, consulta Crea y administra canales de notificaciones con la API.

Nota: Es posible que los datos enviados a los destinatarios del canal contengan información sensible. Revisa las prácticas regulatorias antes de crear el canal de notificación.

Para obtener información sobre las notificaciones sobre la política de alertas, consulta las siguientes páginas:

• Para obtener más información sobre el retraso entre el inicio de un problema y la creación de una alerta, consulta Latencia de las notificaciones.
• Si deseas obtener información sobre la cantidad de notificaciones generadas para una política de alertas, consulta Notificaciones por incidente.

De forma predeterminada, una política de alertas envía una notificación solo cuando se crea un incidente. Para recibir una notificación cuando se abre el incidente y cuando se cierra, edita la política de alertas y, en la sección de notificaciones, selecciona Notificar sobre el cierre del incidente.

Antes de comenzar

Si quieres obtener los permisos que necesitas para ver y configurar los canales de notificaciones mediante la consola de Google Cloud, pídele al administrador que te otorgue el rol de IAM Editor de Monitoring (roles/monitoring.editor). Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Para obtener más información sobre las funciones de Cloud Monitoring, consulta Controla el acceso con Identity and Access Management.

Crea un canal de notificaciones

Cuando creas una política de alertas, puedes seleccionar cualquier canal de notificación configurado y agregarlo a tu política. Puedes configurar de forma previa tus canales de notificaciones o configurarlos como parte del proceso de creación de una política de alertas. Para obtener más información, consulta Cómo crear un canal on demand.

Nota: Te recomendamos que crees varios canales de notificaciones con fines de redundancia. Google no tiene control de muchos de los sistemas de entrega después de que envía la notificación a ese sistema. Además, un solo servicio de Google es compatible con Cloud Mobile App, PagerDuty, Webhooks y Slack. Si usas uno de estos canales de notificaciones, usa el correo electrónico, SMS o Pub/Sub como canal redundante.

Para crear un canal de notificaciones con la consola de Google Cloud, sigue las instrucciones específicas del canal que se muestran en la siguiente tabla:

Correo electrónico

Para agregar un canal de notificaciones por correo electrónico, haz lo siguiente:

1. En la consola de Google Cloud, selecciona Monitoring.
   

   Ir a Monitoring

2. Haz clic en Alertas y, luego, en Editar canales de notificaciones.
3. En la sección Correo electrónico, haz clic en Agregar nuevo.
4. Ingresa una sola dirección de correo electrónico y una descripción.
5. Haz clic en Guardar.

Si usas una dirección de correo electrónico del grupo como canal de notificaciones para una política de alertas, configura el grupo a fin de que acepte correos de [e-mail].

Puedes crear canales de correos electrónicos durante la creación de una política de alertas. Para obtener más información, consulta Cómo crear un canal on demand.

Aplicación para dispositivos móviles

Usa la app para dispositivos móviles de Google Cloud Console a fin de supervisar los recursos de la consola y la información de Monitoring de Google Cloud desde cualquier lugar. Las notificaciones de la app para dispositivos móviles de Google Cloud Console se envían a un dispositivo específico o a un usuario específico:

• Dispositivo indica que las notificaciones se envían solo al dispositivo específico que creó el canal de notificaciones. Para los canales de notificaciones con alcance de dispositivo, el campo Nombre visible incluye información del dispositivo.
• Usuario indica que las notificaciones se envían a todos los dispositivos que tienen instalada la app para dispositivos móviles de la consola de Google Cloud.

Cloud Monitoring determina el permiso de la notificación cuando se crea el canal. No puedes seleccionar o cambiar el permiso.

A fin de configurar un canal de notificaciones de la app para dispositivos móviles de Google Cloud Console para un proyecto específico de Google Cloud, haz lo siguiente:

1. Instala la app para dispositivos móviles de la consola de Google Cloud desde la tienda de aplicaciones de tu dispositivo móvil.

2. Selecciona un proyecto para verlo en la app para dispositivos móviles de la consola de Google Cloud.

   Después de seleccionar un proyecto, se realiza un intercambio de datos entre la app y el proyecto de Google Cloud seleccionado. Se crea un canal de notificaciones cuando no existe, y después de unos minutos, se muestra en la sección Mobile Devices de la página Canales de notificaciones.

Si quieres agregar tu dispositivo móvil como canal de notificaciones para una política de alertas, en la sección Notificaciones de alertas, selecciona Google Cloud Console (dispositivos móviles) y elige tu dispositivo móvil de la lista.

PagerDuty

La integración con PagerDuty permite la sincronización unidireccional o bidireccional con Monitoring. Independientemente de tu configuración, los siguientes enunciados son verdaderos:

• Si se crea un incidente en Monitoring, se abre un incidente en PagerDuty.
• No puedes usar PagerDuty para cerrar un incidente en Monitoring.

Si usas la sincronización unidireccional y resuelves el incidente en PagerDuty, el estado del incidente en PagerDuty se desvincula del estado del incidente en Monitoring. De hecho, si resuelves un incidente en PagerDuty, se cierra de forma permanente en PagerDuty y no se puede volver a abrir.

Si usas la sincronización bidireccional, Monitoring controla el estado que muestra PagerDuty. Si resuelves el incidente en PagerDuty y si Monitoring tiene abierto el incidente, el incidente se vuelve a abrir en PagerDuty.

Para configurar las notificaciones de PagerDuty, sigue estos pasos:

1. En PagerDuty: crea una cuenta en el sitio de PagerDuty.
2. Agrega el canal de notificaciones de PagerDuty:
   1. En la consola de Google Cloud, selecciona Monitoring.
      Ir a Monitoring
   2. Haz clic en Alertas y, luego, en Editar canales de notificaciones.
   3. En la sección PagerDuty, haz clic en Agregar nuevo.
   4. Ingresa el Display Name (Nombre visible). Este nombre debe coincidir con el que se proporciona a PagerDuty cuando agregas la integración.
   5. Ingresa la Clave de servicio de integración que genera PagerDuty en el campo Clave de servicio.
   6. Haz clic en Guardar.
3. (Opcional) Si deseas configurar la sincronización bidireccional, haz lo siguiente:
   1. Abre PagerDuty.
   2. Selecciona Configuración, luego Servicios y, luego, el nombre del servicio que ingresaste cuando configuraste la integración.
   3. Haz clic en Editar configuración, selecciona Crear incidentes y, luego, borra Crear alertas e incidentes.

Cuando crees una política de alertas, selecciona PagerDuty en la sección Notificaciones y elige tu configuración de PagerDuty.

El paquete JSON de PagerDuty tiene el siguiente formato:

 {
     "description": A string of various fields in the incident,
     "details": JSON payload with schema version 1.2.
 }

Para ver un ejemplo y el esquema del campo details, expande las siguientes secciones.

Ejemplos de JSON

De forma predeterminada, el backend de alertas intenta generar un paquete JSON con formato de versión 1.2. Para obtener más información sobre este formato, consulta la siguiente sección.

A continuación, se muestra un ejemplo de un paquete de este tipo:

{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\\"compute.googleapis.com/instance/cpu/utilization\\" resource.type=\\"gce_instance\\" metadata.system_labels.\\"state\\"=\\"ACTIVE\\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown"
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}
       

Estructura del esquema, versión 1.2

En esta sección, se describe la versión 1.2 del esquema de la carga útil. Es posible que algunos campos no aparezcan en todos los paquetes que se muestran o tengan valores vacíos, según la configuración de la política de alertas, el estado del incidente o el recurso que se supervisa. Algunos campos toman estructuras incorporadas como valores. Estas estructuras se describen como referencia porque su contenido también puede variar.

En un paquete que se muestra, los campos pueden ocurrir en cualquier orden. En la siguiente descripción, se organizan en grupos relacionados.

{
  "version": "1.2",
  "incident": {
    
    Información sobre el incidente.
    
    "incident_id": string que genera el ID de este incidente.
    "scoping_project_id": es la string, el ID del proyecto que aloja el permiso de las métricas.
    "scoping_project_number": el número del proyecto de alcance.
    "url": string, URL de la consola de Google Cloud para este incidente.
    "started_at": número, tiempo (en segundos de Unix) cuando se abrió el incidente.
    "ended_at": número, tiempo (en segundos de Unix) cuando se cerró el incidente. Se propaga solo cuando state es closed.
    "state": string, estado del incidente: open o closed. Si es open, ended_at es nulo.
    "summary": string, resumen textual generado del incidente.
    "apigee_url": string, URL de Apigee para este incidente, solo para los tipos de recursos de Apigee Environment y Proxy*.
    "observed_value": Es la string, el valor observado que activó o resolvió la alerta, puede estar vacía si la condición venció.
    
    Información sobre el recurso supervisado para el que se abrió el incidente.
    
    "resource": {
      "type": string, identificador del tipo de recurso supervisado en el que se alerta, por ejemplo, gce_instance. Consulta Lista de recursos supervisados.
      "labels": Objeto, pares clave-valor para etiquetas asociadas con el recurso supervisado.
    },
    "resource_type_display_name": string, nombre visible del tipo de recurso supervisado.
    "resource_id": string, ID de instancia del recurso supervisado, el mismo valor que resource.labels.instance_id.
    "resource_display_name": string, nombre visible del recurso supervisado.
    "resource_name": string, nombre generado de este recurso supervisado; consiste en valores de otros campos.
    
    Información sobre el tipo de métrica de los datos de series temporales.
    
    "metric": {
      "type": string, identificador del tipo de métrica que se alerta, por ejemplo, compute.googleapis.com/instance/cpu/utilization. Consulta Lista de métricas.
      "displayName": string, nombre visible del tipo de métrica.
      "labels": Son los pares clave-valor de objeto para las etiquetas asociadas con la métrica.
    },
    "metadata": {
      "system_labels": Pares clave-valor para objetos para etiquetas de metadatos del sistema.
      "user_labels": Son los objetos, pares clave-valor para etiquetas de metadatos del usuario.
    },
    
    Información sobre la política de alertas y la condición que abrió/resolvió el incidente.
    Los valores se extraen del objeto AlertPolicy relevante.
    
    "policy_name": string, nombre visible para la política de alertas.
    "policy_user_labels": Objetos, pares clave-valor para cualquier etiqueta de usuario adjunta a la política.
    "documentation": Un objeto, una estructura incorporada con el formato Documentation.
    "condition": Un objeto, una estructura incorporada con el formato Condition.
    "condition_name": string, nombre visible de la condición, mismo valor que condition.displayName.
    "threshold_value": La string, el valor del umbral de esta condición, puede estar vacío si la condición no es una condición del umbral.
  },
}

Política de baja

El esquema de carga útil está sujeto a la política de baja de Google Cloud que se describe en la Sección 1.4(d) de las Condiciones del Servicio de Google Cloud Platform. Ten en cuenta que el esquema no controla los formatos de los valores de campo generados, y estos formatos pueden cambiar sin aviso previo. Por ejemplo, incident.summary, incident.documentation.content y incident.url están destinados a incluir datos relacionados con sus campos, pero el esquema no tiene restricciones para garantizar un análisis preciso de campos. Puedes consumir el valor como un todo y esperar que cumpla con la política de baja, pero no dependas del análisis de los campos generados.

SMS

Para configurar las notificaciones por SMS, sigue estos pasos:

1. En la consola de Google Cloud, selecciona Monitoring.
   

   Ir a Monitoring

2. Haz clic en Alertas y, luego, en Editar canales de notificaciones.
3. En la sección SMS, haz clic en Agregar nuevo.
4. Completa el diálogo y haz clic en Guardar.

Cuando configures tu política de alertas, selecciona el tipo de notificación SMS y elige un número de teléfono verificado de la lista.

Slack

Nota: Para completar estos pasos, debes ser propietario o administrador de Slack Workspace. Para obtener más información, consulta Administra solicitudes de invitación.

La integración de Slack con Monitoring permite que tus políticas de alertas realicen publicaciones en un canal de Slack cuando se crea un incidente nuevo. Para configurar las notificaciones de Slack, haz lo siguiente:

1. En Slack: crea un lugar de trabajo y un canal de Slack en el sitio de Slack. Registra la URL del canal.

2. En la consola de Google Cloud, selecciona Monitoring:

   Ir a Monitoring

3. Haz clic en Alertas y, luego, en Editar canal de notificaciones.

4. En la sección Slack, haz clic en Agregar nuevo para abrir la página de acceso de Slack:

   1. Selecciona tu lugar de trabajo de Slack.
   2. Haz clic en Permitir para habilitar el acceso de Google Cloud Monitoring a tu lugar de trabajo de Slack. Esta acción te lleva de vuelta a la página de configuración de Monitoring para tu canal de notificaciones.
   3. En el campo Nombre del canal de Slack, ingresa el nombre del canal de Slack que deseas usar para las notificaciones.
   4. En el campo Nombre visible de las alertas de Cloud, ingresa una declaración descriptiva breve. Monitoring muestra el valor de este campo en la página Canal de notificaciones.
   5. Opcional: Para probar la conexión entre Cloud Monitoring y tu lugar de trabajo de Slack, haz clic en Enviar notificación de prueba. Si la conexión se realiza de forma correcta, verás un mensaje This is a test alert notification... en el canal de notificaciones de Slack que especificaste. Revisa el canal de notificaciones para confirmar la recepción.

5. Si el canal de Slack que quieres usar para las notificaciones es un canal privado, debes invitar al canal a la app de Monitoring de forma manual:

   1. Abre Slack.

   2. Ve al canal que especificaste como tu canal de notificaciones de Monitoring.

   3. Para invitar a la app de Monitoring al canal, ingresa y envía el siguiente mensaje en el canal:

      /invite @Google Cloud Monitoring

      Asegúrate de invitar a la app de Monitoring al canal privado que especificaste cuando creaste el canal de notificación en Monitoring. Invitar a la app de Monitoring a canales públicos es opcional.

   Cuando crees una política de alertas, selecciona Slack en la sección Notificaciones y elige tu configuración de Slack.

Webhooks

Nota: Los webhooks solo admiten extremos públicos. Si necesitas notificaciones enviadas a un extremo que no es público, crea un canal de notificaciones de Pub/Sub y configura una suscripción al tema de Pub/Sub. Para obtener más información, consulta Las notificaciones de webhook fallan cuando se configuran para un extremo privado.

Nota: Si una Cloud Function está configurada como extremo de webhook para un canal de notificación, asegúrate de que el usuario que invoca la función tenga el permiso de autenticación requerido. Si deseas obtener más información, consulta Cómo autenticar funciones en llamadas a funciones y Cómo habilitar el acceso a una función.

Precaución: Para recibir notificaciones con Google Chat, implementa un servicio de Cloud Run y envía tus notificaciones a Pub/Sub. Para ver un ejemplo de esta configuración, consulta Crea notificaciones personalizadas con Cloud Monitoring y Cloud Run.

No configures una notificación de webhook y, luego, Google Chat para usar el webhook.

Para configurar las notificaciones de Webhooks, haz lo siguiente:

1. El controlador de webhook: Identifica la URL del extremo público para recibir los datos de webhook desde Monitoring.
2. En la consola de Google Cloud, selecciona Monitoring.
   

   Ir a Monitoring

3. Haz clic en Alertas y, luego, en Editar canales de notificaciones.
4. En la sección Webhook, haz clic en Agregar nuevo.
5. Completa el diálogo.
6. Haz clic en Probar conexión para enviar una carga útil de prueba al extremo de Webhook. Puedes ir al extremo receptor para verificar la entrega.
7. Haz clic en Guardar.

Cuando crees una política de alertas, selecciona Webhook en la sección Notificaciones y elige tu configuración de webhook. Las notificaciones que envía Error Reporting siguen el esquema 1.0, mientras que las notificaciones que envía Monitoring siguen el esquema 1.2:

Ejemplos de JSON

De forma predeterminada, el backend de alertas intenta generar un paquete JSON con formato de versión 1.2. Para obtener más información sobre este formato, consulta la siguiente sección.

A continuación, se muestra un ejemplo de un paquete de este tipo:

{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\\"compute.googleapis.com/instance/cpu/utilization\\" resource.type=\\"gce_instance\\" metadata.system_labels.\\"state\\"=\\"ACTIVE\\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown"
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}
       

Estructura del esquema, versión 1.2

En esta sección, se describe la versión 1.2 del esquema de la carga útil. Es posible que algunos campos no aparezcan en todos los paquetes que se muestran o tengan valores vacíos, según la configuración de la política de alertas, el estado del incidente o el recurso que se supervisa. Algunos campos toman estructuras incorporadas como valores. Estas estructuras se describen como referencia porque su contenido también puede variar.

En un paquete que se muestra, los campos pueden ocurrir en cualquier orden. En la siguiente descripción, se organizan en grupos relacionados.

{
  "version": "1.2",
  "incident": {
    
    Información sobre el incidente.
    
    "incident_id": string que genera el ID de este incidente.
    "scoping_project_id": es la string, el ID del proyecto que aloja el permiso de las métricas.
    "scoping_project_number": el número del proyecto de alcance.
    "url": string, URL de la consola de Google Cloud para este incidente.
    "started_at": número, tiempo (en segundos de Unix) cuando se abrió el incidente.
    "ended_at": número, tiempo (en segundos de Unix) cuando se cerró el incidente. Se propaga solo cuando state es closed.
    "state": string, estado del incidente: open o closed. Si es open, ended_at es nulo.
    "summary": string, resumen textual generado del incidente.
    "apigee_url": string, URL de Apigee para este incidente, solo para los tipos de recursos de Apigee Environment y Proxy*.
    "observed_value": Es la string, el valor observado que activó o resolvió la alerta, puede estar vacía si la condición venció.
    
    Información sobre el recurso supervisado para el que se abrió el incidente.
    
    "resource": {
      "type": string, identificador del tipo de recurso supervisado en el que se alerta, por ejemplo, gce_instance. Consulta Lista de recursos supervisados.
      "labels": Objeto, pares clave-valor para etiquetas asociadas con el recurso supervisado.
    },
    "resource_type_display_name": string, nombre visible del tipo de recurso supervisado.
    "resource_id": string, ID de instancia del recurso supervisado, el mismo valor que resource.labels.instance_id.
    "resource_display_name": string, nombre visible del recurso supervisado.
    "resource_name": string, nombre generado de este recurso supervisado; consiste en valores de otros campos.
    
    Información sobre el tipo de métrica de los datos de series temporales.
    
    "metric": {
      "type": string, identificador del tipo de métrica que se alerta, por ejemplo, compute.googleapis.com/instance/cpu/utilization. Consulta Lista de métricas.
      "displayName": string, nombre visible del tipo de métrica.
      "labels": Son los pares clave-valor de objeto para las etiquetas asociadas con la métrica.
    },
    "metadata": {
      "system_labels": Pares clave-valor para objetos para etiquetas de metadatos del sistema.
      "user_labels": Son los objetos, pares clave-valor para etiquetas de metadatos del usuario.
    },
    
    Información sobre la política de alertas y la condición que abrió/resolvió el incidente.
    Los valores se extraen del objeto AlertPolicy relevante.
    
    "policy_name": string, nombre visible para la política de alertas.
    "policy_user_labels": Objetos, pares clave-valor para cualquier etiqueta de usuario adjunta a la política.
    "documentation": Un objeto, una estructura incorporada con el formato Documentation.
    "condition": Un objeto, una estructura incorporada con el formato Condition.
    "condition_name": string, nombre visible de la condición, mismo valor que condition.displayName.
    "threshold_value": La string, el valor del umbral de esta condición, puede estar vacío si la condición no es una condición del umbral.
  },
}

Autenticación básica

Además de la solicitud de webhook enviada por Cloud Monitoring, la autenticación básica usa la especificación HTTP para el nombre de usuario y la contraseña. Cloud Monitoring requiere que tu servidor muestre una respuesta 401 con el encabezado WWW-Authenticate adecuado. Para obtener más información sobre la autenticación básica, consulta lo siguiente:

• Especificación de RFC
• Autenticación básica

Autenticación con token

La autenticación de tokens requiere un parámetro de string de consulta en la URL del extremo y una clave que el servidor espera que sea un secreto entre sí y Monitoring. La siguiente es una URL de muestra en la que se incluye un token:

https://www.myserver.com/stackdriver-hook?auth_token=1234-abcd

Si Monitoring publica un incidente en la URL del extremo, tu servidor puede validar el token adjunto. Este método de autenticación es más eficaz cuando se usa con SSL/TLS para encriptar la solicitud HTTP, lo que evita que los espías conozcan el token.

Para ver un servidor de ejemplo en Python, consulta este servidor de muestra.

Política de baja

El esquema de carga útil está sujeto a la política de baja de Google Cloud que se describe en la Sección 1.4(d) de las Condiciones del Servicio de Google Cloud Platform. Ten en cuenta que el esquema no controla los formatos de los valores de campo generados, y estos formatos pueden cambiar sin aviso previo. Por ejemplo, incident.summary, incident.documentation.content y incident.url están destinados a incluir datos relacionados con sus campos, pero el esquema no tiene restricciones para garantizar un análisis preciso de campos. Puedes consumir el valor como un todo y esperar que cumpla con la política de baja, pero no dependas del análisis de los campos generados.

Pub/Sub

En esta sección, se describe cómo configurar los canales de notificaciones de Pub/Sub. Para obtener redundancia, te recomendamos crear varios canales de notificaciones. Se recomienda vincular Pub/Sub con la app para dispositivos móviles de la consola de Google Cloud, PagerDuty, Webhooks o Slack, ya que Pub/Sub usa un mecanismo de entrega diferente.

Para configurar un canal de notificaciones de Pub/Sub, haz lo siguiente:

1. Habilite la API de Pub/Sub y cree un tema
2. Configura el canal de notificaciones para un tema
3. Autoriza una cuenta de servicio
4. Configura el canal de notificaciones en una política de alertas

Para comprender el esquema de datos, consulta Ejemplo de esquema.

Para recibir notificaciones de alerta, también debes crear una suscripción a Pub/Sub. Cuando la suscripción esté en un proyecto diferente del tema, crea una cuenta de servicio en el proyecto de suscriptor y otórgale la función roles/pubsub.subscriber para el tema.

Antes de comenzar

Cuando agregas el primer canal de notificaciones para un proyecto de Google Cloud, Cloud Monitoring crea una cuenta de servicio para ese proyecto. También otorga el rol de agente de servicio de notificación de Monitoring a la cuenta de servicio. Esta cuenta de servicio permite que Monitoring envíe notificaciones a los canales de notificaciones basados en Pub/Sub de este proyecto.

La cuenta de servicio tiene el siguiente formato:

[e-mail]

El nombre de la cuenta de servicio de notificaciones incluye un número de proyecto de Google Cloud único. Puedes encontrar el nombre, el ID y el número del proyecto en el panel del proyecto en la consola de Google Cloud o puedes recuperarlos con el siguiente comando:

gcloud projects describe PROJECT_ID --format="value(project_number)"

Puedes ver y editar la cuenta de servicio mediante Google Cloud Console o Google Cloud CLI.

Habilita la API de Pub/Sub y crea un tema

1. Habilita la API de Pub/Sub para tu proyecto de Google Cloud:
   Habilita la API de Pub/Sub.

   1. Selecciona el proyecto de Google Cloud en el que planeas crear el tema de Pub/Sub.
   2. Haz clic en Habilitar cuando se muestre. No se requiere ninguna acción cuando se muestra la opción API habilitada.

2. Cree un tema de Pub/Sub. Para obtener información sobre cómo crear un tema, consulta Cómo crear un tema. Por ejemplo, para crear un tema llamado notificationTopic mediante Google Cloud CLI, ejecuta el siguiente comando:

   gcloud pubsub topics create notificationTopic

A continuación, configura tus canales de notificaciones de Pub/Sub.

Cómo configurar notificaciones para un tema

Para crear un canal de notificaciones de Pub/Sub, puedes usar la API de Monitoring, Google Cloud CLI o Google Cloud Console. Después de crear el canal de notificaciones, autoriza a la cuenta de servicio de notificaciones a publicar cada tema que uses como canal de notificaciones.

Si quieres obtener información sobre el uso de la API de Monitoring o Google Cloud CLI para crear el canal de notificaciones, consulta Crea canales.

Si deseas usar la consola de Google Cloud para crear el canal de notificaciones, haz lo siguiente:

1. En la consola de Google Cloud, selecciona Monitoring.
   

   Ir a Monitoring

2. Selecciona el proyecto de Google Cloud que contiene el tema de Pub/Sub que creaste.
3. Haz clic en Alertas y, luego, en Editar canales de notificaciones.

4. En la sección Pub/Sub, haga clic en Agregar nuevo.

   En el cuadro de diálogo Canal de Pub/Sub creado se muestra el nombre de la cuenta de servicio que creó Monitoring.

5. Autoriza la cuenta de servicio. Tu cuenta de servicio puede publicar todos los temas o temas específicos:

   • Para publicar todos los temas, selecciona Administrar roles y agrega el rol de Publicador de Pub/Sub.

     Después de completar estos pasos para configurar el canal de notificaciones, omite la siguiente sección, que se titula Autorizar cuenta de servicio, y continúa con la sección Establece el canal de notificaciones en una política de alertas.

   • Para publicar temas específicos, continúa con el siguiente paso y autoriza a la cuenta de servicio a publicar temas específicos después de que completes la configuración del canal de notificaciones. Si deseas obtener instrucciones para autorizar la cuenta de servicio, consulta Autoriza la cuenta de servicio.
6. Ingresa un nombre visible para tu canal y el nombre del tema de Pub/Sub.
7. (Opcional) Para verificar que el canal esté configurado correctamente, haz clic en Enviar notificación de prueba.
8. Selecciona Agregar canal.

A continuación, autoriza la cuenta de servicio.

Autorizar cuenta de servicio

Nota: Completa este paso cuando crees el canal de notificaciones mediante la API o Google Cloud CLI, y cuando omitas el paso de autorización cuando uses Google Cloud Console.

La autorización permite que la cuenta de servicio de notificaciones publique cada tema de Pub/Sub que usas como canal de notificaciones. En esta sección, se describe cómo hacer lo siguiente:

• Autoriza una cuenta de servicio para un tema específico.
• Autoriza una cuenta de servicio para todos los temas.

Autoriza una cuenta de servicio para un tema específico

Puedes autorizar a una cuenta de servicio a publicar un tema específico con la consola de Google Cloud y Google Cloud CLI. En esta sección, se describen ambos enfoques.

Si deseas autorizar tu cuenta de servicio para un tema específico con la consola de Google Cloud, haz lo siguiente:

1. Ve a la página Temas de Pub/Sub:
   Ir a Temas
2. Seleccione el tema.
3. En la pestaña Permisos, selecciona Agregar principal.
4. En el campo Principal principal, ingresa el nombre de la cuenta de servicio de notificaciones. La cuenta de servicio tiene la siguiente convención de nombres:

   [e-mail]

5. Selecciona el rol Publicador de Pub/Sub y, luego, Guardar.

A fin de autorizar tu cuenta de servicio para un tema específico mediante Google Cloud CLI, otorga el rol pubsub.publisher de IAM para el tema a la cuenta de servicio. Por ejemplo, el siguiente comando configura la función de IAM para el tema notificationTopic:

gcloud pubsub topics add-iam-policy-binding \
projects/PROJECT_NUMBER/topics/notificationTopic --role=roles/pubsub.publisher \
--member=serviceAccount:[e-mail]
 

Una respuesta a una ejecución correcta del comando add-iam-policy-binding es como la siguiente:

 Updated IAM policy for topic [notificationTopic].
 bindings:
 ‐ members:
    ‐ serviceAccount:[e-mail]
    role: roles/pubsub.publisher
 etag: BwWcDOIw1Pc=
 version: 1
 

Para obtener más información, consulta la página de referencia de pubsub topics add-iam-policy-binding.

Autoriza una cuenta de servicio para todos los temas

Para autorizar tu cuenta de servicio para todos los temas, haz lo siguiente:

1. Ve a la página IAM:
   Ir a IAM
2. Selecciona Incluir asignaciones de roles proporcionadas por Google, como se muestra en la siguiente imagen:
   
3. Busca la cuenta de servicio que tiene el siguiente formato:

   [e-mail]

   Vuelve a cargar la página cuando la cuenta de servicio no aparezca en la lista.

4. Selecciona Editar para la cuenta de servicio de notificaciones, selecciona Agregar otro rol y, luego, agrega el rol Publicador de Pub/Sub.

A continuación, configura el canal de notificaciones en una política de alertas.

Configura el canal de notificaciones en una política de alertas

Para usar un canal de notificaciones de Pub/Sub en una política de alertas, selecciona Pub/Sub como el tipo de canal y, luego, selecciona el tema.

Ejemplo de esquema

Para ver un ejemplo de paquete JSON y el esquema, expande las siguientes secciones.

Ejemplos de JSON

De forma predeterminada, el backend de alertas intenta generar un paquete JSON con formato de versión 1.2. Para obtener más información sobre este formato, consulta la siguiente sección.

A continuación, se muestra un ejemplo de un paquete de este tipo:

{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\\"compute.googleapis.com/instance/cpu/utilization\\" resource.type=\\"gce_instance\\" metadata.system_labels.\\"state\\"=\\"ACTIVE\\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown"
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}
       

Estructura del esquema, versión 1.2

En esta sección, se describe la versión 1.2 del esquema de la carga útil. Es posible que algunos campos no aparezcan en todos los paquetes que se muestran o tengan valores vacíos, según la configuración de la política de alertas, el estado del incidente o el recurso que se supervisa. Algunos campos toman estructuras incorporadas como valores. Estas estructuras se describen como referencia porque su contenido también puede variar.

En un paquete que se muestra, los campos pueden ocurrir en cualquier orden. En la siguiente descripción, se organizan en grupos relacionados.

{
  "version": "1.2",
  "incident": {
    
    Información sobre el incidente.
    
    "incident_id": string que genera el ID de este incidente.
    "scoping_project_id": es la string, el ID del proyecto que aloja el permiso de las métricas.
    "scoping_project_number": el número del proyecto de alcance.
    "url": string, URL de la consola de Google Cloud para este incidente.
    "started_at": número, tiempo (en segundos de Unix) cuando se abrió el incidente.
    "ended_at": número, tiempo (en segundos de Unix) cuando se cerró el incidente. Se propaga solo cuando state es closed.
    "state": string, estado del incidente: open o closed. Si es open, ended_at es nulo.
    "summary": string, resumen textual generado del incidente.
    "apigee_url": string, URL de Apigee para este incidente, solo para los tipos de recursos de Apigee Environment y Proxy*.
    "observed_value": Es la string, el valor observado que activó o resolvió la alerta, puede estar vacía si la condición venció.
    
    Información sobre el recurso supervisado para el que se abrió el incidente.
    
    "resource": {
      "type": string, identificador del tipo de recurso supervisado en el que se alerta, por ejemplo, gce_instance. Consulta Lista de recursos supervisados.
      "labels": Objeto, pares clave-valor para etiquetas asociadas con el recurso supervisado.
    },
    "resource_type_display_name": string, nombre visible del tipo de recurso supervisado.
    "resource_id": string, ID de instancia del recurso supervisado, el mismo valor que resource.labels.instance_id.
    "resource_display_name": string, nombre visible del recurso supervisado.
    "resource_name": string, nombre generado de este recurso supervisado; consiste en valores de otros campos.
    
    Información sobre el tipo de métrica de los datos de series temporales.
    
    "metric": {
      "type": string, identificador del tipo de métrica que se alerta, por ejemplo, compute.googleapis.com/instance/cpu/utilization. Consulta Lista de métricas.
      "displayName": string, nombre visible del tipo de métrica.
      "labels": Son los pares clave-valor de objeto para las etiquetas asociadas con la métrica.
    },
    "metadata": {
      "system_labels": Pares clave-valor para objetos para etiquetas de metadatos del sistema.
      "user_labels": Son los objetos, pares clave-valor para etiquetas de metadatos del usuario.
    },
    
    Información sobre la política de alertas y la condición que abrió/resolvió el incidente.
    Los valores se extraen del objeto AlertPolicy relevante.
    
    "policy_name": string, nombre visible para la política de alertas.
    "policy_user_labels": Objetos, pares clave-valor para cualquier etiqueta de usuario adjunta a la política.
    "documentation": Un objeto, una estructura incorporada con el formato Documentation.
    "condition": Un objeto, una estructura incorporada con el formato Condition.
    "condition_name": string, nombre visible de la condición, mismo valor que condition.displayName.
    "threshold_value": La string, el valor del umbral de esta condición, puede estar vacío si la condición no es una condición del umbral.
  },
}

Política de baja

El esquema de carga útil está sujeto a la política de baja de Google Cloud que se describe en la Sección 1.4(d) de las Condiciones del Servicio de Google Cloud Platform. Ten en cuenta que el esquema no controla los formatos de los valores de campo generados, y estos formatos pueden cambiar sin aviso previo. Por ejemplo, incident.summary, incident.documentation.content y incident.url están destinados a incluir datos relacionados con sus campos, pero el esquema no tiene restricciones para garantizar un análisis preciso de campos. Puedes consumir el valor como un todo y esperar que cumpla con la política de baja, pero no dependas del análisis de los campos generados.

Cómo crear un canal on demand

Cuando agregas un canal de notificaciones a una política de alertas, debes seleccionar un canal de una lista. Para actualizar la lista de opciones cuando creas una política de alertas, usa el siguiente proceso:

1. En el diálogo de notificaciones, haz clic en Administrar canales de notificaciones. Se abrirá la ventana Canales de notificaciones en una nueva pestaña del navegador.
2. Para agregar un canal de notificaciones nuevo, ubica el tipo de canal, haz clic en Agregar nuevo y, luego, sigue las instrucciones específicas del canal que se encuentran en la tabla anterior.

3. Regresa a la pestaña original y, en el diálogo de notificaciones, haz clic en Actualizar .

   

4. Selecciona el canal de notificaciones de la lista actualizada.

Cómo probar un canal de notificaciones

Cloud Monitoring no admite una opción de prueba para los canales de notificaciones. Sin embargo, puedes verificar que un canal de notificaciones esté configurado de forma correcta mediante la creación de una política de alertas y la configuración de la condición para que se active.

Por ejemplo, puedes verificar la configuración de tu canal de notificaciones mediante un procedimiento similar al siguiente:

1. Si no tienes una instancia de Compute Engine en tu proyecto de Google Cloud, crea una.

2. Crear una política de alertas para supervisar el uso de CPU de esa instancia

   Si tu proyecto de Google Cloud contiene varias instancias, agrega un filtro para seleccionar una.

3. Configura los campos Activador de condición de la siguiente manera:

   1. Selecciona Umbral en el campo Tipo de condición.
   2. Selecciona Por debajo del umbral en el campo Posición del umbral.
   3. Selecciona un valor mayor que el uso de CPU para tu instancia. Por ejemplo, si en el gráfico se muestra el uso de CPU del 5%, establece el umbral en 10%.
   4. Expande Opciones avanzadas y selecciona No volver a probar en el campo Ventana de prueba.

   Esta configuración establece la política que se activará cuando el uso de CPU de una instancia de Compute Engine sea inferior al umbral especificado. Debido a que seleccionaste el límite para que sea mayor que el uso de CPU de tu instancia, la condición se activa.

4. Agrega los canales de notificaciones a tu política.

5. Expande Duración del cierre automático de incidentes y selecciona 30 min.

6. Ingresa un nombre de política y haz clic en Crear política.

7. Después de que se active la condición, verifica que recibiste una notificación en cada canal de notificaciones.

8. Borra la política de alertas y la instancia de Compute Engine que creaste. El incidente se cierra automáticamente después de que vence la duración del cierre automático.

9. Si creaste una VM para esta prueba, bórrala.

Cómo editar y borrar canales de notificaciones

Para editar o borrar un canal de notificaciones mediante la consola de Google Cloud, haz lo siguiente:

1. En la consola de Google Cloud, selecciona Monitoring o haz clic en el siguiente botón:

   Ir a Monitoring

2. En el panel de navegación de Monitoring, haga clic en Alertas.

3. Haz clic en Editar canales de notificaciones.

   El panel Canales de notificaciones contiene una sección para cada tipo de canal de notificaciones. En cada sección se muestran todas las configuraciones para ese tipo:

   • Para modificar una entrada, haz clic en Editar . Haz clic en Guardar una vez que se hayan completado los cambios.
   • Para borrar una entrada, haz clic en Borrar . Haz clic en Borrar en el cuadro de diálogo de confirmación.

Nota: No puedes borrar un canal de notificaciones mediante Google Cloud Console si el canal está asociado con una política de alertas. Sin embargo, puedes borrar el canal mediante Google Cloud CLI o la API de Cloud Monitoring. Para obtener más información, consulta Cómo crear y administrar canales de notificaciones por API.

Ver registros del canal de notificaciones

Puedes usar el Explorador de registros para ver los errores del canal de notificaciones:

1. Si deseas comenzar a usar la consola de Google Cloud para ver los errores, navega al Explorador de registros:

   Ir al Explorador de registros.

2. Ingresa y ejecuta tu consulta. En el caso de consultas específicas para errores de canales de notificaciones, visita Consultas de Cloud Monitoring.