PagerDuty Recorrido virtual por la integración

Descubra cómo integrar Oracle Cloud Infrastructure Notifications con PagerDuty para que pueda disparar incidentes PagerDuty.

Crear un punto final PagerDuty

Para completar este procedimiento, debe tener uno de los siguientes roles en PagerDuty: rol de mánager, administrador, administrador global o responsable de cuenta.

  1. Vaya a PagerDuty.
  2. En el menú Configuración, seleccione Servicios.
  3. En la página Services:
    1. Si está creando un servicio para la integración, haga clic en +Add Nuevo servicio.
    2. Si va a agregar la integración a un servicio existente, haga clic en el nombre del servicio al que desea agregar la integración. A continuación, seleccione el separador Integraciones y haga clic en el botón Integración +New.
  4. Escriba un nombre de integración con el formato monitoring-tool-service-name.

    Si está creando un servicio para la integración, en Configuración de incidente, especifique la política de escalada, la urgencia de notificación y el comportamiento del incidente para el nuevo servicio.

  5. Seleccione el tipo de punto final preferido en el menú Tipo de integración según las siguientes opciones:
    • Oracle Cloud Infrastructure Monitoring: si solo desea que se publiquen mensajes por alarma (mediante el formato del mensaje de alarma). Para este tipo de punto final, PagerDuty responde según el formato de mensaje:

      • Los mensajes que utilizan formatos de mensaje genéricos se ignoran. Por ejemplo, si la regla de evento dispara la publicación de un mensaje en el tema que contiene esta suscripción, o si publica directamente un mensaje en el tema mediante el servicio Notifications, no se crea ningún incidente PagerDuty.
      • Los mensajes que utilizan el formato de mensaje de alarma se procesan. Por ejemplo, si la alarma dispara la publicación de un mensaje en el tema, que tiene el formato de mensaje de alarma, se crea un incidente PagerDuty.
    • Custom Event Transformer: si desea que algún mensaje genere un incidente PagerDuty, ya sea que provenga de reglas de eventos, alarmas, conectores, anuncios de consola o publicaciones directas. Los mensajes enviados a este punto final siguen el formato de mensaje genérico.

      Para obtener más información sobre Transformador de eventos personalizados, consulte la documentación de PagerDuty.

  6. Haga clic en el botón Agregar servicio o Agregar integración para guardar la nueva integración.
    Se le redirigirá a la página Integraciones del servicio.
  7. Copie la clave de integración y la URL de integración de la nueva integración y manténgala en un lugar seguro para su uso posterior.

    Ejemplo de PagerDuty Clave de integración y URL de integración (en el momento de la publicación de este documento):

    PagerDuty Clave de integración y URL de integración.
    Ahora tiene la clave de integración necesaria para crear una suscripción PagerDuty en Notificaciones.

Crear una suscripción a PagerDuty

Para completar este procedimiento, debe tener acceso a Notificaciones y permisos para crear temas y suscripciones. Consulte Políticas de IAM (protección de notificaciones).

  1. Abra el menú de navegación y haga clic en Servicios para desarrolladores. En Integración de aplicación, haga clic en Notificaciones.
  2. En Valor de lista, seleccione un compartimento en el que tenga permiso para trabajar.
    La página se actualiza para mostrar solo los recursos de ese compartimiento. Si no está seguro de qué compartimento utilizar, póngase en contacto con un administrador.
  3. Haga clic en el nombre del tema al que desea agregar la suscripción.
  4. En la página de detalles del tema, haga clic en Crear suscripción.
    Se muestra el panel Crear suscripción.
  5. Para Protocolo, seleccione PagerDuty.

    El campo URL se muestra con un espacio para agregar la clave de integración.

    Sección Clave de integración del punto final PagerDuty.
    • Protocolo: seleccione PagerDuty.

    • URL

      Escriba (o copie y pegue) la parte de la clave de integración de la URL de la suscripción PagerDuty. Esta parte es el punto final PagerDuty. (Las otras partes de la URL se codifican).

  6. Haga clic en Crear.

    Se ha creado la suscripción PagerDuty. Permanece en estado "Pendiente" hasta que se recibe la confirmación.

  7. Confirme la nueva suscripción a PagerDuty:
    1. Vaya a PagerDuty.
    2. Acceda al incidente titulado "Confirmación de suscripción al servicio Oracle Notification".
    3. Haga clic en el enlace URL de confirmación.

    Ejemplo de incidente de confirmación (en el momento de la publicación de este documento):

    Ejemplo de incidente de confirmación en PagerDuty.
    Ahora que tiene una suscripción confirmada que hace referencia al punto final PagerDuty, puede probar la integración publicando directamente un mensaje en su tema principal.

Probar una suscripción a PagerDuty (publicación directa)

Para completar este procedimiento, debe tener acceso a Notificaciones y permisos para publicar mensajes. Consulte Políticas de IAM (protección de notificaciones).

    1. Abra el menú de navegación y haga clic en Servicios para desarrolladores. En Integración de aplicación, haga clic en Notificaciones.
    2. En Valor de lista, seleccione un compartimento en el que tenga permiso para trabajar.
      La página se actualiza para mostrar solo los recursos de ese compartimiento. Si no está seguro de qué compartimento utilizar, póngase en contacto con un administrador.
    3. En la página Temas, para el tema que desee, haga clic en el menú de acciones (Menú Acciones) y, a continuación, haga clic en Editar mensaje.
      Aparece el cuadro de diálogo Publicar Mensaje.
    4. En el cuadro de diálogo Publicar mensaje, introduzca los elementos que necesita el tipo de integración.
      • Para Transformador de eventos de cliente, introduzca un mensaje y un título.

        Mensaje de ejemplo: "Se ha detectado una utilización no óptima. Una aplicación o proceso puede consumir más CPU de lo habitual".

        Título de ejemplo: "Alarma no óptima"

      • Para Oracle Cloud Infrastructure Monitoring, introduzca un mensaje que contenga un blob JSON con pares clave-valor para severity (cadena, necesario) y uno o más de los siguientes valores: title (cadena), body (cadena) y alarmMetaData (blob o matriz JSON).

        Ejemplo de blob de JSON:
        {
          "title": "my test alarm",
          "body": "my test body",
          "severity": "warning",
          "alarmMetaData": {
            "key1": "value1",
            "key2": "value2"
          }
        }

        El valor severity es flexible para pruebas. Para la producción, utilice un valor soportado por PagerDuty, como critical, error, warning o info.

    5. Haga clic en Publicar.

      Se dispara un incidente PagerDuty que contiene el contenido del mensaje.

      Ejemplo de incidente PagerDuty disparado (en el momento de la publicación de este documento):

      Ejemplo de incidente PagerDuty disparado.

      Ejemplo del contenido de un incidente PagerDuty disparado (en el momento de la publicación de este documento):

      Ejemplo de contenido en un incidente PagerDuty disparado.

      Ha confirmado que la publicación directa de un mensaje dispara un incidente PagerDuty. A continuación, utilice la nueva suscripción para disparar incidentes de PagerDuty desde alarmas, eventos y conectores.

      Nota

      Para comprobar la URL de punto final u otros detalles de la suscripción PagerDuty, consulte Obtención de detalles de una suscripción. Para obtener información de resolución de problemas relacionada con los mensajes publicados, consulte Mensaje no recibido.
  • Utilice el comando oci ons message publish y los parámetros necesarios para publicar un mensaje en un tema:

    oci ons message publish --body <message_text> --topic-id <topic_OCID>

    Para obtener una lista completa de parámetros y valores para los comandos de la CLI, consulte la Referencia de la línea de comandos para notificaciones.

  • Ejecute la operación PublishMessage para publicar un mensaje en un tema.

    Ejemplo de solicitud para un punto final PagerDuty del tipo de transformador de eventos personalizado:

    POST /20181201/topics/<topic_OCID>/messages
    Host: <topic API endpoint>
    <authorization and other headers>
    {
      "title": "Non-Optimal Alarm",
      "body": "Non-optimal utilization detected. An application or process may be consuming more CPU than usual."
    }

Disparar un incidente PagerDuty

Dispara un incidente en PagerDuty desde una suscripción de alarma, evento, conector o anuncio mediante una suscripción en Notificaciones.

Al crear una alarma, regla de evento, conector o suscripción a anuncios, seleccione el tema Notificaciones que contiene la suscripción PagerDuty. Para obtener instrucciones sobre cómo crear estos recursos, consulte la documentación siguiente.

Nota

Para comprobar la URL de punto final u otros detalles de la suscripción PagerDuty, consulte Obtención de detalles de una suscripción.