Creación de una tarea de notificación

Puede utilizar Engagement en su API Manager para recibir notificaciones basadas en los criterios definidos.

Antes de empezar

Debe tener al menos un servicio Analytics activo para utilizar Engagement en el Gestor de API. Al crear su tarea de notificación, debe cumplir los siguientes criterios:

  • Cada regla sólo puede tener hasta 7 criterios de filtro y 5 desencadenantes.
  • Cada activador sólo puede tener hasta 3 acciones.

Acerca de esta tarea

La función Engagement del API Manager ayuda al usuario a crear flujos de trabajo complejos que automatizan tareas y mejoran la experiencia general de gestión de API. En función de los criterios definidos al crear las tareas de notificación, cada usuario recibe notificaciones.

Crear una tarea de notificación

Para utilizar Engagement, haz clic Icono de compromiso en el Administrador de API y especifica los criterios según sea necesario.

Puede crear una tarea de notificación configurando un destino, reglas, disparadores y acciones.
  1. Configure un destination, que es la definición del punto final HTTP (S) que recibirá las tareas de notificación. Para más información, consulte Crear un destino.
  2. Configure un ' rule' , que es el trabajo que se ejecuta en un horario definido y envía consultas a la fuente de datos. Para más información, consulte Creación de una regla.
  3. Configurar un ' trigger' , que define las condiciones que generan eventos. Para obtener más información, consulte Añadir activadores.
  4. Configure un ' action' , que define lo que ocurre después de que se active una tarea de notificación. Para más información, consulte Añadir acciones.

Crear un destino

  1. Haga clic en la pestaña Crear destinos.
  2. Haz clic en Destino.
  3. Haga clic en Crear e introduzca los siguientes datos:
    1. En Título, escriba un título para el destino.
    2. En la casilla Descripción, introduzca una descripción.
    3. Para configurar Webhook, complete los siguientes pasos:
      1. Seleccione Webhook como type.
      2. Seleccione una opción de la lista Method para especificar el método HTTP para el destino. Las opciones disponibles son POST, PUT, y PATCH.
      3. En el campo Webhook URL , introduzca el punto final de destino HTTP (S).
      4. Opcional: Haga clic en Añadir + para incluir cabeceras HTTP adicionales.
    4. Para configurar PagerDuty, siga los siguientes pasos:
      1. Seleccione PagerDuty como tipo.
      2. Introduzca su pagerduty integration routing key en el campo Routing key . Para obtener más información al respecto pagerduty integration, consulte la sección «Servicios e integraciones ».
        Nota: Al integrar con PagerDuty, seleccione Events API v2 como tipo de integración.
    5. Para configurar Slack, siga estos pasos:
      1. Seleccione Slack como tipo.
      2. En el campo Token , introduce el token de la API de Slack.
      3. En el campo Channel ID , introduzca su Channel ID. Para obtener más información al respecto Token and Channel ID, consulta «Cómo obtener y utilizar rápidamente un token de bot de la API de Slack».
        Nota: Utilice el ID del canal, no el nombre del canal. Por ejemplo: C1234567890.
    6. Para configurar Amazon Simple Notification Service, complete los siguientes pasos:
      Nota: Para habilitar Amazon SNS para Engagement, debe crear el secreto de cliente AWS y hacer referencia al secreto en el archivo YAML de recursos personalizados de análisis. Para obtener más información, consulte Activar Amazon SNS.
      1. Seleccione Amazon SNS como tipo.
      2. En el campo Topic ARN, introduzca el ARN del tema de Amazon SNS.
      3. En el campo Role ARN, introduzca el ARN del rol de Amazon SNS.
    7. Para configurar Kafka HTTP Bridge, siga estos pasos:
      1. Seleccione Webhook como type.
      2. Seleccione una opción de la lista Method para especificar el método HTTP para el destino. Las opciones disponibles son POST, PUT, y PATCH.
      3. En el campo Webhook URL , introduzca el punto final de destino HTTP (S).
        http://<route-name>.apps.<cluster-name>.<namespace>.com/topics/<topic-name>
        Para obtener más información sobre Kafka HTTP Bridge la configuración, consulte «Conexión a través de HTTP con Kafka Bridge ».
      4. Haga clic en Añadir + para añadir una cabecera HTTP.
      5. En el Name archivado, introduzca content-type.
      6. En el campo Value , introduzca application/vnd.kafka.json.v2+json.
      7. Defina la carga útil JSON que se enviará al tema Kafka en la acción de activación de su regla.
      Nota: Compruebe su configuración de Kafka y ajuste el formato de la carga útil si es necesario. El siguiente ejemplo muestra un formato de mensaje JSON requerido por algunas implementaciones de Kafka :
      {
           "records": [
              {
                  "key": "my-key",
                  "value": "my-value"
              }
          ]
      }
    8. Para configurar IBM MQ, siga estos pasos:
      1. Seleccione Webhook como type.
      2. Seleccione una opción de la lista Method para especificar el método HTTP para el destino. Las opciones disponibles son POST, PUT, y PATCH.
      3. En el campo Webhook URL , introduzca el punto final de destino HTTP (S).
        https://<host>:<port>/ibmmq/rest/v3/messaging/qmgr/<your_qm_name>/queue/<your_queue_name>/message
        Para obtener más información sobre la API REST de mensajería de IBM MQIBM MQ messaging REST API, consulte...
      4. Haga clic en Añadir + para añadir una cabecera HTTP.
      5. En el Name archivado, introduzca content-type.
      6. En el campo Value , introduzca el valor del tipo de contenido que está utilizando, por ejemplo: text/plain;charset=utf-8.
      7. Haga clic en Añadir + para añadir una segunda cabecera HTTP.
      8. En el Name archivado, introduzca authorization.
      9. En el campo Value , introduzca Basic <base64encodedstring>.

        Donde:

        • base64encodedstring es el username:password codificado en base 64.
      10. Haga clic en Añadir + para añadir un tercer encabezado HTTP.
      11. En el Name archivado, introduzca ibm-mq-rest-csrf-token.
      12. Puede dejar el campo de valor en blanco.
        Nota: Asegúrate de incluir este encabezado, incluso si el campo de valor está en blanco, ya que el gestor de colas de IBM MQ rechaza la carga útil si no lo incluye.
    9. Para configurar IBM Cloud Event Notification Service, siga estos pasos:
      Nota: Los destinos de IBM Cloud Event Notification Service no están vinculados a los destinos de API Connect. Debe configurar el destino en IBM Cloud Event Notification Service antes de configurar Engagement en API Connect.
      1. Seleccione Webhook como type.
      2. Seleccione POST en la lista Method para especificar el método HTTP para el destino.
      3. En el campo Webhook URL , introduzca el punto final de destino HTTP (S).
        {base_url}/v1/instances/{instance_id}/notifications 
        Donde:
        uRL_base
        Introduzca la ruta base URL
        instance_id
        Introduzca el identificador correspondiente a la instancia
        Para obtener más información al respecto IBM Cloud Event Notification Service, consulta la API de notificaciones de eventos.
      4. Haga clic en Añadir + para añadir una cabecera HTTP.
      5. En el Name archivado, introduzca content-type.
      6. En el campo Value , introduzca application/json.
      7. Haga clic en Añadir + para añadir una segunda cabecera HTTP.
      8. En el Name archivado, introduzca Authorization.
      9. En el campo Value , introduzca su token IAM.
      10. Defina la carga útil JSON que desea enviar al servicio de notificación en la acción de activación de su regla. Para obtener más información, consulta la API de notificaciones de eventos.
  4. Pulse Crear.

Creación de una regla

  1. Haga clic en Reglas.
  2. Haga clic en Crear e introduzca los siguientes datos:
    1. En el campo Título, introduzca un Title para la regla.
    2. En la sección Programación, especifique una programación para ejecutar esta regla. Puede especificar una programación definiendo un intervalo de tiempo o una cadena cron.
    3. Haga clic en Siguiente para seleccionar los datos y definir la consulta.
    4. En la sección Seleccionar datos, seleccione una opción de la lista Origen de datos en función de los datos con los que desee ejecutar la regla.
    5. En la sección Consulta, defina la métrica de agregación que desea utilizar para la consulta. El valor predeterminado es un recuento de registros coincidentes. También puede utilizar agregaciones matemáticas para campos numéricos, como el valor máximo o la media de un periodo de tiempo.
    6. En los campos Intervalo de tiempo de los últimos datos, introduzca el intervalo de tiempo en función de la antigüedad con la que desea ejecutar la búsqueda de elementos de datos coincidentes.
    7. Haga clic en Añadir filtro + para seleccionar hasta 7 filtros de datos en función de los datos que desee incluir al ejecutar la consulta. Puede utilizar cualquiera de los campos de registro de eventos analíticos.
    8. Haga clic en Añadir grupo por + para seleccionar un grupo en función de cómo desee agrupar los datos seleccionados y racionalizar los criterios de destino. Por ejemplo, una regla que coincida con 10 eventos de API con un código de estado de 500 en un periodo de 24 horas puede utilizar " Group by en " api_name para solicitar 10 eventos coincidentes para una API individual en lugar de un total de todos los eventos para todas las API.
    9. Haga clic en Siguiente para configurar los activadores.

    Añade activadores + :

    1. Haga clic en Añadir activador +. Puede añadir hasta 5 activadores.
    2. En la sección Detalles del activ ador, introduzca un " Title para el activador y, a continuación, seleccione el nivel de gravedad y la condición de activación en las listas correspondientes.
    3. En la lista desplegable Gravedad, seleccione una opción.
    4. En la sección Condición de activación, establezca una condición según sea necesario.

      Defina el objetivo numérico, lo que permite que una única regla tenga varios desencadenantes con diferentes condiciones de gravedad y desencadenamiento. Cuando se cumplen los criterios especificados, cada activador puede desencadenar hasta 3 acciones, que luego invocan diferentes puntos finales o con diferentes cargas útiles.

    Añadir acciones:

    1. Haga clic en Añadir acción + para configurar la acción que tiene lugar cuando se cumplen los criterios de activación.
    2. En la sección Acción desencadenante, proporcione un title para la acción,
    3. En la lista Destino, seleccione el destino que se invocará cuando se cumplan los criterios.
    4. Habilite el estrangulamiento y defina la ventana de estrangulamiento para evitar que se invoquen varios activadores para la misma regla en el mismo periodo de tiempo.
    5. En la sección Carga útil, proporcione un asunto de mensaje y un valor de carga útil. Puede añadir variables de contexto en el campo Payload (Carga útil) basándose en la información de carga útil de la tarea que desea mostrar en el destino. Para obtener más información, consulta «Variables de contexto en la carga útil de la tarea ».
      Nota: El asunto del mensaje no se envía al endpoint HTTP. El valor de la carga útil actúa como cuerpo HTTP de la tarea de notificación que se envía al endpoint de destino
  3. Pulse Guardar.
  4. Pulse Finalizar.

Qué ha hecho en esta tarea

En su Gestor de API, ha utilizado Engagement para automatizar las tareas de notificación en función de los criterios especificados. La pestaña Estado de las tareas muestra las últimas tareas de notificación para cada activador.